Type Alias PostDatabasesPostgreSqlInstancesResponses

Type Declaration

• allow_list: string[]

  Controls access to the Managed Database.

  • Individually included IP addresses or CIDR ranges can access the Managed Database while all other sources are blocked.

  • A standalone value of 0.0.0.0/0 allows all IP addresses access to the Managed Database.

  • An empty array ([]) blocks all public and private connections to the Managed Database.

• cluster_size: 1 | 2 | 3

  The number of Linode instance nodes deployed to the Managed Database.

  • Choose 3 nodes to create a high availability cluster that consists of one primary node and two replica nodes.

  • A 2 node cluster is only available with a dedicated plan. It consists of one primary node and one replica node.

• Readonlycreated: string

  Read-only When this Managed Database was created.

• Readonlyencrypted: boolean

  Read-only Whether the Managed Databases is encrypted. Currently required to be true.

• Readonlyengine: string

  Filterable, Read-only The Managed Database engine type.

• engine_config: {
      pg: {
          autovacuum_analyze_scale_factor: number;
          autovacuum_analyze_threshold: number;
          autovacuum_max_workers: number;
          autovacuum_naptime: number;
          autovacuum_vacuum_cost_delay: number;
          autovacuum_vacuum_cost_limit: number;
          autovacuum_vacuum_scale_factor: number;
          autovacuum_vacuum_threshold: number;
          bgwriter_delay: number;
          bgwriter_flush_after: number;
          bgwriter_lru_maxpages: number;
          bgwriter_lru_multiplier: number;
          deadlock_timeout: number;
          default_toast_compression: "lz4" | "pglz";
          idle_in_transaction_session_timeout: number;
          jit: boolean;
          max_files_per_process: number;
          max_locks_per_transaction: number;
          max_logical_replication_workers: number;
          max_parallel_workers: number;
          max_parallel_workers_per_gather: number;
          max_pred_locks_per_transaction: number;
          max_replication_slots: number;
          max_slot_wal_keep_size: number;
          max_stack_depth: number;
          max_standby_archive_delay: number;
          max_standby_streaming_delay: number;
          max_wal_senders: number;
          max_worker_processes: number;
          password_encryption: "scram-sh-256" | "md5";
          "pg_partman_bgw.interval": number;
          "pg_partman_bgw.role": string;
          "pg_stat_monitor.pgsm_enable_query_plan": boolean;
          "pg_stat_monitor.pgsm_max_buckets": number;
          "pg_stat_statements.track": "all" | "top" | "none";
          temp_file_limit: number;
          timezone: string;
          track_activity_query_size: number;
          track_commit_timestamp: "on" | "off";
          track_functions: "all" | "pl" | "none";
          track_io_timing: "on" | "off";
          wal_sender_timeout: number;
          wal_writer_delay: number;
      };
      pg_stat_monitor_enable: boolean;
      pglookout: { max_failover_replication_time_lag: number };
      shared_buffers_percentage: number;
      work_mem: number;
  }

  Advanced parameters you can apply to a PostgreSQL Managed Database, via our partner Aiven's specification. Only include the objects for parameters you want to set in your database. Omit objects for parameters you don't want to define or change.

  📘

  Aiven may offer additional parameters in their specification. Currently, only those listed here are supported for use in a PostgreSQL Managed Database. You can also run the List PostgreSQL Managed Database advanced parameters operation to see an up-to-date list.

  • pg: {
        autovacuum_analyze_scale_factor: number;
        autovacuum_analyze_threshold: number;
        autovacuum_max_workers: number;
        autovacuum_naptime: number;
        autovacuum_vacuum_cost_delay: number;
        autovacuum_vacuum_cost_limit: number;
        autovacuum_vacuum_scale_factor: number;
        autovacuum_vacuum_threshold: number;
        bgwriter_delay: number;
        bgwriter_flush_after: number;
        bgwriter_lru_maxpages: number;
        bgwriter_lru_multiplier: number;
        deadlock_timeout: number;
        default_toast_compression: "lz4" | "pglz";
        idle_in_transaction_session_timeout: number;
        jit: boolean;
        max_files_per_process: number;
        max_locks_per_transaction: number;
        max_logical_replication_workers: number;
        max_parallel_workers: number;
        max_parallel_workers_per_gather: number;
        max_pred_locks_per_transaction: number;
        max_replication_slots: number;
        max_slot_wal_keep_size: number;
        max_stack_depth: number;
        max_standby_archive_delay: number;
        max_standby_streaming_delay: number;
        max_wal_senders: number;
        max_worker_processes: number;
        password_encryption: "scram-sh-256" | "md5";
        "pg_partman_bgw.interval": number;
        "pg_partman_bgw.role": string;
        "pg_stat_monitor.pgsm_enable_query_plan": boolean;
        "pg_stat_monitor.pgsm_max_buckets": number;
        "pg_stat_statements.track": "all" | "top" | "none";
        temp_file_limit: number;
        timezone: string;
        track_activity_query_size: number;
        track_commit_timestamp: "on" | "off";
        track_functions: "all" | "pl" | "none";
        track_io_timing: "on" | "off";
        wal_sender_timeout: number;
        wal_writer_delay: number;
    }

    PostgreSQL-specific advanced configuration parameters.

    • autovacuum_analyze_scale_factor: number

      Specifies a fraction of the table size to add to autovacuum_analyze_threshold when deciding whether to trigger an ANALYZE.

    • autovacuum_analyze_threshold: number

      Specifies the minimum number of inserted, updated, or deleted tuples needed to trigger an ANALYZE in any one table.

    • autovacuum_max_workers: number

      Specifies the maximum number of autovacuum processes, other than the autovacuum launcher, that may be running at any one time. This parameter can only be set at server start.

    • autovacuum_naptime: number

      Specifies the minimum delay between autovacuum runs on any given database. The delay is measured in seconds.

    • autovacuum_vacuum_cost_delay: number

      Specifies the cost delay value that will be used in automatic VACUUM operations. If -1 is specified, the regular vacuum_cost_delay value will be used.

    • autovacuum_vacuum_cost_limit: number

      Specifies the cost limit value that will be used in automatic VACUUM operations. The default of -1 applies the regular vacuum_cost_limit value.

    • autovacuum_vacuum_scale_factor: number

      Specifies a fraction of the table size to add to autovacuum_vacuum_threshold when deciding whether to trigger a VACUUM.

    • autovacuum_vacuum_threshold: number

      Specifies the minimum number of updated or deleted tuples needed to trigger a VACUUM in any one table.

    • bgwriter_delay: number

      Specifies the delay between activity rounds for the background writer in milliseconds.

    • bgwriter_flush_after: number

      Whenever more than bgwriter_flush_after bytes have been written by the background writer, attempt to force the OS to issue these writes to the underlying storage. Specified in kilobytes. A setting of 0 disables forced writeback.

    • bgwriter_lru_maxpages: number

      In each round, no more than this many buffers will be written by the background writer. Setting this to 0 disables background writing.

    • bgwriter_lru_multiplier: number

      The average recent need for new buffers is multiplied by bgwriter_lru_multiplier to arrive at an estimate of the number that will be needed during the next round, (up to bgwriter_lru_maxpages). 1.0 represents a “just in time” policy of writing exactly the number of buffers predicted to be needed. Larger values provide some cushion against spikes in demand, while smaller values intentionally leave writes to be done by server processes.

    • deadlock_timeout: number

      This is the amount of time, in milliseconds, to wait on a lock before checking to see if there is a deadlock condition.

    • default_toast_compression: "lz4" | "pglz"

      Specifies the default TOAST compression method for values of compressible columns.

    • idle_in_transaction_session_timeout: number

      Time out sessions with open transactions after this number of milliseconds.

    • jit: boolean

      Controls system-wide use of Just-in-Time Compilation (JIT).

    • max_files_per_process: number

      PostgreSQL maximum number of files that can be open per process.

    • max_locks_per_transaction: number

      PostgreSQL maximum locks per transaction.

    • max_logical_replication_workers: number

      PostgreSQL maximum logical replication workers, taken from the pool of max_parallel_workers.

    • max_parallel_workers: number

      Sets the maximum number of workers that the system can support for parallel queries.

    • max_parallel_workers_per_gather: number

      Sets the maximum number of workers that can be started by a single Gather or Gather Merge node.

    • max_pred_locks_per_transaction: number

      PostgreSQL maximum predicate locks per transaction.

    • max_replication_slots: number

      PostgreSQL maximum replication slots.

    • max_slot_wal_keep_size: number

      PostgreSQL maximum write ahead log (WAL) size in MB, reserved for replication slots. A value of -1 which indicates unlimited. The wal_keep_size minimum write ahead log (WAL) size setting takes precedence over this.

    • max_stack_depth: number

      Maximum depth of the stack in bytes.

    • max_standby_archive_delay: number

      Maximum standby archive delay in milliseconds.

    • max_standby_streaming_delay: number

      Maximum standby streaming delay in milliseconds.

    • max_wal_senders: number

      PostgreSQL maximum write ahead log (WAL) senders.

    • max_worker_processes: number

      Maximum number of background processes that the system can support.

    • password_encryption: "scram-sh-256" | "md5"

      Chooses the algorithm for encrypting passwords.

    • pg_partman_bgw.interval: number

      Sets the time interval to run pg_partman scheduled tasks.

    • pg_partman_bgw.role: string

      Controls which role to use for pg_partman scheduled background tasks.

    • pg_stat_monitor.pgsm_enable_query_plan: boolean

      Enables query plan monitoring.

    • pg_stat_monitor.pgsm_max_buckets: number

      Sets the maximum number of buckets.

    • pg_stat_statements.track: "all" | "top" | "none"

      Controls which statements are counted. Specify top to track top-level statements that are issued directly by clients, all to also track nested statements, such as those invoked within functions, or none to disable statement statistics collection.

    • temp_file_limit: number

      PostgreSQL temporary file limit in KB. Set to -1 for unlimited.

    • timezone: string

      PostgreSQL service time zone.

    • track_activity_query_size: number

      Specifies the number of bytes reserved to track the currently executing command for each active session.

    • track_commit_timestamp: "on" | "off"

      Record the commit time of transactions.

    • track_functions: "all" | "pl" | "none"

      Enables tracking of function call counts and time used. Specify pl to track only procedural-language functions, all to also track SQL and C language functions, or none to disable function statistics tracking.

    • track_io_timing: "on" | "off"

      Enables timing of database I/O calls. This parameter is off by default, because it will repeatedly query the operating system for the current time, which may cause significant overhead on some platforms.

    • wal_sender_timeout: number

      Terminate replication connections that are inactive for longer than this amount of time, in milliseconds. Setting this value to 0 disables the timeout.

    • wal_writer_delay: number

      Write ahead log (WAL) flush interval in milliseconds. A value lower than 200 milliseconds may negatively impact performance.

  • pg_stat_monitor_enable: boolean

    Enable the pg_stat_monitor extension. When this extension is enabled, PostgreSQL restarts the cluster it's in. Additionally, pg_stat_statements results for utility commands are unreliable.

  • pglookout: { max_failover_replication_time_lag: number }

    Parameter used to apply PGLookout settings.

    • max_failover_replication_time_lag: number

      Number of seconds of master unavailability before triggering database failover to standby.

  • shared_buffers_percentage: number

    Percentage of total RAM that the database server uses for shared memory buffers. Valid range is 20-60 (float), which corresponds to 20% - 60%. This setting adjusts the shared_buffers configuration value.

  • work_mem: number

    Sets the maximum amount of memory in MB to be used by a query operation, such as a sort or hash table, before writing to temporary disk files. Default is 1MB + 0.075% of total RAM, up to 32 MB.

