@akamai/openapi-ts
    Preparing search index...

    Type Alias PutDatabasesPostgreSqlInstanceData

    type PutDatabasesPostgreSqlInstanceData = {
        body: {
            allow_list?: string[];
            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;
            };
            label?: string;
            private_network?: | {
                public_access?: boolean;
                subnet_id?: number;
                vpc_id?: number;
            }
            | null;
            type?: string;
            updates?: {
                day_of_week?: number;
                duration?: number;
                frequency?: "weekly";
                hour_of_day?: number;
                pending?: {
                    deadline?: string
                    | null;
                    description?: string;
                    planned_for?: string | null;
                }[];
            };
            version?: string;
        };
        path: { instanceId: number };
        query?: never;
        url: "databases/postgresql/instances/{instanceId}";
    }
    Index

    Properties

    Properties

    body: {
        allow_list?: string[];
        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;
        };
        label?: string;
        private_network?: | {
            public_access?: boolean;
            subnet_id?: number;
            vpc_id?: number;
        }
        | null;
        type?: string;
        updates?: {
            day_of_week?: number;
            duration?: number;
            frequency?: "weekly";
            hour_of_day?: number;
            pending?: {
                deadline?: string
                | null;
                description?: string;
                planned_for?: string | null;
            }[];
        };
        version?: string;
    }

    Updated information for the Managed PostgreSQL Database.

    Type Declaration

    • Optionalallow_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.

    • Optionalengine_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.

      • Optionalpg?: {
            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.

        • Optionalautovacuum_analyze_scale_factor?: number

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

        • Optionalautovacuum_analyze_threshold?: number

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

        • Optionalautovacuum_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.

        • Optionalautovacuum_naptime?: number

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

        • Optionalautovacuum_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.

        • Optionalautovacuum_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.

        • Optionalautovacuum_vacuum_scale_factor?: number

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

        • Optionalautovacuum_vacuum_threshold?: number

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

        • Optionalbgwriter_delay?: number

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

        • Optionalbgwriter_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.

        • Optionalbgwriter_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.

        • Optionalbgwriter_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.

        • Optionaldeadlock_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.

        • Optionaldefault_toast_compression?: "lz4" | "pglz"

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

        • Optionalidle_in_transaction_session_timeout?: number

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

        • Optionaljit?: boolean

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

        • Optionalmax_files_per_process?: number

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

        • Optionalmax_locks_per_transaction?: number

          PostgreSQL maximum locks per transaction.

        • Optionalmax_logical_replication_workers?: number

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

        • Optionalmax_parallel_workers?: number

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

        • Optionalmax_parallel_workers_per_gather?: number

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

        • Optionalmax_pred_locks_per_transaction?: number

          PostgreSQL maximum predicate locks per transaction.

        • Optionalmax_replication_slots?: number

          PostgreSQL maximum replication slots.

        • Optionalmax_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.

        • Optionalmax_stack_depth?: number

          Maximum depth of the stack in bytes.

        • Optionalmax_standby_archive_delay?: number

          Maximum standby archive delay in milliseconds.

        • Optionalmax_standby_streaming_delay?: number

          Maximum standby streaming delay in milliseconds.

        • Optionalmax_wal_senders?: number

          PostgreSQL maximum write ahead log (WAL) senders.

        • Optionalmax_worker_processes?: number

          Maximum number of background processes that the system can support.

        • Optionalpassword_encryption?: "scram-sh-256" | "md5"

          Chooses the algorithm for encrypting passwords.

        • Optionalpg_partman_bgw.interval?: number

          Sets the time interval to run pg_partman scheduled tasks.

        • Optionalpg_partman_bgw.role?: string

          Controls which role to use for pg_partman scheduled background tasks.

        • Optionalpg_stat_monitor.pgsm_enable_query_plan?: boolean

          Enables query plan monitoring.

        • Optionalpg_stat_monitor.pgsm_max_buckets?: number

          Sets the maximum number of buckets.

        • Optionalpg_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.

        • Optionaltemp_file_limit?: number

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

        • Optionaltimezone?: string

          PostgreSQL service time zone.

        • Optionaltrack_activity_query_size?: number

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

        • Optionaltrack_commit_timestamp?: "on" | "off"

          Record the commit time of transactions.

        • Optionaltrack_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.

        • Optionaltrack_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.

        • Optionalwal_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.

        • Optionalwal_writer_delay?: number

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

      • Optionalpg_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.

      • Optionalpglookout?: { max_failover_replication_time_lag?: number }

        Parameter used to apply PGLookout settings.

        • Optionalmax_failover_replication_time_lag?: number

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

      • Optionalshared_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.

      • Optionalwork_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.

    • Optionallabel?: string

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

    • Optionalprivate_network?: { public_access?: boolean; subnet_id?: number; vpc_id?: number } | null

      Beta Restricts access on a PostgreSQL Managed Database to a specific Virtual Private Cloud (VPC) configured for the cluster.

    • Optionaltype?: string

      Request re-sizing of your cluster to a Linode Type with more disk space. For example, you could request a Linode Type that uses a higher plan.

      • Needs to be a Linode Type with more disk space than your current Linode.

      • Resizing to a larger Linode Type can accrue additional cost. Review the price output from the List types operation for more information.

      • You can't update the allow_list and set a new type in the same request.

      • Any active updates to your cluster need to complete before you can request a resize. The reverse is also true: An active resizing needs to complete before you can perform any other update.

    • Optionalupdates?: {
          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.

      • Optionalday_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.

      • Optionalduration?: number

        The maximum maintenance window time in hours.

      • Optionalfrequency?: "weekly"

        How frequently maintenance occurs. Currently can only be weekly.

      • Optionalhour_of_day?: number

        The hour to begin maintenance based in UTC time.

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

        Read-only An array of pending updates.

    • Optionalversion?: string

      Filterable The Managed Database engine version.

    path: { instanceId: number }

    Type Declaration

    • instanceId: number

      The ID of the Managed PostgreSQL Database.

    query?: never
    url: "databases/postgresql/instances/{instanceId}"