@pulumi/linode
Version:
A Pulumi package for creating and managing linode cloud resources.
1,163 lines • 65.8 kB
JavaScript
"use strict";
// *** WARNING: this file was generated by pulumi-language-nodejs. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.getDatabasePostgresqlConfigOutput = exports.getDatabasePostgresqlConfig = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("./utilities");
/**
* Provides information about a Linode PostgreSQL Database's Configuration Options.
* For more information, see the Linode APIv4 docs.
*
* ## Example Usage
*
* Get information about a PostgreSQL database's configuration options:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as linode from "@pulumi/linode";
*
* const my_db_config = linode.getDatabasePostgresqlConfig({});
* ```
*
* ## pgStatMonitorEnable
*
* The following arguments are supported in the `pgStatMonitorEnable` specification block:
*
* * `description` - The description of `pgStatMonitorEnable`.
*
* * `requiresRestart` - Whether changing the value `pgStatMonitorEnable` requires the DB to restart.
*
* * `type` - The type of the value of `pgStatMonitorEnable`.
*
* ## pglookout
*
* The following arguments are supported in the `pglookout` specification block:
*
* * `maxFailoverReplicationTimeLag` - The maximum failover replication time lag for `pglookout`.
*
* ## maxFailoverReplicationTimeLag
*
* The following arguments are supported in the `maxFailoverReplicationTimeLag` specification block:
*
* * `description` - The description of `maxFailoverReplicationTimeLag`.
*
* * `maximum` - The maximum valid value for `maxFailoverReplicationTimeLag`.
*
* * `minimum` - The minimum valid value for `maxFailoverReplicationTimeLag`.
*
* * `requiresRestart` - Whether changing the value of `maxFailoverReplicationTimeLag` requires the DB to restart.
*
* * `type` - The type of the value of `maxFailoverReplicationTimeLag`.
*
* ## sharedBuffersPercentage
*
* The following arguments are supported in the `sharedBuffersPercentage` specification block:
*
* * `description` - The description of `sharedBuffersPercentage`.
*
* * `example` - An example of a valid value for `sharedBuffersPercentage`.
*
* * `maximum` - The maximum valid value for `sharedBuffersPercentage`.
*
* * `minimum` - The minimum valid value for `sharedBuffersPercentage`.
*
* * `requiresRestart` - Whether changing the value of `sharedBuffersPercentage` requires the DB to restart.
*
* * `type` - The type of the value of `sharedBuffersPercentage`.
*
* ## workMem
*
* The following arguments are supported in the `workMem` specification block:
*
* * `description` - The description of `workMem`.
*
* * `example` - An example of a valid value for `workMem`.
*
* * `maximum` - The maximum valid value for `workMem`.
*
* * `minimum` - The minimum valid value for `workMem`.
*
* * `requiresRestart` - Whether changing the value of `workMem` requires the DB to restart.
*
* * `type` - The type of the value of `workMem`.
*
* ## pg
*
* The following arguments are supported in the `pg` specification block:
*
* * `autovacuumAnalyzeScaleFactor` - (Optional) Specifies a fraction of the table size to add to autovacuumAnalyzeThreshold when deciding whether to trigger an ANALYZE. The default is 0.2 (20% of table size)
*
* * `autovacuumAnalyzeThreshold` - (Optional) Specifies the minimum number of inserted, updated or deleted tuples needed to trigger an ANALYZE in any one table. The default is 50 tuples.
*
* * `autovacuumMaxWorkers` - (Optional) Specifies the maximum number of autovacuum processes (other than the autovacuum launcher) that may be running at any one time. The default is three. This parameter can only be set at server start.
*
* * `autovacuumNaptime` - (Optional) Specifies the minimum delay between autovacuum runs on any given database. The delay is measured in seconds, and the default is one minute
*
* * `autovacuumVacuumCostDelay` - (Optional) Specifies the cost delay value that will be used in automatic VACUUM operations. If -1 is specified, the regular vacuumCostDelay value will be used. The default value is 20 milliseconds
*
* * `autovacuumVacuumCostLimit` - (Optional) Specifies the cost limit value that will be used in automatic VACUUM operations. If -1 is specified (which is the default), the regular vacuumCostLimit value will be used.
*
* * `autovacuumVacuumScaleFactor` - (Optional) Specifies a fraction of the table size to add to autovacuumVacuumThreshold when deciding whether to trigger a VACUUM. The default is 0.2 (20% of table size)
*
* * `autovacuumVacuumThreshold` - (Optional) Specifies the minimum number of updated or deleted tuples needed to trigger a VACUUM in any one table. The default is 50 tuples.
*
* * `bgwriterDelay` - (Optional) Specifies the delay between activity rounds for the background writer in milliseconds. Default is 200.
*
* * `bgwriterFlushAfter` - (Optional) Whenever more than bgwriterFlushAfter bytes have been written by the background writer, attempt to force the OS to issue these writes to the underlying storage. Specified in kilobytes, default is 512. Setting of 0 disables forced writeback.
*
* * `bgwriterLruMaxpages` - (Optional) In each round, no more than this many buffers will be written by the background writer. Setting this to zero disables background writing. Default is 100.
*
* * `bgwriterLruMultiplier` - (Optional) The average recent need for new buffers is multiplied by bgwriterLruMultiplier 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. The default is 2.0.
*
* * `deadlockTimeout` - (Optional) This is the amount of time, in milliseconds, to wait on a lock before checking to see if there is a deadlock condition.
*
* * `defaultToastCompression` - (Optional) Specifies the default TOAST compression method for values of compressible columns (the default is lz4).
*
* * `idleInTransactionSessionTimeout` - (Optional) Time out sessions with open transactions after this number of milliseconds.
*
* * `jit` - (Optional) Controls system-wide use of Just-in-Time Compilation (JIT).
*
* * `maxFilesPerProcess` - (Optional) PostgreSQL maximum number of files that can be open per process.
*
* * `maxLocksPerTransaction` - (Optional) PostgreSQL maximum locks per transaction.
*
* * `maxLogicalReplicationWorkers` - (Optional) PostgreSQL maximum logical replication workers (taken from the pool of max_parallel_workers).
*
* * `maxParallelWorkers` - (Optional) Sets the maximum number of workers that the system can support for parallel queries.
*
* * `maxParallelWorkersPerGather` - (Optional) Sets the maximum number of workers that can be started by a single Gather or Gather Merge node.
*
* * `maxPredLocksPerTransaction` - (Optional) PostgreSQL maximum predicate locks per transaction.
*
* * `maxReplicationSlots` - (Optional) PostgreSQL maximum replication slots.
*
* * `maxSlotWalKeepSize` - (Optional) PostgreSQL maximum WAL size (MB) reserved for replication slots. Default is -1 (unlimited). walKeepSize minimum WAL size setting takes precedence over this.
*
* * `maxStackDepth` - (Optional) Maximum depth of the stack in bytes.
*
* * `maxStandbyArchiveDelay` - (Optional) Max standby archive delay in milliseconds.
*
* * `maxStandbyStreamingDelay` - (Optional) Max standby streaming delay in milliseconds.
*
* * `maxWalSenders` - (Optional) PostgreSQL maximum WAL senders.
*
* * `maxWorkerProcesses` - (Optional) Sets the maximum number of background processes that the system can support.
*
* * `passwordEncryption` - (Optional) Chooses the algorithm for encrypting passwords.
*
* * `pg_partman_bgw.interval` - (Optional) Sets the time interval to run pg_partman's scheduled tasks.
*
* * `pg_partman_bgw.role` - (Optional) Controls which role to use for pg_partman's scheduled background tasks.
*
* * `pg_stat_monitor.pgsm_enable_query_plan` - (Optional) Enables or disables query plan monitoring.
*
* * `pg_stat_monitor.pgsm_max_buckets` - (Optional) Sets the maximum number of buckets.
*
* * `pg_stat_statements.track` - (Optional) Controls which statements are counted. Specify top to track top-level statements (those issued directly by clients), all to also track nested statements (such as statements invoked within functions), or none to disable statement statistics collection. The default value is top.
*
* * `tempFileLimit` - (Optional) PostgreSQL temporary file limit in KiB, -1 for unlimited.
*
* * `timezone` - (Optional) PostgreSQL service timezone.
*
* * `trackActivityQuerySize` - (Optional) Specifies the number of bytes reserved to track the currently executing command for each active session.
*
* * `trackCommitTimestamp` - (Optional) Record commit time of transactions.
*
* * `trackFunctions` - (Optional) Enables tracking of function call counts and time used.
*
* * `trackIoTiming` - (Optional) 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.
*
* * `walSenderTimeout` - (Optional) Terminate replication connections that are inactive for longer than this amount of time, in milliseconds. Setting this value to zero disables the timeout.
*
* * `walWriterDelay` - (Optional) WAL flush interval in milliseconds. Note that setting this value to lower than the default 200ms may negatively impact performance.
*
* ## autovacuumAnalyzeScaleFactor
*
* The following arguments are supported in the `autovacuumAnalyzeScaleFactor` specification block:
*
* * `description` - The description of `autovacuumAnalyzeScaleFactor`.
*
* * `maximum` - The maximum valid value for `autovacuumAnalyzeScaleFactor`.
*
* * `minimum` - The minimum valid value for `autovacuumAnalyzeScaleFactor`.
*
* * `requiresRestart` - Whether changing the value of `autovacuumAnalyzeScaleFactor` requires the DB to restart.
*
* * `type` - The type of the value of `autovacuumAnalyzeScaleFactor`.
*
* ## autovacuumAnalyzeThreshold
*
* The following arguments are supported in the `autovacuumAnalyzeThreshold` specification block:
*
* * `description` - The description of `autovacuumAnalyzeThreshold`.
*
* * `maximum` - The maximum valid value for `autovacuumAnalyzeThreshold`.
*
* * `minimum` - The minimum valid value for `autovacuumAnalyzeThreshold`.
*
* * `requiresRestart` - Whether changing the value of `autovacuumAnalyzeThreshold` requires the DB to restart.
*
* * `type` - The type of the value of `autovacuumAnalyzeThreshold`.
*
* ## autovacuumMaxWorkers
*
* The following arguments are supported in the `autovacuumMaxWorkers` specification block:
*
* * `description` - The description of `autovacuumMaxWorkers`.
*
* * `maximum` - The maximum valid value for `autovacuumMaxWorkers`.
*
* * `minimum` - The minimum valid value for `autovacuumMaxWorkers`.
*
* * `requiresRestart` - Whether changing the value of `autovacuumMaxWorkers` requires the DB to restart.
*
* * `type` - The type of the value of `autovacuumMaxWorkers`.
*
* ## autovacuumNaptime
*
* The following arguments are supported in the `autovacuumNaptime` specification block:
*
* * `description` - The description of `autovacuumNaptime`.
*
* * `maximum` - The maximum valid value for `autovacuumNaptime`.
*
* * `minimum` - The minimum valid value for `autovacuumNaptime`.
*
* * `requiresRestart` - Whether changing the value of `autovacuumNaptime` requires the DB to restart.
*
* * `type` - The type of the value of `autovacuumNaptime`.
*
* ## autovacuumVacuumCostDelay
*
* The following arguments are supported in the `autovacuumVacuumCostDelay` specification block:
*
* * `description` - The description of `autovacuumVacuumCostDelay`.
*
* * `maximum` - The maximum valid value for `autovacuumVacuumCostDelay`.
*
* * `minimum` - The minimum valid value for `autovacuumVacuumCostDelay`.
*
* * `requiresRestart` - Whether changing the value of `autovacuumVacuumCostDelay` requires the DB to restart.
*
* * `type` - The type of the value of `autovacuumVacuumCostDelay`.
*
* ## autovacuumVacuumCostLimit
*
* The following arguments are supported in the `autovacuumVacuumCostLimit` specification block:
*
* * `description` - The description of `autovacuumVacuumCostLimit`.
*
* * `maximum` - The maximum valid value for `autovacuumVacuumCostLimit`.
*
* * `minimum` - The minimum valid value for `autovacuumVacuumCostLimit`.
*
* * `requiresRestart` - Whether changing the value of `autovacuumVacuumCostLimit` requires the DB to restart.
*
* * `type` - The type of the value of `autovacuumVacuumCostLimit`.
*
* ## autovacuumVacuumScaleFactor
*
* The following arguments are supported in the `autovacuumVacuumScaleFactor` specification block:
*
* * `description` - The description of `autovacuumVacuumScaleFactor`.
*
* * `maximum` - The maximum valid value for `autovacuumVacuumScaleFactor`.
*
* * `minimum` - The minimum valid value for `autovacuumVacuumScaleFactor`.
*
* * `requiresRestart` - Whether changing the value of `autovacuumVacuumScaleFactor` requires the DB to restart.
*
* * `type` - The type of the value of `autovacuumVacuumScaleFactor`.
*
* ## autovacuumVacuumThreshold
*
* The following arguments are supported in the `autovacuumVacuumThreshold` specification block:
*
* * `description` - The description of `autovacuumVacuumThreshold`.
*
* * `maximum` - The maximum valid value for `autovacuumVacuumThreshold`.
*
* * `minimum` - The minimum valid value for `autovacuumVacuumThreshold`.
*
* * `requiresRestart` - Whether changing the value of `autovacuumVacuumThreshold` requires the DB to restart.
*
* * `type` - The type of the value of `autovacuumVacuumThreshold`.
*
* ## bgwriterDelay
*
* The following arguments are supported in the `bgwriterDelay` specification block:
*
* * `description` - The description of `bgwriterDelay`.
*
* * `example` - An example of a valid value for `bgwriterDelay`.
*
* * `maximum` - The maximum valid value for `bgwriterDelay`.
*
* * `minimum` - The minimum valid value for `bgwriterDelay`.
*
* * `requiresRestart` - Whether changing the value of `bgwriterDelay` requires the DB to restart.
*
* * `type` - The type of the value of `bgwriterDelay`.
*
* ## bgwriterFlushAfter
*
* The following arguments are supported in the `bgwriterFlushAfter` specification block:
*
* * `description` - The description of `bgwriterFlushAfter`.
*
* * `example` - An example of a valid value for `bgwriterFlushAfter`.
*
* * `maximum` - The maximum valid value for `bgwriterFlushAfter`.
*
* * `minimum` - The minimum valid value for `bgwriterFlushAfter`.
*
* * `requiresRestart` - Whether changing the value of `bgwriterFlushAfter` requires the DB to restart.
*
* * `type` - The type of the value of `bgwriterFlushAfter`.
*
* ## bgwriterLruMaxpages
*
* The following arguments are supported in the `bgwriterLruMaxpages` specification block:
*
* * `description` - The description of `bgwriterLruMaxpages`.
*
* * `example` - An example of a valid value for `bgwriterLruMaxpages`.
*
* * `maximum` - The maximum valid value for `bgwriterLruMaxpages`.
*
* * `minimum` - The minimum valid value for `bgwriterLruMaxpages`.
*
* * `requiresRestart` - Whether changing the value of `bgwriterLruMaxpages` requires the DB to restart.
*
* * `type` - The type of the value of `bgwriterLruMaxpages`.
*
* ## bgwriterLruMultiplier
*
* The following arguments are supported in the `bgwriterLruMultiplier` specification block:
*
* * `description` - The description of `bgwriterLruMultiplier`.
*
* * `example` - An example of a valid value for `bgwriterLruMultiplier`.
*
* * `maximum` - The maximum valid value for `bgwriterLruMultiplier`.
*
* * `minimum` - The minimum valid value for `bgwriterLruMultiplier`.
*
* * `requiresRestart` - Whether changing the value of `bgwriterLruMultiplier` requires the DB to restart.
*
* * `type` - The type of the value of `bgwriterLruMultiplier`.
*
* ## deadlockTimeout
*
* The following arguments are supported in the `deadlockTimeout` specification block:
*
* * `description` - The description of `deadlockTimeout`.
*
* * `example` - An example of a valid value for `deadlockTimeout`.
*
* * `maximum` - The maximum valid value for `deadlockTimeout`.
*
* * `minimum` - The minimum valid value for `deadlockTimeout`.
*
* * `requiresRestart` - Whether changing the value of `deadlockTimeout` requires the DB to restart.
*
* * `type` - The type of the value of `deadlockTimeout`.
*
* ## defaultToastCompression
*
* The following arguments are supported in the `defaultToastCompression` specification block:
*
* * `description` - The description of `defaultToastCompression`.
*
* * `enum` - A list of valid compression methods for `defaultToastCompression`.
*
* * `example` - An example of a valid value for `defaultToastCompression`.
*
* * `requiresRestart` - Whether changing the value of `defaultToastCompression` requires the DB to restart.
*
* * `type` - The type of the value of `defaultToastCompression`.
*
* ## idleInTransactionSessionTimeout
*
* The following arguments are supported in the `idleInTransactionSessionTimeout` specification block:
*
* * `description` - The description of `idleInTransactionSessionTimeout`.
*
* * `maximum` - The maximum valid value for `idleInTransactionSessionTimeout`.
*
* * `minimum` - The minimum valid value for `idleInTransactionSessionTimeout`.
*
* * `requiresRestart` - Whether changing the value of `idleInTransactionSessionTimeout` requires the DB to restart.
*
* * `type` - The type of the value of `idleInTransactionSessionTimeout`.
*
* ## jit
*
* The following arguments are supported in the `jit` specification block:
*
* * `description` - The description of `jit`.
*
* * `example` - An example of a valid value for `jit`.
*
* * `requiresRestart` - Whether changing the value of `jit` requires the DB to restart.
*
* * `type` - The type of the value of `jit`.
*
* ## maxFilesPerProcess
*
* The following arguments are supported in the `maxFilesPerProcess` specification block:
*
* * `description` - The description of `maxFilesPerProcess`.
*
* * `maximum` - The maximum valid value for `maxFilesPerProcess`.
*
* * `minimum` - The minimum valid value for `maxFilesPerProcess`.
*
* * `requiresRestart` - Whether changing the value of `maxFilesPerProcess` requires the DB to restart.
*
* * `type` - The type of the value of `maxFilesPerProcess`.
*
* ## maxLocksPerTransaction
*
* The following arguments are supported in the `maxLocksPerTransaction` specification block:
*
* * `description` - The description of `maxLocksPerTransaction`.
*
* * `maximum` - The maximum valid value for `maxLocksPerTransaction`.
*
* * `minimum` - The minimum valid value for `maxLocksPerTransaction`.
*
* * `requiresRestart` - Whether changing the value of `maxLocksPerTransaction` requires the DB to restart.
*
* * `type` - The type of the value of `maxLocksPerTransaction`.
*
* ## maxLogicalReplicationWorkers
*
* The following arguments are supported in the `maxLogicalReplicationWorkers` specification block:
*
* * `description` - The description of `maxLogicalReplicationWorkers`.
*
* * `maximum` - The maximum valid value for `maxLogicalReplicationWorkers`.
*
* * `minimum` - The minimum valid value for `maxLogicalReplicationWorkers`.
*
* * `requiresRestart` - Whether changing the value of `maxLogicalReplicationWorkers` requires the DB to restart.
*
* * `type` - The type of the value of `maxLogicalReplicationWorkers`.
*
* ## maxParallelWorkers
*
* The following arguments are supported in the `maxParallelWorkers` specification block:
*
* * `description` - The description of `maxParallelWorkers`.
*
* * `maximum` - The maximum valid value for `maxParallelWorkers`.
*
* * `minimum` - The minimum valid value for `maxParallelWorkers`.
*
* * `requiresRestart` - Whether changing the value of `maxParallelWorkers` requires the DB to restart.
*
* * `type` - The type of the value of `maxParallelWorkers`.
*
* ## maxParallelWorkersPerGather
*
* The following arguments are supported in the `maxParallelWorkersPerGather` specification block:
*
* * `description` - The description of `maxParallelWorkersPerGather`.
*
* * `maximum` - The maximum valid value for `maxParallelWorkersPerGather`.
*
* * `minimum` - The minimum valid value for `maxParallelWorkersPerGather`.
*
* * `requiresRestart` - Whether changing the value of `maxParallelWorkersPerGather` requires the DB to restart.
*
* * `type` - The type of the value of `maxParallelWorkersPerGather`.
*
* ## maxPredLocksPerTransaction
*
* The following arguments are supported in the `maxPredLocksPerTransaction` specification block:
*
* * `description` - The description of `maxPredLocksPerTransaction`.
*
* * `maximum` - The maximum valid value for `maxPredLocksPerTransaction`.
*
* * `minimum` - The minimum valid value for `maxPredLocksPerTransaction`.
*
* * `requiresRestart` - Whether changing the value of `maxPredLocksPerTransaction` requires the DB to restart.
*
* * `type` - The type of the value of `maxPredLocksPerTransaction`.
*
* ## maxReplicationSlots
*
* The following arguments are supported in the `maxReplicationSlots` specification block:
*
* * `description` - The description of `maxReplicationSlots`.
*
* * `maximum` - The maximum valid value for `maxReplicationSlots`.
*
* * `minimum` - The minimum valid value for `maxReplicationSlots`.
*
* * `requiresRestart` - Whether changing the value of `maxReplicationSlots` requires the DB to restart.
*
* * `type` - The type of the value of `maxReplicationSlots`.
*
* ## maxSlotWalKeepSize
*
* The following arguments are supported in the `maxSlotWalKeepSize` specification block:
*
* * `description` - The description of `maxSlotWalKeepSize`.
*
* * `maximum` - The maximum valid value for `maxSlotWalKeepSize`.
*
* * `minimum` - The minimum valid value for `maxSlotWalKeepSize`.
*
* * `requiresRestart` - Whether changing the value of `maxSlotWalKeepSize` requires the DB to restart.
*
* * `type` - The type of the value of `maxSlotWalKeepSize`.
*
* ## maxStackDepth
*
* The following arguments are supported in the `maxStackDepth` specification block:
*
* * `description` - The description of `maxStackDepth`.
*
* * `maximum` - The maximum valid value for `maxStackDepth`.
*
* * `minimum` - The minimum valid value for `maxStackDepth`.
*
* * `requiresRestart` - Whether changing the value of `maxStackDepth` requires the DB to restart.
*
* * `type` - The type of the value of `maxStackDepth`.
*
* ## maxStandbyArchiveDelay
*
* The following arguments are supported in the `maxStandbyArchiveDelay` specification block:
*
* * `description` - The description of `maxStandbyArchiveDelay`.
*
* * `maximum` - The maximum valid value for `maxStandbyArchiveDelay`.
*
* * `minimum` - The minimum valid value for `maxStandbyArchiveDelay`.
*
* * `requiresRestart` - Whether changing the value of `maxStandbyArchiveDelay` requires the DB to restart.
*
* * `type` - The type of the value of `maxStandbyArchiveDelay`.
*
* ## maxStandbyStreamingDelay
*
* The following arguments are supported in the `maxStandbyStreamingDelay` specification block:
*
* * `description` - The description of `maxStandbyStreamingDelay`.
*
* * `maximum` - The maximum valid value for `maxStandbyStreamingDelay`.
*
* * `minimum` - The minimum valid value for `maxStandbyStreamingDelay`.
*
* * `requiresRestart` - Whether changing the value of `maxStandbyStreamingDelay` requires the DB to restart.
*
* * `type` - The type of the value of `maxStandbyStreamingDelay`.
*
* ## maxWalSenders
*
* The following arguments are supported in the `maxWalSenders` specification block:
*
* * `description` - The description of `maxWalSenders`.
*
* * `maximum` - The maximum valid value for `maxWalSenders`.
*
* * `minimum` - The minimum valid value for `maxWalSenders`.
*
* * `requiresRestart` - Whether changing the value of `maxWalSenders` requires the DB to restart.
*
* * `type` - The type of the value of `maxWalSenders`.
*
* ## maxWorkerProcesses
*
* The following arguments are supported in the `maxWorkerProcesses` specification block:
*
* * `description` - The description of `maxWorkerProcesses`.
*
* * `maximum` - The maximum valid value for `maxWorkerProcesses`.
*
* * `minimum` - The minimum valid value for `maxWorkerProcesses`.
*
* * `requiresRestart` - Whether changing the value of `maxWorkerProcesses` requires the DB to restart.
*
* * `type` - The type of the value of `maxWorkerProcesses`.
*
* ## passwordEncryption
*
* The following arguments are supported in the `passwordEncryption` specification block:
*
* * `description` - The description of the `passwordEncryption` setting.
*
* * `enum` - A list of valid values for the `passwordEncryption` setting.
*
* * `example` - An example value for the `passwordEncryption` setting.
*
* * `requiresRestart` - Whether changing the value of `passwordEncryption` requires the DB to restart.
*
* * `type` - A list of types for the `passwordEncryption` setting.
*
* ## pgPartmanBgwInterval
*
* The following arguments are supported in the `pgPartmanBgwInterval` specification block:
*
* * `description` - The description of the `pgPartmanBgwInterval` setting.
*
* * `example` - An example value for the `pgPartmanBgwInterval` setting.
*
* * `maximum` - The maximum allowed value for the `pgPartmanBgwInterval` setting.
*
* * `minimum` - The minimum allowed value for the `pgPartmanBgwInterval` setting.
*
* * `requiresRestart` - Whether changing the value of `pgPartmanBgwInterval` requires the DB to restart.
*
* * `type` - The type of the `pgPartmanBgwInterval` setting.
*
* ## pgPartmanBgwRole
*
* The following arguments are supported in the `pgPartmanBgwRole` specification block:
*
* * `description` - The description of the `pgPartmanBgwRole` setting.
*
* * `example` - An example value for the `pgPartmanBgwRole` setting.
*
* * `maxLength` - The maximum length for the `pgPartmanBgwRole` setting.
*
* * `pattern` - The regular expression pattern for validating the `pgPartmanBgwRole` setting.
*
* * `requiresRestart` - Whether changing the value of `pgPartmanBgwRole` requires the DB to restart.
*
* * `type` - The type of the `pgPartmanBgwRole` setting.
*
* ## pgStatMonitorPgsmEnableQueryPlan
*
* The following arguments are supported in the `pgStatMonitorPgsmEnableQueryPlan` specification block:
*
* * `description` - The description of the `pgStatMonitorPgsmEnableQueryPlan` setting.
*
* * `example` - An example value for the `pgStatMonitorPgsmEnableQueryPlan` setting.
*
* * `requiresRestart` - Whether changing the value of `pgStatMonitorPgsmEnableQueryPlan` requires the DB to restart.
*
* * `type` - The type of the `pgStatMonitorPgsmEnableQueryPlan` setting.
*
* ## pgStatMonitorPgsmMaxBuckets
*
* The following arguments are supported in the `pgStatMonitorPgsmMaxBuckets` specification block:
*
* * `description` - The description of the `pgStatMonitorPgsmMaxBuckets` setting.
*
* * `example` - An example value for the `pgStatMonitorPgsmMaxBuckets` setting.
*
* * `maximum` - The maximum allowed value for the `pgStatMonitorPgsmMaxBuckets` setting.
*
* * `minimum` - The minimum allowed value for the `pgStatMonitorPgsmMaxBuckets` setting.
*
* * `requiresRestart` - Whether changing the value of `pgStatMonitorPgsmMaxBuckets` requires the DB to restart.
*
* * `type` - The type of the `pgStatMonitorPgsmMaxBuckets` setting.
*
* ## pgStatStatementsTrack
*
* The following arguments are supported in the `pgStatStatementsTrack` specification block:
*
* * `description` - The description of the `pgStatStatementsTrack` setting.
*
* * `enum` - A list of valid values for the `pgStatStatementsTrack` setting.
*
* * `requiresRestart` - Whether changing the value of `pgStatStatementsTrack` requires the DB to restart.
*
* * `type` - The type of the `pgStatStatementsTrack` setting.
*
* ## tempFileLimit
*
* The following arguments are supported in the `tempFileLimit` specification block:
*
* * `description` - The description of the `tempFileLimit` setting.
*
* * `example` - An example value for the `tempFileLimit` setting.
*
* * `maximum` - The maximum allowed value for the `tempFileLimit` setting.
*
* * `minimum` - The minimum allowed value for the `tempFileLimit` setting.
*
* * `requiresRestart` - Whether changing the value of `tempFileLimit` requires the DB to restart.
*
* * `type` - The type of the `tempFileLimit` setting.
*
* ## timezone
*
* The following arguments are supported in the `timezone` specification block:
*
* * `description` - The description of the `timezone` setting.
*
* * `example` - An example value for the `timezone` setting.
*
* * `maxLength` - The maximum length for the `timezone` setting.
*
* * `pattern` - The regular expression pattern for validating the `timezone` setting.
*
* * `requiresRestart` - Whether changing the value of `timezone` requires the DB to restart.
*
* * `type` - The type of the `timezone` setting.
*
* ## trackActivityQuerySize
*
* The following arguments are supported in the `trackActivityQuerySize` specification block:
*
* * `description` - The description of the `trackActivityQuerySize` setting.
*
* * `example` - An example value for the `trackActivityQuerySize` setting.
*
* * `maximum` - The maximum allowed value for the `trackActivityQuerySize` setting.
*
* * `minimum` - The minimum allowed value for the `trackActivityQuerySize` setting.
*
* * `requiresRestart` - Whether changing the value of `trackActivityQuerySize` requires the DB to restart.
*
* * `type` - The type of the `trackActivityQuerySize` setting.
*
* ## trackCommitTimestamp
*
* The following arguments are supported in the `trackCommitTimestamp` specification block:
*
* * `description` - The description of the `trackCommitTimestamp` setting.
*
* * `enum` - A list of valid values for the `trackCommitTimestamp` setting.
*
* * `example` - An example value for the `trackCommitTimestamp` setting.
*
* * `requiresRestart` - Whether changing the value of `trackCommitTimestamp` requires the DB to restart.
*
* * `type` - The type of the `trackCommitTimestamp` setting.
*
* ## trackFunctions
*
* The following arguments are supported in the `trackFunctions` specification block:
*
* * `description` - The description of the `trackFunctions` setting.
*
* * `enum` - A list of valid values for the `trackFunctions` setting.
*
* * `requiresRestart` - Whether changing the value of `trackFunctions` requires the DB to restart.
*
* * `type` - The type of the `trackFunctions` setting.
*
* ## trackIoTiming
*
* The following arguments are supported in the `trackIoTiming` specification block:
*
* * `description` - The description of the `trackIoTiming` setting.
*
* * `enum` - A list of valid values for the `trackIoTiming` setting.
*
* * `example` - An example value for the `trackIoTiming` setting.
*
* * `requiresRestart` - Whether changing the value of `trackIoTiming` requires the DB to restart.
*
* * `type` - The type of the `trackIoTiming` setting.
*
* ## walSenderTimeout
*
* The following arguments are supported in the `walSenderTimeout` specification block:
*
* * `description` - The description of the `walSenderTimeout` setting.
*
* * `example` - An example value for the `walSenderTimeout` setting.
*
* * `requiresRestart` - Whether changing the value of `walSenderTimeout` requires the DB to restart.
*
* * `type` - The type of the `walSenderTimeout` setting.
*
* ## walWriterDelay
*
* The following arguments are supported in the `walWriterDelay` specification block:
*
* * `description` - The description of the `walWriterDelay` setting.
*
* * `example` - An example value for the `walWriterDelay` setting.
*
* * `maximum` - The maximum allowed value for the `walWriterDelay` setting.
*
* * `minimum` - The minimum allowed value for the `walWriterDelay` setting.
*
* * `requiresRestart` - Whether changing the value of `walWriterDelay` requires the DB to restart.
*
* * `type` - The type of the `walWriterDelay` setting.
*/
function getDatabasePostgresqlConfig(opts) {
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
return pulumi.runtime.invoke("linode:index/getDatabasePostgresqlConfig:getDatabasePostgresqlConfig", {}, opts);
}
exports.getDatabasePostgresqlConfig = getDatabasePostgresqlConfig;
/**
* Provides information about a Linode PostgreSQL Database's Configuration Options.
* For more information, see the Linode APIv4 docs.
*
* ## Example Usage
*
* Get information about a PostgreSQL database's configuration options:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as linode from "@pulumi/linode";
*
* const my_db_config = linode.getDatabasePostgresqlConfig({});
* ```
*
* ## pgStatMonitorEnable
*
* The following arguments are supported in the `pgStatMonitorEnable` specification block:
*
* * `description` - The description of `pgStatMonitorEnable`.
*
* * `requiresRestart` - Whether changing the value `pgStatMonitorEnable` requires the DB to restart.
*
* * `type` - The type of the value of `pgStatMonitorEnable`.
*
* ## pglookout
*
* The following arguments are supported in the `pglookout` specification block:
*
* * `maxFailoverReplicationTimeLag` - The maximum failover replication time lag for `pglookout`.
*
* ## maxFailoverReplicationTimeLag
*
* The following arguments are supported in the `maxFailoverReplicationTimeLag` specification block:
*
* * `description` - The description of `maxFailoverReplicationTimeLag`.
*
* * `maximum` - The maximum valid value for `maxFailoverReplicationTimeLag`.
*
* * `minimum` - The minimum valid value for `maxFailoverReplicationTimeLag`.
*
* * `requiresRestart` - Whether changing the value of `maxFailoverReplicationTimeLag` requires the DB to restart.
*
* * `type` - The type of the value of `maxFailoverReplicationTimeLag`.
*
* ## sharedBuffersPercentage
*
* The following arguments are supported in the `sharedBuffersPercentage` specification block:
*
* * `description` - The description of `sharedBuffersPercentage`.
*
* * `example` - An example of a valid value for `sharedBuffersPercentage`.
*
* * `maximum` - The maximum valid value for `sharedBuffersPercentage`.
*
* * `minimum` - The minimum valid value for `sharedBuffersPercentage`.
*
* * `requiresRestart` - Whether changing the value of `sharedBuffersPercentage` requires the DB to restart.
*
* * `type` - The type of the value of `sharedBuffersPercentage`.
*
* ## workMem
*
* The following arguments are supported in the `workMem` specification block:
*
* * `description` - The description of `workMem`.
*
* * `example` - An example of a valid value for `workMem`.
*
* * `maximum` - The maximum valid value for `workMem`.
*
* * `minimum` - The minimum valid value for `workMem`.
*
* * `requiresRestart` - Whether changing the value of `workMem` requires the DB to restart.
*
* * `type` - The type of the value of `workMem`.
*
* ## pg
*
* The following arguments are supported in the `pg` specification block:
*
* * `autovacuumAnalyzeScaleFactor` - (Optional) Specifies a fraction of the table size to add to autovacuumAnalyzeThreshold when deciding whether to trigger an ANALYZE. The default is 0.2 (20% of table size)
*
* * `autovacuumAnalyzeThreshold` - (Optional) Specifies the minimum number of inserted, updated or deleted tuples needed to trigger an ANALYZE in any one table. The default is 50 tuples.
*
* * `autovacuumMaxWorkers` - (Optional) Specifies the maximum number of autovacuum processes (other than the autovacuum launcher) that may be running at any one time. The default is three. This parameter can only be set at server start.
*
* * `autovacuumNaptime` - (Optional) Specifies the minimum delay between autovacuum runs on any given database. The delay is measured in seconds, and the default is one minute
*
* * `autovacuumVacuumCostDelay` - (Optional) Specifies the cost delay value that will be used in automatic VACUUM operations. If -1 is specified, the regular vacuumCostDelay value will be used. The default value is 20 milliseconds
*
* * `autovacuumVacuumCostLimit` - (Optional) Specifies the cost limit value that will be used in automatic VACUUM operations. If -1 is specified (which is the default), the regular vacuumCostLimit value will be used.
*
* * `autovacuumVacuumScaleFactor` - (Optional) Specifies a fraction of the table size to add to autovacuumVacuumThreshold when deciding whether to trigger a VACUUM. The default is 0.2 (20% of table size)
*
* * `autovacuumVacuumThreshold` - (Optional) Specifies the minimum number of updated or deleted tuples needed to trigger a VACUUM in any one table. The default is 50 tuples.
*
* * `bgwriterDelay` - (Optional) Specifies the delay between activity rounds for the background writer in milliseconds. Default is 200.
*
* * `bgwriterFlushAfter` - (Optional) Whenever more than bgwriterFlushAfter bytes have been written by the background writer, attempt to force the OS to issue these writes to the underlying storage. Specified in kilobytes, default is 512. Setting of 0 disables forced writeback.
*
* * `bgwriterLruMaxpages` - (Optional) In each round, no more than this many buffers will be written by the background writer. Setting this to zero disables background writing. Default is 100.
*
* * `bgwriterLruMultiplier` - (Optional) The average recent need for new buffers is multiplied by bgwriterLruMultiplier 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. The default is 2.0.
*
* * `deadlockTimeout` - (Optional) This is the amount of time, in milliseconds, to wait on a lock before checking to see if there is a deadlock condition.
*
* * `defaultToastCompression` - (Optional) Specifies the default TOAST compression method for values of compressible columns (the default is lz4).
*
* * `idleInTransactionSessionTimeout` - (Optional) Time out sessions with open transactions after this number of milliseconds.
*
* * `jit` - (Optional) Controls system-wide use of Just-in-Time Compilation (JIT).
*
* * `maxFilesPerProcess` - (Optional) PostgreSQL maximum number of files that can be open per process.
*
* * `maxLocksPerTransaction` - (Optional) PostgreSQL maximum locks per transaction.
*
* * `maxLogicalReplicationWorkers` - (Optional) PostgreSQL maximum logical replication workers (taken from the pool of max_parallel_workers).
*
* * `maxParallelWorkers` - (Optional) Sets the maximum number of workers that the system can support for parallel queries.
*
* * `maxParallelWorkersPerGather` - (Optional) Sets the maximum number of workers that can be started by a single Gather or Gather Merge node.
*
* * `maxPredLocksPerTransaction` - (Optional) PostgreSQL maximum predicate locks per transaction.
*
* * `maxReplicationSlots` - (Optional) PostgreSQL maximum replication slots.
*
* * `maxSlotWalKeepSize` - (Optional) PostgreSQL maximum WAL size (MB) reserved for replication slots. Default is -1 (unlimited). walKeepSize minimum WAL size setting takes precedence over this.
*
* * `maxStackDepth` - (Optional) Maximum depth of the stack in bytes.
*
* * `maxStandbyArchiveDelay` - (Optional) Max standby archive delay in milliseconds.
*
* * `maxStandbyStreamingDelay` - (Optional) Max standby streaming delay in milliseconds.
*
* * `maxWalSenders` - (Optional) PostgreSQL maximum WAL senders.
*
* * `maxWorkerProcesses` - (Optional) Sets the maximum number of background processes that the system can support.
*
* * `passwordEncryption` - (Optional) Chooses the algorithm for encrypting passwords.
*
* * `pg_partman_bgw.interval` - (Optional) Sets the time interval to run pg_partman's scheduled tasks.
*
* * `pg_partman_bgw.role` - (Optional) Controls which role to use for pg_partman's scheduled background tasks.
*
* * `pg_stat_monitor.pgsm_enable_query_plan` - (Optional) Enables or disables query plan monitoring.
*
* * `pg_stat_monitor.pgsm_max_buckets` - (Optional) Sets the maximum number of buckets.
*
* * `pg_stat_statements.track` - (Optional) Controls which statements are counted. Specify top to track top-level statements (those issued directly by clients), all to also track nested statements (such as statements invoked within functions), or none to disable statement statistics collection. The default value is top.
*
* * `tempFileLimit` - (Optional) PostgreSQL temporary file limit in KiB, -1 for unlimited.
*
* * `timezone` - (Optional) PostgreSQL service timezone.
*
* * `trackActivityQuerySize` - (Optional) Specifies the number of bytes reserved to track the currently executing command for each active session.
*
* * `trackCommitTimestamp` - (Optional) Record commit time of transactions.
*
* * `trackFunctions` - (Optional) Enables tracking of function call counts and time used.
*
* * `trackIoTiming` - (Optional) 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.
*
* * `walSenderTimeout` - (Optional) Terminate replication connections that are inactive for longer than this amount of time, in milliseconds. Setting this value to zero disables the timeout.
*
* * `walWriterDelay` - (Optional) WAL flush interval in milliseconds. Note that setting this value to lower than the default 200ms may negatively impact performance.
*
* ## autovacuumAnalyzeScaleFactor
*
* The following arguments are supported in the `autovacuumAnalyzeScaleFactor` specification block:
*
* * `description` - The description of `autovacuumAnalyzeScaleFactor`.
*
* * `maximum` - The maximum valid value for `autovacuumAnalyzeScaleFactor`.
*
* * `minimum` - The minimum valid value for `autovacuumAnalyzeScaleFactor`.
*
* * `requiresRestart` - Whether changing the value of `autovacuumAnalyzeScaleFactor` requires the DB to restart.
*
* * `type` - The type of the value of `autovacuumAnalyzeScaleFactor`.
*
* ## autovacuumAnalyzeThreshold
*
* The following arguments are supported in the `autovacuumAnalyzeThreshold` specification block:
*
* * `description` - The description of `autovacuumAnalyzeThreshold`.
*
* * `maximum` - The maximum valid value for `autovacuumAnalyzeThreshold`.
*
* * `minimum` - The minimum valid value for `autovacuumAnalyzeThreshold`.
*
* * `requiresRestart` - Whether changing the value of `autovacuumAnalyzeThreshold` requires the DB to restart.
*
* * `type` - The type of the value of `autovacuumAnalyzeThreshold`.
*
* ## autovacuumMaxWorkers
*
* The following arguments are supported in the `autovacuumMaxWorkers` specification block:
*
* * `description` - The description of `autovacuumMaxWorkers`.
*
* * `maximum` - The maximum valid value for `autovacuumMaxWorkers`.
*
* * `minimum` - The minimum valid value for `autovacuumMaxWorkers`.
*
* * `requiresRestart` - Whether changing the value of `autovacuumMaxWorkers` requires the DB to restart.
*
* * `type` - The type of the value of `autovacuumMaxWorkers`.
*
* ## autovacuumNaptime
*
* The following arguments are supported in the `autovacuumNaptime` specification block:
*
* * `description` - The description of `autovacuumNaptime`.
*
* * `maximum` - The maximum valid value for `autovacuumNaptime`.
*
* * `minimum` - The minimum valid value for `autovacuumNaptime`.
*
* * `requiresRestart` - Whether changing the value of `autovacuumNaptime` requires the DB to restart.
*
* * `type` - The type of the value of `autovacuumNaptime`.
*
* ## autovacuumVacuumCostDelay
*
* The following arguments are supported in the `autovacuumVacuumCostDelay` specification block:
*
* * `description` - The description of `autovacuumVacuumCostDelay`.
*
* * `maximum` - The maximum valid value for `autovacuumVacuumCostDelay`.
*
* * `minimum` - The minimum valid value for `autovacuumVacuumCostDelay`.
*
* * `requiresRestart` - Whether changing the value of `autovacuumVacuumCostDelay` requires the DB to restart.
*
* * `type` - The type of the value of `autovacuumVacuumCostDelay`.
*
* ## autovacuumVacuumCostLimit
*
* The following arguments are supported in the `autovacuumVacuumCostLimit` specification block:
*
* * `description` - The description of `autovacuumVacuumCostLimit`.
*
* * `maximum` - The maximum valid value for `autovacuumVacuumCostLimit`.
*
* * `minimum` - The minimum valid value for `autovacuumVacuumCostLimit`.
*
* * `requiresRestart` - Whether changing the value of `autovacuumVacuumCostLimit` requires the DB to restart.
*
* * `type` - The type of the value of `autovacuumVacuumCostLimit`.
*
* ## autovacuumVacuumScaleFactor
*
* The following arguments are supported in the `autovacuumVacuumScaleFactor` specification block:
*
* * `description` - The description of `autovacuumVacuumScaleFactor`.
*
* * `maximum` - The maximum valid value for `autovacuumVacuumScaleFactor`.
*
* * `minimum` - The minimum valid value for `autovacuumVacuumScaleFactor`.
*
* * `requiresRestart` - Whether changing the value of `autovacuumVacuumScaleFactor` requires the DB to restart.
*
* * `type` - The type of the value of `autovacuumVacuumScaleFactor`.
*
* ## autovacuumVacuumThreshold
*
* The following arguments are supported in the `autovacuumVacuumThreshold` specification block:
*
* * `description` - The description of `autovacuumVacuumThreshold`.
*
* * `maximum` - The maximum valid value for `autovacuumVacuumThreshold`.
*
* * `minimum` - The minimum valid value for `autovacuumVacuumThreshold`.
*
* * `requiresRestart` - Whether changing the value of `autovacuumVacuumThreshold` requires the DB to restart.
*
* * `type` - The type of the value of `autovacuumVacuumThreshold`.
*
* ## bgwriterDelay
*
* The following arguments are supported in the `bgwriterDelay` specification block:
*
* * `description` - The description of `bgwriterDelay`.
*
* * `example` - An example of a valid value for `bgwriterDelay`.
*
* * `maximum` - The maximum valid value for `bgwriterDelay`.
*
* * `minimum` - The minimum valid value for `bgwriterDelay`.
*
* * `requiresRestart` - Whether changing the value of `bgwriterDelay` requires the DB to restart.
*
* * `type` - The type of the value of `bgwriterDelay`.
*
* ## bgwriterFlushAfter
*
* The following arguments are supported in the `bgwriterFlushAfter` specification block:
*
* * `description` - The description of `bgwriterFlushAfter`.
*
* * `example` - An example of a valid value for `bgwriterFlushAfter`.
*
* * `maximum` - The maximum valid value for `bgwriterFlushAfter`.
*
* * `minimum` - The minimum valid value for `bgwriterFlushAfter`.
*
* * `requiresRestart` - Whether changing the value of `bgwriterFlushAfter` requires the DB to restart.
*
* * `type` - The type of the value of `bgwriterFlushAfter`.
*
* ## bgwriterLruMaxpages
*
* The following arguments are supported in the `bgwriterLruMaxpages` specification block:
*
* * `description` - The description of `bgwriterLruMaxpages`.
*
* * `example` - An example of a valid value for `bgwriterLruMaxpages`.
*
* * `maximum` - The maximum valid value for `bgwriterLruMaxpages`.
*
* * `minimum` - The minimum valid value for `bgwriterLruMaxpages`.
*
* * `requiresRestart` - Whether changing the value of `bgwriterLruMaxpages` requires the DB to restart.
*
* * `type` - The type of the value of `bgwriterLruMaxpages`.
*
* ## bgwriterLruMultiplier
*
* The following arguments are supported in the `bgwriterLruMultiplier` specification block:
*
* * `description` - The description of `bgwriterLruMultiplier`.
*
* * `example` - An example of a valid value for `bgwriterLruMultiplier`.
*
* * `maximum` - The maximum valid value for `bgwriterLruMultiplier`.
*
* * `minimum` - The minimum valid value for `bgwriterLruMultiplier`.
*
* * `requiresRestart` - Whether changing the value of `bgwriterLruMultiplier` requires the DB to restart.
*
* * `type` - The type of the value of `bgwriterLruMultiplier`.
*
* ## deadlockTimeout
*
* The following arguments are supported in the `deadlockTimeout` specification block:
*
* * `description` - The description of `deadlockTimeout`.
*
* * `example` - An example of a valid value for `deadlockTimeout`.
*
* * `maximum` - The maximum valid value for `deadlockTimeout`.
*
* * `minimum` - The minimum valid value for `deadlockTimeout`.
*
* * `requiresRestart` - Whether changing the value of `deadlockTimeout` requires the DB to restart.
*
* * `type` - The type of the value of `deadlockTimeout`.
*
* ## defaultToastCompression
*
* The following arguments are supported in the `defaultToastCompression` specification block:
*
* * `description` - The description of `defaultToastCompression`.
*
* * `enum` - A list of valid compression methods for `defaultToastCompression`.
*
* * `example` - An example of a valid value for `defaultToastComp