• fork: { restore_time: string; source: number }

  Details on the database that was the target of the fork. This only exists if the database was restored by creating a fork from another MySQL or PostgreSQL database.

  • restore_time: string

    The database timestamp from which it was restored. This is not when the fork was created.

  • source: number

    The instance id of the database that was forked from.

• Readonlyhosts: { primary: string | null; secondary: string | null }

  Read-only The primary and secondary hosts for the Managed Database. These are assigned after provisioning is complete.

  • primary: string | null

    The primary host for the Managed Database.

  • secondary: string | null

    The secondary/private network host for the Managed Database. A private network host and a private IP can only be used to access a database cluster from Linodes in the same data center and will not incur transfer costs.

    📘

    The secondary hostname is publicly viewable and accessible.

• Readonlyid: number

  Read-only A unique ID that can be used to identify and reference the Managed Database.

• label: string

  Filterable A unique, user-defined string referring to the Managed Database. This string needs to be unique per Managed Database engine type.

• Readonlymembers: { [key: string]: unknown }

  Read-only A mapping between IP addresses and strings designating them as primary or failover.

• platform: "rdbms-legacy" | "rdbms-default"

  Filterable, Read-only The back-end platform for relational databases used by the service.

• Readonlyport: number

  Read-only The access port for this Managed Database.

• region: string

  Filterable The unique identifier for the region where the Managed Database lives.

• ssl_connection: boolean

  Currently required to be true. Whether to require SSL credentials to establish a connection to the Managed Database.

  Run the Get managed PostgreSQL database credentials operation for access information.

• status:
      | "provisioning"
      | "active"
      | "suspending"
      | "suspended"
      | "resuming"
      | "failed"
      | "degraded"
      | "updating"
      | "resizing"

  Filterable, Read-only The operating status of the Managed Database.

• Readonlytotal_disk_size_gb: number

  Read-only The total disk size of the database, in GB.

• type: string

  Filterable The Linode Instance type used by the Managed Database for its nodes.

• Readonlyupdated: string

  Read-only When this Managed Database was last updated.

• updates: {
      day_of_week: number;
      duration: number;
      frequency: "weekly";
      hour_of_day: number;
      pending: {
          deadline: string | null;
          description: string;
          planned_for: string | null;
      }[];
  }

  Configuration settings for automated patch update maintenance for the Managed Database.

  • day_of_week: number

    The numeric reference for the day of the week to perform maintenance. 1 is Monday, 2 is Tuesday, through to 7 which is Sunday.

  • duration: number

    The maximum maintenance window time in hours.

  • frequency: "weekly"

    How frequently maintenance occurs. Currently can only be weekly.

  • hour_of_day: number

    The hour to begin maintenance based in UTC time.

  • Readonlypending: { deadline: string | null; description: string; planned_for: string | null }[]

    Read-only An array of pending updates.

• Readonlyused_disk_size_gb: number

  Read-only The amount of space currently in use in the database, in GB.

• version: string

  Filterable The Managed Database engine version.