Managed Service for PostgreSQL API, REST: Cluster.ListHosts

Field

Description

clusterId

string

Required field. ID of the PostgreSQL cluster.
To get the PostgreSQL cluster ID use a ClusterService.List request.

The maximum string length in characters is 50.

Field

Description

pageSize

string (int64)

The maximum number of results per page to return. If the number of available
results is larger than pageSize, the service returns a ListClusterHostsResponse.nextPageToken
that can be used to get the next page of results in subsequent list requests.

The maximum value is 1000.

pageToken

string

Page token. To get the next page of results, set pageToken to the ListClusterHostsResponse.nextPageToken
returned by the previous list request.

The maximum string length in characters is 100.

Field

Description

hosts[]

Host

List of Host resources.

nextPageToken

string

This token allows you to get the next page of results for list requests. If the number of results
is larger than ListClusterHostsRequest.pageSize, use the nextPageToken as the value
for the ListClusterHostsRequest.pageToken query parameter in the next list request.
Each subsequent list request will have its own nextPageToken to continue paging through the results.

Field

Description

name

string

Name of the PostgreSQL host. The host name is assigned by MDB at creation time, and cannot be changed.
1-63 characters long.

The name is unique across all MDB hosts that exist on the platform, as it defines the FQDN of the host.

clusterId

string

ID of the PostgreSQL host. The ID is assigned by MDB at creation time.

zoneId

string

ID of the availability zone where the PostgreSQL host resides.

resources

Resources

Resources allocated to the PostgreSQL host.

role

enum (Role)

Role of the host in the cluster. If the field has default value, it is not returned in the response.

• ROLE_UNKNOWN: Role of the host in the cluster is unknown. Default value.
• MASTER: Host is the master PostgreSQL server in the cluster.
• REPLICA: Host is a replica (standby) PostgreSQL server in the cluster.

health

enum (Health)

Aggregated health of the host. If the field has default value, it is not returned in the response.

• HEALTH_UNKNOWN: Health of the host is unknown. Default value.
• ALIVE: The host is performing all its functions normally.
• DEAD: The host is inoperable, and cannot perform any of its essential functions.
• DEGRADED: The host is degraded, and can perform only some of its essential functions.
• READONLY: The host is alive, but in read-only mode.

services[]

Service

Services provided by the host.

subnetId

string

ID of the subnet that the host belongs to.

replicationSource

string

Name of the host to be used as the replication source for cascading replication.

priority

string (int64)

Priority of the host as a replica. Higher value means higher priority.

The host with the highest priority is the synchronous replica. All others are asynchronous.
The synchronous replica replaces the master when needed.

When a replica becomes the master, its priority is ignored.

config

HostConfig

Configuration of a PostgreSQL server for the host.

assignPublicIp

boolean

Flag showing public IP assignment status to this host.

replicaType

enum (ReplicaType)

ReplicaType represents the current synchronization state of a PostgreSQL replica
as reported by the primary host.

• REPLICA_TYPE_UNKNOWN: Replica type is unknown (we have no data) or it's master
• ASYNC: The replica uses asynchronous replication.
• SYNC: The replica is a synchronous standby in priority-based synchronous replication.
• QUORUM: The replica participates in quorum-based synchronous replication.

Field

Description

resourcePresetId

string

ID of the preset for computational resources available to a host (CPU, memory etc.).
All available presets are listed in the documentation.

diskSize

string (int64)

Volume of the storage available to a host, in bytes.

diskTypeId

string

Type of the storage environment for the host.
Possible values:

• network-hdd - network HDD drive,
• network-ssd - network SSD drive,
• local-ssd - local SSD storage.

Field

Description

type

enum (Type)

Type of the service provided by the host. If the field has default value, it is not returned in the response.

• POSTGRESQL: The host is a PostgreSQL server.
• POOLER: The host is a PgBouncer server.

health

enum (Health)

Aggregated health of the service. If the field has default value, it is not returned in the response.

• HEALTH_UNKNOWN: Health of the server is unknown. Default value.
• ALIVE: The server is working normally.
• DEAD: The server is dead or unresponsive.
• READONLY: The server is in read-only mode.

Field

Description

postgresqlConfig_11

PostgresqlHostConfig11

Configuration for a host with PostgreSQL 11 server deployed.

Includes only one of the fields postgresqlConfig_11, postgresqlConfig_12, postgresqlConfig_13, postgresqlConfig_13_1c, postgresqlConfig_14, postgresqlConfig_14_1c, postgresqlConfig_15, postgresqlConfig_15_1c, postgresqlConfig_16, postgresqlConfig_16_1c, postgresqlConfig_17, postgresqlConfig_17_1c, postgresqlConfig_18, postgresqlConfig_18_1c.

Configuration of a PostgreSQL server for the host.

postgresqlConfig_12

PostgresqlHostConfig12

Configuration for a host with PostgreSQL 12 server deployed.

Includes only one of the fields postgresqlConfig_11, postgresqlConfig_12, postgresqlConfig_13, postgresqlConfig_13_1c, postgresqlConfig_14, postgresqlConfig_14_1c, postgresqlConfig_15, postgresqlConfig_15_1c, postgresqlConfig_16, postgresqlConfig_16_1c, postgresqlConfig_17, postgresqlConfig_17_1c, postgresqlConfig_18, postgresqlConfig_18_1c.

Configuration of a PostgreSQL server for the host.

postgresqlConfig_13

PostgresqlHostConfig13

Configuration for a host with PostgreSQL 13 server deployed.

Includes only one of the fields postgresqlConfig_11, postgresqlConfig_12, postgresqlConfig_13, postgresqlConfig_13_1c, postgresqlConfig_14, postgresqlConfig_14_1c, postgresqlConfig_15, postgresqlConfig_15_1c, postgresqlConfig_16, postgresqlConfig_16_1c, postgresqlConfig_17, postgresqlConfig_17_1c, postgresqlConfig_18, postgresqlConfig_18_1c.

Configuration of a PostgreSQL server for the host.

postgresqlConfig_13_1c

PostgresqlHostConfig13_1C

Configuration for a host with PostgreSQL 13 1C server deployed.

Includes only one of the fields postgresqlConfig_11, postgresqlConfig_12, postgresqlConfig_13, postgresqlConfig_13_1c, postgresqlConfig_14, postgresqlConfig_14_1c, postgresqlConfig_15, postgresqlConfig_15_1c, postgresqlConfig_16, postgresqlConfig_16_1c, postgresqlConfig_17, postgresqlConfig_17_1c, postgresqlConfig_18, postgresqlConfig_18_1c.

Configuration of a PostgreSQL server for the host.

postgresqlConfig_14

PostgresqlHostConfig14

Configuration for a host with PostgreSQL 14 server deployed.

Includes only one of the fields postgresqlConfig_11, postgresqlConfig_12, postgresqlConfig_13, postgresqlConfig_13_1c, postgresqlConfig_14, postgresqlConfig_14_1c, postgresqlConfig_15, postgresqlConfig_15_1c, postgresqlConfig_16, postgresqlConfig_16_1c, postgresqlConfig_17, postgresqlConfig_17_1c, postgresqlConfig_18, postgresqlConfig_18_1c.

Configuration of a PostgreSQL server for the host.

postgresqlConfig_14_1c

PostgresqlHostConfig14_1C

Configuration for a host with PostgreSQL 14 1C server deployed.

Includes only one of the fields postgresqlConfig_11, postgresqlConfig_12, postgresqlConfig_13, postgresqlConfig_13_1c, postgresqlConfig_14, postgresqlConfig_14_1c, postgresqlConfig_15, postgresqlConfig_15_1c, postgresqlConfig_16, postgresqlConfig_16_1c, postgresqlConfig_17, postgresqlConfig_17_1c, postgresqlConfig_18, postgresqlConfig_18_1c.

Configuration of a PostgreSQL server for the host.

postgresqlConfig_15

PostgresqlHostConfig15

Configuration for a host with PostgreSQL 15 server deployed.

Includes only one of the fields postgresqlConfig_11, postgresqlConfig_12, postgresqlConfig_13, postgresqlConfig_13_1c, postgresqlConfig_14, postgresqlConfig_14_1c, postgresqlConfig_15, postgresqlConfig_15_1c, postgresqlConfig_16, postgresqlConfig_16_1c, postgresqlConfig_17, postgresqlConfig_17_1c, postgresqlConfig_18, postgresqlConfig_18_1c.

Configuration of a PostgreSQL server for the host.

postgresqlConfig_15_1c

PostgresqlHostConfig15_1C

Configuration for a host with PostgreSQL 15 1C server deployed.

Includes only one of the fields postgresqlConfig_11, postgresqlConfig_12, postgresqlConfig_13, postgresqlConfig_13_1c, postgresqlConfig_14, postgresqlConfig_14_1c, postgresqlConfig_15, postgresqlConfig_15_1c, postgresqlConfig_16, postgresqlConfig_16_1c, postgresqlConfig_17, postgresqlConfig_17_1c, postgresqlConfig_18, postgresqlConfig_18_1c.

Configuration of a PostgreSQL server for the host.

postgresqlConfig_16

PostgresqlHostConfig16

Configuration for a host with PostgreSQL 16 server deployed.

Includes only one of the fields postgresqlConfig_11, postgresqlConfig_12, postgresqlConfig_13, postgresqlConfig_13_1c, postgresqlConfig_14, postgresqlConfig_14_1c, postgresqlConfig_15, postgresqlConfig_15_1c, postgresqlConfig_16, postgresqlConfig_16_1c, postgresqlConfig_17, postgresqlConfig_17_1c, postgresqlConfig_18, postgresqlConfig_18_1c.

Configuration of a PostgreSQL server for the host.

postgresqlConfig_16_1c

PostgresqlHostConfig16_1C

Configuration for a host with PostgreSQL 16 1C server deployed.

Includes only one of the fields postgresqlConfig_11, postgresqlConfig_12, postgresqlConfig_13, postgresqlConfig_13_1c, postgresqlConfig_14, postgresqlConfig_14_1c, postgresqlConfig_15, postgresqlConfig_15_1c, postgresqlConfig_16, postgresqlConfig_16_1c, postgresqlConfig_17, postgresqlConfig_17_1c, postgresqlConfig_18, postgresqlConfig_18_1c.

Configuration of a PostgreSQL server for the host.

postgresqlConfig_17

PostgresqlHostConfig17

Configuration for a host with PostgreSQL 17 server deployed.

Includes only one of the fields postgresqlConfig_11, postgresqlConfig_12, postgresqlConfig_13, postgresqlConfig_13_1c, postgresqlConfig_14, postgresqlConfig_14_1c, postgresqlConfig_15, postgresqlConfig_15_1c, postgresqlConfig_16, postgresqlConfig_16_1c, postgresqlConfig_17, postgresqlConfig_17_1c, postgresqlConfig_18, postgresqlConfig_18_1c.

Configuration of a PostgreSQL server for the host.

postgresqlConfig_17_1c

PostgresqlHostConfig17_1C

Configuration for a host with PostgreSQL 17 1C server deployed.

Includes only one of the fields postgresqlConfig_11, postgresqlConfig_12, postgresqlConfig_13, postgresqlConfig_13_1c, postgresqlConfig_14, postgresqlConfig_14_1c, postgresqlConfig_15, postgresqlConfig_15_1c, postgresqlConfig_16, postgresqlConfig_16_1c, postgresqlConfig_17, postgresqlConfig_17_1c, postgresqlConfig_18, postgresqlConfig_18_1c.

Configuration of a PostgreSQL server for the host.

postgresqlConfig_18

PostgresqlHostConfig18

Configuration for a host with PostgreSQL 18 server deployed.

Includes only one of the fields postgresqlConfig_11, postgresqlConfig_12, postgresqlConfig_13, postgresqlConfig_13_1c, postgresqlConfig_14, postgresqlConfig_14_1c, postgresqlConfig_15, postgresqlConfig_15_1c, postgresqlConfig_16, postgresqlConfig_16_1c, postgresqlConfig_17, postgresqlConfig_17_1c, postgresqlConfig_18, postgresqlConfig_18_1c.

Configuration of a PostgreSQL server for the host.

postgresqlConfig_18_1c

PostgresqlHostConfig18_1C

Configuration for a host with PostgreSQL 18 1C server deployed.

Includes only one of the fields postgresqlConfig_11, postgresqlConfig_12, postgresqlConfig_13, postgresqlConfig_13_1c, postgresqlConfig_14, postgresqlConfig_14_1c, postgresqlConfig_15, postgresqlConfig_15_1c, postgresqlConfig_16, postgresqlConfig_16_1c, postgresqlConfig_17, postgresqlConfig_17_1c, postgresqlConfig_18, postgresqlConfig_18_1c.

Configuration of a PostgreSQL server for the host.

Field

Description

recoveryMinApplyDelay

string (int64)

Sets the minimum delay for applying changes during recovery. In milliseconds.

sharedBuffers

string (int64)

Sets the number of shared memory buffers used by the server. In bytes.

tempBuffers

string (int64)

Sets the maximum number of temporary buffers used by each session. In bytes.

workMem

string (int64)

Sets the maximum memory to be used for query workspaces. This much memory can be used by each
internal sort operation and hash table before switching to temporary disk files. In bytes.

tempFileLimit

string (int64)

Limits the total size of all temporary files used by each process. -1 means no limit. In bytes.

backendFlushAfter

string (int64)

Specifies how much data a backend can write before forcing the operating system to issue the writes. In bytes.

Acceptable values are 0 to 2097152, inclusive.

oldSnapshotThreshold

string (int64)

Time before a snapshot is too old to read pages changed after the snapshot was taken.
A value of -1 disables this feature. In milliseconds.

maxStandbyStreamingDelay

string (int64)

Sets the maximum delay before canceling queries when a hot standby server is processing streamed WAL data. In milliseconds.

constraintExclusion

enum (ConstraintExclusion)

Enables the planner to use constraints to optimize queries.

• CONSTRAINT_EXCLUSION_ON: Enable planner's use of constraints for all tables.
• CONSTRAINT_EXCLUSION_OFF: Disable planner's use of constraints for all tables
• CONSTRAINT_EXCLUSION_PARTITION: Only use constraints for child tables and UNION ALL clauses.

cursorTupleFraction

number (double)

Sets the planner's estimate of the fraction of a cursor's rows that will be retrieved.

fromCollapseLimit

string (int64)

Sets the FROM-list size beyond which subqueries are not collapsed.

Acceptable values are 1 to 2147483647, inclusive.

joinCollapseLimit

string (int64)

Sets the FROM-list size beyond which JOIN constructs are not flattened.

Acceptable values are 1 to 2147483647, inclusive.

forceParallelMode

enum (ForceParallelMode)

Forces use of parallel query facilities. If possible, run query using a parallel worker and with parallel restrictions.

• FORCE_PARALLEL_MODE_ON: Forces parallel mode for queries considered safe, even when no performance benefit is expected.
• FORCE_PARALLEL_MODE_OFF: Uses parallel mode only when the planner expects it to improve performance.
• FORCE_PARALLEL_MODE_REGRESS: Behaves like ON, but hides added Gather nodes in EXPLAIN output and
  suppresses parallel-worker context lines to stabilize regression-test output.

clientMinMessages

enum (LogLevel)

Sets the message levels that are sent to the client.

• LOG_LEVEL_DEBUG5: Provides the most detailed diagnostic information for developers.
• LOG_LEVEL_DEBUG4: Provides more detailed diagnostic information than DEBUG3.
• LOG_LEVEL_DEBUG3: Provides more detailed diagnostic information than DEBUG2.
• LOG_LEVEL_DEBUG2: Provides more detailed diagnostic information than DEBUG1.
• LOG_LEVEL_DEBUG1: Provides diagnostic information for developers.
• LOG_LEVEL_LOG: Reports information of interest to database administrators.
• LOG_LEVEL_NOTICE: Reports information that may be helpful to users.
• LOG_LEVEL_WARNING: Reports a warning about a likely problem.
• LOG_LEVEL_ERROR: Reports an error that aborts the current command.
• LOG_LEVEL_FATAL: Reports an error that aborts the current session.
• LOG_LEVEL_PANIC: Reports an error that aborts all database sessions.

logMinMessages

enum (LogLevel)

Sets the message levels that are logged.

• LOG_LEVEL_DEBUG5: Provides the most detailed diagnostic information for developers.
• LOG_LEVEL_DEBUG4: Provides more detailed diagnostic information than DEBUG3.
• LOG_LEVEL_DEBUG3: Provides more detailed diagnostic information than DEBUG2.
• LOG_LEVEL_DEBUG2: Provides more detailed diagnostic information than DEBUG1.
• LOG_LEVEL_DEBUG1: Provides diagnostic information for developers.
• LOG_LEVEL_LOG: Reports information of interest to database administrators.
• LOG_LEVEL_NOTICE: Reports information that may be helpful to users.
• LOG_LEVEL_WARNING: Reports a warning about a likely problem.
• LOG_LEVEL_ERROR: Reports an error that aborts the current command.
• LOG_LEVEL_FATAL: Reports an error that aborts the current session.
• LOG_LEVEL_PANIC: Reports an error that aborts all database sessions.

logMinErrorStatement

enum (LogLevel)

Causes all statements generating error at or above this level to be logged.

• LOG_LEVEL_DEBUG5: Provides the most detailed diagnostic information for developers.
• LOG_LEVEL_DEBUG4: Provides more detailed diagnostic information than DEBUG3.
• LOG_LEVEL_DEBUG3: Provides more detailed diagnostic information than DEBUG2.
• LOG_LEVEL_DEBUG2: Provides more detailed diagnostic information than DEBUG1.
• LOG_LEVEL_DEBUG1: Provides diagnostic information for developers.
• LOG_LEVEL_LOG: Reports information of interest to database administrators.
• LOG_LEVEL_NOTICE: Reports information that may be helpful to users.
• LOG_LEVEL_WARNING: Reports a warning about a likely problem.
• LOG_LEVEL_ERROR: Reports an error that aborts the current command.
• LOG_LEVEL_FATAL: Reports an error that aborts the current session.
• LOG_LEVEL_PANIC: Reports an error that aborts all database sessions.

logMinDurationStatement

string (int64)

Sets the minimum execution time above which all statements will be logged. In milliseconds.

logCheckpoints

boolean

Logs each checkpoint.

logConnections

boolean

Logs each successful connection.

logDisconnections

boolean

Logs end of a session, including duration.

logDuration

boolean

Logs the duration of each completed SQL statement.

logErrorVerbosity

enum (LogErrorVerbosity)

Sets the verbosity of logged messages.

• LOG_ERROR_VERBOSITY_TERSE: DETAIL, HINT, QUERY, and CONTEXT fields are excluded from the error message.
• LOG_ERROR_VERBOSITY_DEFAULT: Default.
• LOG_ERROR_VERBOSITY_VERBOSE: Error message includes the SQLSTATE error code, source filename, function name, and the line number where the error occurred.

logLockWaits

boolean

Logs long lock waits.

logStatement

enum (LogStatement)

Sets the type of statements logged.

• LOG_STATEMENT_NONE: The filter is disabled, no SQL statements are logged.
• LOG_STATEMENT_DDL: System logs DDL statements, e.g., CREATE, ALTER, DROP etc.
• LOG_STATEMENT_MOD: System logs ddl-statements along with data modification commands, e.g., INSERT, UPDATE, etc.
• LOG_STATEMENT_ALL: System logs all SQL statements.

logTempFiles

string (int64)

Log the use of temporary files larger than this number of kilobytes.

searchPath

string

Sets the schema search order for names that are not schema-qualified.

rowSecurity

boolean

Enable row security.

defaultTransactionIsolation

enum (TransactionIsolation)

Sets the transaction isolation level of each new transaction.

• TRANSACTION_ISOLATION_READ_UNCOMMITTED: This level behaves like TRANSACTION_ISOLATION_READ_COMMITTED in PostgreSQL.
• TRANSACTION_ISOLATION_READ_COMMITTED: On this level query sees only data committed before the query began.
• TRANSACTION_ISOLATION_REPEATABLE_READ: On this level all subsequent queries in a transaction will see the same rows, that were read by the first SELECT or INSERT query in this transaction, unchanged (these rows are locked during the first query).
• TRANSACTION_ISOLATION_SERIALIZABLE: This level provides the strictest transaction isolation.
  All queries in the current transaction see only the rows that were fixed prior to execution of the first SELECT or INSERT query in this transaction.
  If read and write operations in a concurrent set of serializable transactions overlap and this may cause an inconsistency that is not possible during the serial transaction execution, then one of the transaction will be rolled back, triggering a serialization failure.

statementTimeout

string (int64)

Sets the maximum allowed duration of any statement. In milliseconds.

lockTimeout

string (int64)

Sets the maximum allowed duration of any wait for a lock. In milliseconds.

idleInTransactionSessionTimeout

string (int64)

Sets the maximum allowed idle time between queries, when in a transaction. In milliseconds.

Acceptable values are 0 to 2147483647, inclusive.

byteaOutput

enum (ByteaOutput)

Sets the output format for bytea.

• BYTEA_OUTPUT_HEX: Each byte is represented by two hexadecimal characters, e.g., 'SELECT '\xDEADBEEF';'.
• BYTEA_OUTPUT_ESCAPED: Standard PostgreSQL format with ASCII characters only.

xmlbinary

enum (XmlBinary)

Sets how binary values are to be encoded in XML.

• XML_BINARY_BASE64: Encodes binary values using Base64.
• XML_BINARY_HEX: Encodes binary values using hexadecimal notation.

xmloption

enum (XmlOption)

Sets whether XML data in implicit parsing and serialization operations is to be considered as documents or content fragments.

• XML_OPTION_DOCUMENT: Treats an XML value as a complete, well-formed document.
• XML_OPTION_CONTENT: Treats an XML value as a content fragment, which may contain multiple top-level elements or character nodes.

ginPendingListLimit

string (int64)

Sets the maximum size of the pending list for GIN index. In bytes.

deadlockTimeout

string (int64)

Sets the time to wait on a lock before checking for deadlock. In milliseconds.

Acceptable values are 1 to 2147483647, inclusive.

maxLocksPerTransaction

string (int64)

Sets the maximum number of locks per transaction. The shared lock table is sized on the assumption that
at most max_locks_per_transaction * max_connections distinct objects will need to be locked at any one time.

maxPredLocksPerTransaction

string (int64)

Sets the maximum number of predicate locks per transaction.The shared predicate lock table is sized on the assumption that
at most max_pred_locks_per_transaction * max_connections distinct objects will need to be locked at any one time.

arrayNulls

boolean

Enable input of NULL elements in arrays. When turned on, unquoted NULL in an array input
value means a null value; otherwise it is taken literally.

backslashQuote

enum (BackslashQuote)

Sets whether "\'" is allowed in string literals.

• BACKSLASH_QUOTE: Legacy invalid value. Do not use.
• BACKSLASH_QUOTE_ON: Quotation mark can be represented as '.
• BACKSLASH_QUOTE_OFF: Quotation mark can only be represented using the standard SQL syntax ''.
• BACKSLASH_QUOTE_SAFE_ENCODING: Representing a quotation mark as ' is only permitted for client encodings where \ is not used for multibyte characters.

defaultWithOids

boolean

WITH OIDS is no longer supported; this can only be false.

escapeStringWarning

boolean

Warn about backslash escapes in ordinary string literals.

loCompatPrivileges

boolean

Enables backward compatibility mode for privilege checks on large objects. Skips privilege checks
when reading or modifying large objects, for compatibility with PostgreSQL releases prior to 9.0.

operatorPrecedenceWarning

boolean

Emit a warning for constructs that changed meaning since PostgreSQL 9.4.

quoteAllIdentifiers

boolean

When generating SQL fragments, quote all identifiers.

standardConformingStrings

boolean

Causes '...' strings to treat backslashes literally.

synchronizeSeqscans

boolean

Enable synchronized sequential scans.

transformNullEquals

boolean

Treats "expr=NULL" as "expr IS NULL". When turned on, expressions of the form expr = NULL
(or NULL = expr) are treated as expr IS NULL, that is, they return true if expr evaluates to the
null value, and false otherwise. The correct behavior of expr = NULL is to always return null (unknown).

exitOnError

boolean

Terminate session on any error.

seqPageCost

number (double)

Sets the planner's estimate of the cost of a sequentially fetched disk page.

The minimum value is 0.

randomPageCost

number (double)

Sets the planner's estimate of the cost of a nonsequentially fetched disk page.

The minimum value is 0.

enableBitmapscan

boolean

Enables the planner's use of bitmap-scan plans.

enableHashagg

boolean

Enables the planner's use of hashed aggregation plans.

enableHashjoin

boolean

Enables the planner's use of hash join plans.

enableIndexscan

boolean

Enables the planner's use of index-scan plans.

enableIndexonlyscan

boolean

Enables the planner's use of index-only-scan plans.

enableMaterial

boolean

Enables the planner's use of materialization.

enableMergejoin

boolean

Enables the planner's use of merge join plans.

enableNestloop

boolean

Enables the planner's use of nested-loop join plans.

enableSeqscan

boolean

Enables the planner's use of sequential-scan plans.

enableSort

boolean

Enables the planner's use of explicit sort steps.

enableTidscan

boolean

Enables the planner's use of TID scan plans.

maxParallelWorkers

string (int64)

Sets the maximum number of parallel workers that can be active at one time.

Acceptable values are 0 to 1024, inclusive.

maxParallelWorkersPerGather

string (int64)

Sets the maximum number of parallel processes per executor node.

Acceptable values are 0 to 1024, inclusive.

timezone

string

Sets the time zone for displaying and interpreting time stamps.

effectiveIoConcurrency

string (int64)

Number of simultaneous requests that can be handled efficiently by the disk subsystem.

Acceptable values are 0 to 1000, inclusive.

effectiveCacheSize

string (int64)

Sets the planner's assumption about the effective size of the disk cache available to a single query. In bytes.

Acceptable values are 1048576 to 549755813888, inclusive.

Field

Description

recoveryMinApplyDelay

string (int64)

Sets the minimum delay for applying changes during recovery. In milliseconds.

sharedBuffers

string (int64)

Sets the number of shared memory buffers used by the server. In bytes.

tempBuffers

string (int64)

Sets the maximum number of temporary buffers used by each session. In bytes.

workMem

string (int64)

Sets the maximum memory to be used for query workspaces. This much memory can be used by each
internal sort operation and hash table before switching to temporary disk files. In bytes.

tempFileLimit

string (int64)

Limits the total size of all temporary files used by each process. -1 means no limit. In bytes.

backendFlushAfter

string (int64)

Specifies how much data a backend can write before forcing the operating system to issue the writes. In bytes.

Acceptable values are 0 to 2097152, inclusive.

oldSnapshotThreshold

string (int64)

Time before a snapshot is too old to read pages changed after the snapshot was taken.
A value of -1 disables this feature. In milliseconds.

maxStandbyStreamingDelay

string (int64)

Sets the maximum delay before canceling queries when a hot standby server is processing streamed WAL data. In milliseconds.

constraintExclusion

enum (ConstraintExclusion)

Enables the planner to use constraints to optimize queries.

• CONSTRAINT_EXCLUSION_ON: Enable planner's use of constraints for all tables.
• CONSTRAINT_EXCLUSION_OFF: Disable planner's use of constraints for all tables
• CONSTRAINT_EXCLUSION_PARTITION: Only use constraints for child tables and UNION ALL clauses.

cursorTupleFraction

number (double)

Sets the planner's estimate of the fraction of a cursor's rows that will be retrieved.

fromCollapseLimit

string (int64)

Sets the FROM-list size beyond which subqueries are not collapsed.

Acceptable values are 1 to 2147483647, inclusive.

joinCollapseLimit

string (int64)

Sets the FROM-list size beyond which JOIN constructs are not flattened.

Acceptable values are 1 to 2147483647, inclusive.

forceParallelMode

enum (ForceParallelMode)

Forces use of parallel query facilities. If possible, run query using a parallel worker and with parallel restrictions.

• FORCE_PARALLEL_MODE_ON: Forces parallel mode for queries considered safe, even when no performance benefit is expected.
• FORCE_PARALLEL_MODE_OFF: Uses parallel mode only when the planner expects it to improve performance.
• FORCE_PARALLEL_MODE_REGRESS: Behaves like ON, but hides added Gather nodes in EXPLAIN output and
  suppresses parallel-worker context lines to stabilize regression-test output.

clientMinMessages

enum (LogLevel)

Sets the message levels that are sent to the client.

• LOG_LEVEL_DEBUG5: Provides the most detailed diagnostic information for developers.
• LOG_LEVEL_DEBUG4: Provides more detailed diagnostic information than DEBUG3.
• LOG_LEVEL_DEBUG3: Provides more detailed diagnostic information than DEBUG2.
• LOG_LEVEL_DEBUG2: Provides more detailed diagnostic information than DEBUG1.
• LOG_LEVEL_DEBUG1: Provides diagnostic information for developers.
• LOG_LEVEL_LOG: Reports information of interest to database administrators.
• LOG_LEVEL_NOTICE: Reports information that may be helpful to users.
• LOG_LEVEL_WARNING: Reports a warning about a likely problem.
• LOG_LEVEL_ERROR: Reports an error that aborts the current command.
• LOG_LEVEL_FATAL: Reports an error that aborts the current session.
• LOG_LEVEL_PANIC: Reports an error that aborts all database sessions.

logMinMessages

enum (LogLevel)

Sets the message levels that are logged.

• LOG_LEVEL_DEBUG5: Provides the most detailed diagnostic information for developers.
• LOG_LEVEL_DEBUG4: Provides more detailed diagnostic information than DEBUG3.
• LOG_LEVEL_DEBUG3: Provides more detailed diagnostic information than DEBUG2.
• LOG_LEVEL_DEBUG2: Provides more detailed diagnostic information than DEBUG1.
• LOG_LEVEL_DEBUG1: Provides diagnostic information for developers.
• LOG_LEVEL_LOG: Reports information of interest to database administrators.
• LOG_LEVEL_NOTICE: Reports information that may be helpful to users.
• LOG_LEVEL_WARNING: Reports a warning about a likely problem.
• LOG_LEVEL_ERROR: Reports an error that aborts the current command.
• LOG_LEVEL_FATAL: Reports an error that aborts the current session.
• LOG_LEVEL_PANIC: Reports an error that aborts all database sessions.

logMinErrorStatement

enum (LogLevel)

Causes all statements generating error at or above this level to be logged.

• LOG_LEVEL_DEBUG5: Provides the most detailed diagnostic information for developers.
• LOG_LEVEL_DEBUG4: Provides more detailed diagnostic information than DEBUG3.
• LOG_LEVEL_DEBUG3: Provides more detailed diagnostic information than DEBUG2.
• LOG_LEVEL_DEBUG2: Provides more detailed diagnostic information than DEBUG1.
• LOG_LEVEL_DEBUG1: Provides diagnostic information for developers.
• LOG_LEVEL_LOG: Reports information of interest to database administrators.
• LOG_LEVEL_NOTICE: Reports information that may be helpful to users.
• LOG_LEVEL_WARNING: Reports a warning about a likely problem.
• LOG_LEVEL_ERROR: Reports an error that aborts the current command.
• LOG_LEVEL_FATAL: Reports an error that aborts the current session.
• LOG_LEVEL_PANIC: Reports an error that aborts all database sessions.

logMinDurationStatement

string (int64)

Sets the minimum execution time above which all statements will be logged. In milliseconds.

logCheckpoints

boolean

Logs each checkpoint.

logConnections

boolean

Logs each successful connection.

logDisconnections

boolean

Logs end of a session, including duration.

logDuration

boolean

Logs the duration of each completed SQL statement.

logErrorVerbosity

enum (LogErrorVerbosity)

Sets the verbosity of logged messages.

• LOG_ERROR_VERBOSITY_TERSE: DETAIL, HINT, QUERY, and CONTEXT fields are excluded from the error message.
• LOG_ERROR_VERBOSITY_DEFAULT: Default.
• LOG_ERROR_VERBOSITY_VERBOSE: Error message includes the SQLSTATE error code, source filename, function name, and the line number where the error occurred.

logLockWaits

boolean

Logs long lock waits.

logStatement

enum (LogStatement)

Sets the type of statements logged.

• LOG_STATEMENT_NONE: The filter is disabled, no SQL statements are logged.
• LOG_STATEMENT_DDL: System logs DDL statements, e.g., CREATE, ALTER, DROP etc.
• LOG_STATEMENT_MOD: System logs ddl-statements along with data modification commands, e.g., INSERT, UPDATE, etc.
• LOG_STATEMENT_ALL: System logs all SQL statements.

logTempFiles

string (int64)

Log the use of temporary files larger than this number of kilobytes.

searchPath

string

Sets the schema search order for names that are not schema-qualified.

rowSecurity

boolean

Enable row security.

defaultTransactionIsolation

enum (TransactionIsolation)

Sets the transaction isolation level of each new transaction.

• TRANSACTION_ISOLATION_READ_UNCOMMITTED: This level behaves like TRANSACTION_ISOLATION_READ_COMMITTED in PostgreSQL.
• TRANSACTION_ISOLATION_READ_COMMITTED: On this level query sees only data committed before the query began.
• TRANSACTION_ISOLATION_REPEATABLE_READ: On this level all subsequent queries in a transaction will see the same rows, that were read by the first SELECT or INSERT query in this transaction, unchanged (these rows are locked during the first query).
• TRANSACTION_ISOLATION_SERIALIZABLE: This level provides the strictest transaction isolation.
  All queries in the current transaction see only the rows that were fixed prior to execution of the first SELECT or INSERT query in this transaction.
  If read and write operations in a concurrent set of serializable transactions overlap and this may cause an inconsistency that is not possible during the serial transaction execution, then one of the transaction will be rolled back, triggering a serialization failure.

statementTimeout

string (int64)

Sets the maximum allowed duration of any statement. In milliseconds.

lockTimeout

string (int64)

Sets the maximum allowed duration of any wait for a lock. In milliseconds.

idleInTransactionSessionTimeout

string (int64)

Sets the maximum allowed idle time between queries, when in a transaction. In milliseconds.

Acceptable values are 0 to 2147483647, inclusive.

byteaOutput

enum (ByteaOutput)

Sets the output format for bytea.

• BYTEA_OUTPUT_HEX: Each byte is represented by two hexadecimal characters, e.g., 'SELECT '\xDEADBEEF';'.
• BYTEA_OUTPUT_ESCAPED: Standard PostgreSQL format with ASCII characters only.

xmlbinary

enum (XmlBinary)

Sets how binary values are to be encoded in XML.

• XML_BINARY_BASE64: Encodes binary values using Base64.
• XML_BINARY_HEX: Encodes binary values using hexadecimal notation.

xmloption

enum (XmlOption)

Sets whether XML data in implicit parsing and serialization operations is to be considered as documents or content fragments.

• XML_OPTION_DOCUMENT: Treats an XML value as a complete, well-formed document.
• XML_OPTION_CONTENT: Treats an XML value as a content fragment, which may contain multiple top-level elements or character nodes.

ginPendingListLimit

string (int64)

Sets the maximum size of the pending list for GIN index. In bytes.

deadlockTimeout

string (int64)

Sets the time to wait on a lock before checking for deadlock. In milliseconds.

Acceptable values are 1 to 2147483647, inclusive.

maxLocksPerTransaction

string (int64)

Sets the maximum number of locks per transaction. The shared lock table is sized on the assumption that
at most max_locks_per_transaction * max_connections distinct objects will need to be locked at any one time.

maxPredLocksPerTransaction

string (int64)

Sets the maximum number of predicate locks per transaction.The shared predicate lock table is sized on the assumption that
at most max_pred_locks_per_transaction * max_connections distinct objects will need to be locked at any one time.

arrayNulls

boolean

Enable input of NULL elements in arrays. When turned on, unquoted NULL in an array input
value means a null value; otherwise it is taken literally.

backslashQuote

enum (BackslashQuote)

Sets whether "\'" is allowed in string literals.

• BACKSLASH_QUOTE: Legacy invalid value. Do not use.
• BACKSLASH_QUOTE_ON: Quotation mark can be represented as '.
• BACKSLASH_QUOTE_OFF: Quotation mark can only be represented using the standard SQL syntax ''.
• BACKSLASH_QUOTE_SAFE_ENCODING: Representing a quotation mark as ' is only permitted for client encodings where \ is not used for multibyte characters.

defaultWithOids

boolean

WITH OIDS is no longer supported; this can only be false.

escapeStringWarning

boolean

Warn about backslash escapes in ordinary string literals.

loCompatPrivileges

boolean

Enables backward compatibility mode for privilege checks on large objects. Skips privilege checks
when reading or modifying large objects, for compatibility with PostgreSQL releases prior to 9.0.

operatorPrecedenceWarning

boolean

Emit a warning for constructs that changed meaning since PostgreSQL 9.4.

quoteAllIdentifiers

boolean

When generating SQL fragments, quote all identifiers.

standardConformingStrings

boolean

Causes '...' strings to treat backslashes literally.

synchronizeSeqscans

boolean

Enable synchronized sequential scans.

transformNullEquals

boolean

Treats "expr=NULL" as "expr IS NULL". When turned on, expressions of the form expr = NULL
(or NULL = expr) are treated as expr IS NULL, that is, they return true if expr evaluates to the
null value, and false otherwise. The correct behavior of expr = NULL is to always return null (unknown).

exitOnError

boolean

Terminate session on any error.

seqPageCost

number (double)

Sets the planner's estimate of the cost of a sequentially fetched disk page.

The minimum value is 0.

randomPageCost

number (double)

Sets the planner's estimate of the cost of a nonsequentially fetched disk page.

The minimum value is 0.

enableBitmapscan

boolean

Enables the planner's use of bitmap-scan plans.

enableHashagg

boolean

Enables the planner's use of hashed aggregation plans.

enableHashjoin

boolean

Enables the planner's use of hash join plans.

enableIndexscan

boolean

Enables the planner's use of index-scan plans.

enableIndexonlyscan

boolean

Enables the planner's use of index-only-scan plans.

enableMaterial

boolean

Enables the planner's use of materialization.

enableMergejoin

boolean

Enables the planner's use of merge join plans.

enableNestloop

boolean

Enables the planner's use of nested-loop join plans.

enableSeqscan

boolean

Enables the planner's use of sequential-scan plans.

enableSort

boolean

Enables the planner's use of explicit sort steps.

enableTidscan

boolean

Enables the planner's use of TID scan plans.

maxParallelWorkers

string (int64)

Sets the maximum number of parallel workers that can be active at one time.

Acceptable values are 0 to 1024, inclusive.

maxParallelWorkersPerGather

string (int64)

Sets the maximum number of parallel processes per executor node.

Acceptable values are 0 to 1024, inclusive.

timezone

string

Sets the time zone for displaying and interpreting time stamps.

effectiveIoConcurrency

string (int64)

Number of simultaneous requests that can be handled efficiently by the disk subsystem.

Acceptable values are 0 to 1000, inclusive.

effectiveCacheSize

string (int64)

Sets the planner's assumption about the effective size of the disk cache available to a single query. In bytes.

Acceptable values are 1048576 to 549755813888, inclusive.

Field

Description

recoveryMinApplyDelay

string (int64)

Sets the minimum delay for applying changes during recovery. In milliseconds.

sharedBuffers

string (int64)

Sets the number of shared memory buffers used by the server. In bytes.

tempBuffers

string (int64)

Sets the maximum number of temporary buffers used by each session. In bytes.

workMem

string (int64)

Sets the maximum memory to be used for query workspaces. This much memory can be used by each
internal sort operation and hash table before switching to temporary disk files. In bytes.

tempFileLimit

string (int64)

Limits the total size of all temporary files used by each process. -1 means no limit. In bytes.

backendFlushAfter

string (int64)

Specifies how much data a backend can write before forcing the operating system to issue the writes. In bytes.

Acceptable values are 0 to 2097152, inclusive.

oldSnapshotThreshold

string (int64)

Time before a snapshot is too old to read pages changed after the snapshot was taken.
A value of -1 disables this feature. In milliseconds.

maxStandbyStreamingDelay

string (int64)

Sets the maximum delay before canceling queries when a hot standby server is processing streamed WAL data. In milliseconds.

constraintExclusion

enum (ConstraintExclusion)

Enables the planner to use constraints to optimize queries.

• CONSTRAINT_EXCLUSION_ON: Enable planner's use of constraints for all tables.
• CONSTRAINT_EXCLUSION_OFF: Disable planner's use of constraints for all tables
• CONSTRAINT_EXCLUSION_PARTITION: Only use constraints for child tables and UNION ALL clauses.

cursorTupleFraction

number (double)

Sets the planner's estimate of the fraction of a cursor's rows that will be retrieved.

fromCollapseLimit

string (int64)

Sets the FROM-list size beyond which subqueries are not collapsed.

Acceptable values are 1 to 2147483647, inclusive.

joinCollapseLimit

string (int64)

Sets the FROM-list size beyond which JOIN constructs are not flattened.

Acceptable values are 1 to 2147483647, inclusive.

forceParallelMode

enum (ForceParallelMode)

Forces use of parallel query facilities. If possible, run query using a parallel worker and with parallel restrictions.

• FORCE_PARALLEL_MODE_ON: Forces parallel mode for queries considered safe, even when no performance benefit is expected.
• FORCE_PARALLEL_MODE_OFF: Uses parallel mode only when the planner expects it to improve performance.
• FORCE_PARALLEL_MODE_REGRESS: Behaves like ON, but hides added Gather nodes in EXPLAIN output and
  suppresses parallel-worker context lines to stabilize regression-test output.

clientMinMessages

enum (LogLevel)

Sets the message levels that are sent to the client.

• LOG_LEVEL_DEBUG5: Provides the most detailed diagnostic information for developers.
• LOG_LEVEL_DEBUG4: Provides more detailed diagnostic information than DEBUG3.
• LOG_LEVEL_DEBUG3: Provides more detailed diagnostic information than DEBUG2.
• LOG_LEVEL_DEBUG2: Provides more detailed diagnostic information than DEBUG1.
• LOG_LEVEL_DEBUG1: Provides diagnostic information for developers.
• LOG_LEVEL_LOG: Reports information of interest to database administrators.
• LOG_LEVEL_NOTICE: Reports information that may be helpful to users.
• LOG_LEVEL_WARNING: Reports a warning about a likely problem.
• LOG_LEVEL_ERROR: Reports an error that aborts the current command.
• LOG_LEVEL_FATAL: Reports an error that aborts the current session.
• LOG_LEVEL_PANIC: Reports an error that aborts all database sessions.

logMinMessages

enum (LogLevel)

Sets the message levels that are logged.

• LOG_LEVEL_DEBUG5: Provides the most detailed diagnostic information for developers.
• LOG_LEVEL_DEBUG4: Provides more detailed diagnostic information than DEBUG3.
• LOG_LEVEL_DEBUG3: Provides more detailed diagnostic information than DEBUG2.
• LOG_LEVEL_DEBUG2: Provides more detailed diagnostic information than DEBUG1.
• LOG_LEVEL_DEBUG1: Provides diagnostic information for developers.
• LOG_LEVEL_LOG: Reports information of interest to database administrators.
• LOG_LEVEL_NOTICE: Reports information that may be helpful to users.
• LOG_LEVEL_WARNING: Reports a warning about a likely problem.
• LOG_LEVEL_ERROR: Reports an error that aborts the current command.
• LOG_LEVEL_FATAL: Reports an error that aborts the current session.
• LOG_LEVEL_PANIC: Reports an error that aborts all database sessions.

logMinErrorStatement

enum (LogLevel)

Causes all statements generating error at or above this level to be logged.

• LOG_LEVEL_DEBUG5: Provides the most detailed diagnostic information for developers.
• LOG_LEVEL_DEBUG4: Provides more detailed diagnostic information than DEBUG3.
• LOG_LEVEL_DEBUG3: Provides more detailed diagnostic information than DEBUG2.
• LOG_LEVEL_DEBUG2: Provides more detailed diagnostic information than DEBUG1.
• LOG_LEVEL_DEBUG1: Provides diagnostic information for developers.
• LOG_LEVEL_LOG: Reports information of interest to database administrators.
• LOG_LEVEL_NOTICE: Reports information that may be helpful to users.
• LOG_LEVEL_WARNING: Reports a warning about a likely problem.
• LOG_LEVEL_ERROR: Reports an error that aborts the current command.
• LOG_LEVEL_FATAL: Reports an error that aborts the current session.
• LOG_LEVEL_PANIC: Reports an error that aborts all database sessions.

logMinDurationStatement

string (int64)

Sets the minimum execution time above which all statements will be logged. In milliseconds.

logCheckpoints

boolean

Logs each checkpoint.

logConnections

boolean

Logs each successful connection.

logDisconnections

boolean

Logs end of a session, including duration.

logDuration

boolean

Logs the duration of each completed SQL statement.

logErrorVerbosity

enum (LogErrorVerbosity)

Sets the verbosity of logged messages.

• LOG_ERROR_VERBOSITY_TERSE: DETAIL, HINT, QUERY, and CONTEXT fields are excluded from the error message.
• LOG_ERROR_VERBOSITY_DEFAULT: Default.
• LOG_ERROR_VERBOSITY_VERBOSE: Error message includes the SQLSTATE error code, source filename, function name, and the line number where the error occurred.

logLockWaits

boolean

Logs long lock waits.

logStatement

enum (LogStatement)

Sets the type of statements logged.

• LOG_STATEMENT_NONE: The filter is disabled, no SQL statements are logged.
• LOG_STATEMENT_DDL: System logs DDL statements, e.g., CREATE, ALTER, DROP etc.
• LOG_STATEMENT_MOD: System logs ddl-statements along with data modification commands, e.g., INSERT, UPDATE, etc.
• LOG_STATEMENT_ALL: System logs all SQL statements.

logTempFiles

string (int64)

Log the use of temporary files larger than this number of kilobytes.

searchPath

string

Sets the schema search order for names that are not schema-qualified.

rowSecurity

boolean

Enable row security.

defaultTransactionIsolation

enum (TransactionIsolation)

Sets the transaction isolation level of each new transaction.

• TRANSACTION_ISOLATION_READ_UNCOMMITTED: This level behaves like TRANSACTION_ISOLATION_READ_COMMITTED in PostgreSQL.
• TRANSACTION_ISOLATION_READ_COMMITTED: On this level query sees only data committed before the query began.
• TRANSACTION_ISOLATION_REPEATABLE_READ: On this level all subsequent queries in a transaction will see the same rows, that were read by the first SELECT or INSERT query in this transaction, unchanged (these rows are locked during the first query).
• TRANSACTION_ISOLATION_SERIALIZABLE: This level provides the strictest transaction isolation.
  All queries in the current transaction see only the rows that were fixed prior to execution of the first SELECT or INSERT query in this transaction.
  If read and write operations in a concurrent set of serializable transactions overlap and this may cause an inconsistency that is not possible during the serial transaction execution, then one of the transaction will be rolled back, triggering a serialization failure.

statementTimeout

string (int64)

Sets the maximum allowed duration of any statement. In milliseconds.

lockTimeout

string (int64)

Sets the maximum allowed duration of any wait for a lock. In milliseconds.

idleInTransactionSessionTimeout

string (int64)

Sets the maximum allowed idle time between queries, when in a transaction. In milliseconds.

Acceptable values are 0 to 2147483647, inclusive.

byteaOutput

enum (ByteaOutput)

Sets the output format for bytea.

• BYTEA_OUTPUT_HEX: Each byte is represented by two hexadecimal characters, e.g., 'SELECT '\xDEADBEEF';'.
• BYTEA_OUTPUT_ESCAPED: Standard PostgreSQL format with ASCII characters only.

xmlbinary

enum (XmlBinary)

Sets how binary values are to be encoded in XML.

• XML_BINARY_BASE64: Encodes binary values using Base64.
• XML_BINARY_HEX: Encodes binary values using hexadecimal notation.

xmloption

enum (XmlOption)

Sets whether XML data in implicit parsing and serialization operations is to be considered as documents or content fragments.

• XML_OPTION_DOCUMENT: Treats an XML value as a complete, well-formed document.
• XML_OPTION_CONTENT: Treats an XML value as a content fragment, which may contain multiple top-level elements or character nodes.

ginPendingListLimit

string (int64)

Sets the maximum size of the pending list for GIN index. In bytes.

deadlockTimeout

string (int64)

Sets the time to wait on a lock before checking for deadlock. In milliseconds.

Acceptable values are 1 to 2147483647, inclusive.

maxLocksPerTransaction

string (int64)

Sets the maximum number of locks per transaction. The shared lock table is sized on the assumption that
at most max_locks_per_transaction * max_connections distinct objects will need to be locked at any one time.

maxPredLocksPerTransaction

string (int64)

Sets the maximum number of predicate locks per transaction.The shared predicate lock table is sized on the assumption that
at most max_pred_locks_per_transaction * max_connections distinct objects will need to be locked at any one time.

arrayNulls

boolean

Enable input of NULL elements in arrays. When turned on, unquoted NULL in an array input
value means a null value; otherwise it is taken literally.

backslashQuote

enum (BackslashQuote)

Sets whether "\'" is allowed in string literals.

• BACKSLASH_QUOTE: Legacy invalid value. Do not use.
• BACKSLASH_QUOTE_ON: Quotation mark can be represented as '.
• BACKSLASH_QUOTE_OFF: Quotation mark can only be represented using the standard SQL syntax ''.
• BACKSLASH_QUOTE_SAFE_ENCODING: Representing a quotation mark as ' is only permitted for client encodings where \ is not used for multibyte characters.

defaultWithOids

boolean

WITH OIDS is no longer supported; this can only be false.

escapeStringWarning

boolean

Warn about backslash escapes in ordinary string literals.

loCompatPrivileges

boolean

Enables backward compatibility mode for privilege checks on large objects. Skips privilege checks
when reading or modifying large objects, for compatibility with PostgreSQL releases prior to 9.0.

operatorPrecedenceWarning

boolean

Emit a warning for constructs that changed meaning since PostgreSQL 9.4.

quoteAllIdentifiers

boolean

When generating SQL fragments, quote all identifiers.

standardConformingStrings

boolean

Causes '...' strings to treat backslashes literally.

synchronizeSeqscans

boolean

Enable synchronized sequential scans.

transformNullEquals

boolean

Treats "expr=NULL" as "expr IS NULL". When turned on, expressions of the form expr = NULL
(or NULL = expr) are treated as expr IS NULL, that is, they return true if expr evaluates to the
null value, and false otherwise. The correct behavior of expr = NULL is to always return null (unknown).

exitOnError

boolean

Terminate session on any error.

seqPageCost

number (double)

Sets the planner's estimate of the cost of a sequentially fetched disk page.

The minimum value is 0.

randomPageCost

number (double)

Sets the planner's estimate of the cost of a nonsequentially fetched disk page.

The minimum value is 0.

enableBitmapscan

boolean

Enables the planner's use of bitmap-scan plans.

enableHashagg

boolean

Enables the planner's use of hashed aggregation plans.

enableHashjoin

boolean

Enables the planner's use of hash join plans.

enableIndexscan

boolean

Enables the planner's use of index-scan plans.

enableIndexonlyscan

boolean

Enables the planner's use of index-only-scan plans.

enableMaterial

boolean

Enables the planner's use of materialization.

enableMergejoin

boolean

Enables the planner's use of merge join plans.

enableNestloop

boolean

Enables the planner's use of nested-loop join plans.

enableSeqscan

boolean

Enables the planner's use of sequential-scan plans.

enableSort

boolean

Enables the planner's use of explicit sort steps.

enableTidscan

boolean

Enables the planner's use of TID scan plans.

maxParallelWorkers

string (int64)

Sets the maximum number of parallel workers that can be active at one time.

Acceptable values are 0 to 1024, inclusive.

maxParallelWorkersPerGather

string (int64)

Sets the maximum number of parallel processes per executor node.

Acceptable values are 0 to 1024, inclusive.

timezone

string

Sets the time zone for displaying and interpreting time stamps.

effectiveIoConcurrency

string (int64)

Number of simultaneous requests that can be handled efficiently by the disk subsystem.

Acceptable values are 0 to 1000, inclusive.

effectiveCacheSize

string (int64)

Sets the planner's assumption about the effective size of the disk cache available to a single query. In bytes.

Acceptable values are 1048576 to 549755813888, inclusive.

Field

Description

recoveryMinApplyDelay

string (int64)

Sets the minimum delay for applying changes during recovery. In milliseconds.

sharedBuffers

string (int64)

Sets the number of shared memory buffers used by the server. In bytes.

tempBuffers

string (int64)

Sets the maximum number of temporary buffers used by each session. In bytes.

workMem

string (int64)

Sets the maximum memory to be used for query workspaces. This much memory can be used by each
internal sort operation and hash table before switching to temporary disk files. In bytes.

tempFileLimit

string (int64)

Limits the total size of all temporary files used by each process. -1 means no limit. In bytes.

backendFlushAfter

string (int64)

Specifies how much data a backend can write before forcing the operating system to issue the writes. In bytes.

Acceptable values are 0 to 2097152, inclusive.

oldSnapshotThreshold

string (int64)

Time before a snapshot is too old to read pages changed after the snapshot was taken.
A value of -1 disables this feature. In milliseconds.

maxStandbyStreamingDelay

string (int64)

Sets the maximum delay before canceling queries when a hot standby server is processing streamed WAL data. In milliseconds.

constraintExclusion

enum (ConstraintExclusion)

Enables the planner to use constraints to optimize queries.

• CONSTRAINT_EXCLUSION_ON: Enable planner's use of constraints for all tables.
• CONSTRAINT_EXCLUSION_OFF: Disable planner's use of constraints for all tables
• CONSTRAINT_EXCLUSION_PARTITION: Only use constraints for child tables and UNION ALL clauses.

cursorTupleFraction

number (double)

Sets the planner's estimate of the fraction of a cursor's rows that will be retrieved.

fromCollapseLimit

string (int64)

Sets the FROM-list size beyond which subqueries are not collapsed.

Acceptable values are 1 to 2147483647, inclusive.

joinCollapseLimit

string (int64)

Sets the FROM-list size beyond which JOIN constructs are not flattened.

Acceptable values are 1 to 2147483647, inclusive.

forceParallelMode

enum (ForceParallelMode)

Forces use of parallel query facilities. If possible, run query using a parallel worker and with parallel restrictions.

• FORCE_PARALLEL_MODE_ON: Forces parallel mode for queries considered safe, even when no performance benefit is expected.
• FORCE_PARALLEL_MODE_OFF: Uses parallel mode only when the planner expects it to improve performance.
• FORCE_PARALLEL_MODE_REGRESS: Behaves like ON, but hides added Gather nodes in EXPLAIN output and
  suppresses parallel-worker context lines to stabilize regression-test output.

clientMinMessages

enum (LogLevel)

Sets the message levels that are sent to the client.

• LOG_LEVEL_DEBUG5: Provides the most detailed diagnostic information for developers.
• LOG_LEVEL_DEBUG4: Provides more detailed diagnostic information than DEBUG3.
• LOG_LEVEL_DEBUG3: Provides more detailed diagnostic information than DEBUG2.
• LOG_LEVEL_DEBUG2: Provides more detailed diagnostic information than DEBUG1.
• LOG_LEVEL_DEBUG1: Provides diagnostic information for developers.
• LOG_LEVEL_LOG: Reports information of interest to database administrators.
• LOG_LEVEL_NOTICE: Reports information that may be helpful to users.
• LOG_LEVEL_WARNING: Reports a warning about a likely problem.
• LOG_LEVEL_ERROR: Reports an error that aborts the current command.
• LOG_LEVEL_FATAL: Reports an error that aborts the current session.
• LOG_LEVEL_PANIC: Reports an error that aborts all database sessions.

logMinMessages

enum (LogLevel)

Sets the message levels that are logged.

• LOG_LEVEL_DEBUG5: Provides the most detailed diagnostic information for developers.
• LOG_LEVEL_DEBUG4: Provides more detailed diagnostic information than DEBUG3.
• LOG_LEVEL_DEBUG3: Provides more detailed diagnostic information than DEBUG2.
• LOG_LEVEL_DEBUG2: Provides more detailed diagnostic information than DEBUG1.
• LOG_LEVEL_DEBUG1: Provides diagnostic information for developers.
• LOG_LEVEL_LOG: Reports information of interest to database administrators.
• LOG_LEVEL_NOTICE: Reports information that may be helpful to users.
• LOG_LEVEL_WARNING: Reports a warning about a likely problem.
• LOG_LEVEL_ERROR: Reports an error that aborts the current command.
• LOG_LEVEL_FATAL: Reports an error that aborts the current session.
• LOG_LEVEL_PANIC: Reports an error that aborts all database sessions.

logMinErrorStatement

enum (LogLevel)

Causes all statements generating error at or above this level to be logged.

• LOG_LEVEL_DEBUG5: Provides the most detailed diagnostic information for developers.
• LOG_LEVEL_DEBUG4: Provides more detailed diagnostic information than DEBUG3.
• LOG_LEVEL_DEBUG3: Provides more detailed diagnostic information than DEBUG2.
• LOG_LEVEL_DEBUG2: Provides more detailed diagnostic information than DEBUG1.
• LOG_LEVEL_DEBUG1: Provides diagnostic information for developers.
• LOG_LEVEL_LOG: Reports information of interest to database administrators.
• LOG_LEVEL_NOTICE: Reports information that may be helpful to users.
• LOG_LEVEL_WARNING: Reports a warning about a likely problem.
• LOG_LEVEL_ERROR: Reports an error that aborts the current command.
• LOG_LEVEL_FATAL: Reports an error that aborts the current session.
• LOG_LEVEL_PANIC: Reports an error that aborts all database sessions.

logMinDurationStatement

string (int64)

Sets the minimum execution time above which all statements will be logged. In milliseconds.

logCheckpoints

boolean

Logs each checkpoint.

logConnections

boolean

Logs each successful connection.

logDisconnections

boolean

Logs end of a session, including duration.

logDuration

boolean

Logs the duration of each completed SQL statement.

logErrorVerbosity

enum (LogErrorVerbosity)

Sets the verbosity of logged messages.

• LOG_ERROR_VERBOSITY_TERSE: DETAIL, HINT, QUERY, and CONTEXT fields are excluded from the error message.
• LOG_ERROR_VERBOSITY_DEFAULT: Default.
• LOG_ERROR_VERBOSITY_VERBOSE: Error message includes the SQLSTATE error code, source filename, function name, and the line number where the error occurred.

logLockWaits

boolean

Logs long lock waits.

logStatement

enum (LogStatement)

Sets the type of statements logged.

• LOG_STATEMENT_NONE: The filter is disabled, no SQL statements are logged.
• LOG_STATEMENT_DDL: System logs DDL statements, e.g., CREATE, ALTER, DROP etc.
• LOG_STATEMENT_MOD: System logs ddl-statements along with data modification commands, e.g., INSERT, UPDATE, etc.
• LOG_STATEMENT_ALL: System logs all SQL statements.

logTempFiles

string (int64)

Log the use of temporary files larger than this number of kilobytes.

searchPath

string

Sets the schema search order for names that are not schema-qualified.

rowSecurity

boolean

Enable row security.

defaultTransactionIsolation

enum (TransactionIsolation)

Sets the transaction isolation level of each new transaction.

• TRANSACTION_ISOLATION_READ_UNCOMMITTED: This level behaves like TRANSACTION_ISOLATION_READ_COMMITTED in PostgreSQL.
• TRANSACTION_ISOLATION_READ_COMMITTED: On this level query sees only data committed before the query began.
• TRANSACTION_ISOLATION_REPEATABLE_READ: On this level all subsequent queries in a transaction will see the same rows, that were read by the first SELECT or INSERT query in this transaction, unchanged (these rows are locked during the first query).
• TRANSACTION_ISOLATION_SERIALIZABLE: This level provides the strictest transaction isolation.
  All queries in the current transaction see only the rows that were fixed prior to execution of the first SELECT or INSERT query in this transaction.
  If read and write operations in a concurrent set of serializable transactions overlap and this may cause an inconsistency that is not possible during the serial transaction execution, then one of the transaction will be rolled back, triggering a serialization failure.

statementTimeout

string (int64)

Sets the maximum allowed duration of any statement. In milliseconds.

lockTimeout

string (int64)

Sets the maximum allowed duration of any wait for a lock. In milliseconds.

idleInTransactionSessionTimeout

string (int64)

Sets the maximum allowed idle time between queries, when in a transaction. In milliseconds.

Acceptable values are 0 to 2147483647, inclusive.

byteaOutput

enum (ByteaOutput)

Sets the output format for bytea.

• BYTEA_OUTPUT_HEX: Each byte is represented by two hexadecimal characters, e.g., 'SELECT '\xDEADBEEF';'.
• BYTEA_OUTPUT_ESCAPED: Standard PostgreSQL format with ASCII characters only.

xmlbinary

enum (XmlBinary)

Sets how binary values are to be encoded in XML.

• XML_BINARY_BASE64: Encodes binary values using Base64.
• XML_BINARY_HEX: Encodes binary values using hexadecimal notation.

xmloption

enum (XmlOption)

Sets whether XML data in implicit parsing and serialization operations is to be considered as documents or content fragments.

• XML_OPTION_DOCUMENT: Treats an XML value as a complete, well-formed document.
• XML_OPTION_CONTENT: Treats an XML value as a content fragment, which may contain multiple top-level elements or character nodes.

ginPendingListLimit

string (int64)

Sets the maximum size of the pending list for GIN index. In bytes.

deadlockTimeout

string (int64)

Sets the time to wait on a lock before checking for deadlock. In milliseconds.

Acceptable values are 1 to 2147483647, inclusive.

maxLocksPerTransaction

string (int64)

Sets the maximum number of locks per transaction. The shared lock table is sized on the assumption that
at most max_locks_per_transaction * max_connections distinct objects will need to be locked at any one time.

maxPredLocksPerTransaction

string (int64)

Sets the maximum number of predicate locks per transaction.The shared predicate lock table is sized on the assumption that
at most max_pred_locks_per_transaction * max_connections distinct objects will need to be locked at any one time.

arrayNulls

boolean

Enable input of NULL elements in arrays. When turned on, unquoted NULL in an array input
value means a null value; otherwise it is taken literally.

backslashQuote

enum (BackslashQuote)

Sets whether "\'" is allowed in string literals.

• BACKSLASH_QUOTE: Legacy invalid value. Do not use.
• BACKSLASH_QUOTE_ON: Quotation mark can be represented as '.
• BACKSLASH_QUOTE_OFF: Quotation mark can only be represented using the standard SQL syntax ''.
• BACKSLASH_QUOTE_SAFE_ENCODING: Representing a quotation mark as ' is only permitted for client encodings where \ is not used for multibyte characters.

defaultWithOids

boolean

WITH OIDS is no longer supported; this can only be false.

escapeStringWarning

boolean

Warn about backslash escapes in ordinary string literals.

loCompatPrivileges

boolean

Enables backward compatibility mode for privilege checks on large objects. Skips privilege checks
when reading or modifying large objects, for compatibility with PostgreSQL releases prior to 9.0.

operatorPrecedenceWarning

boolean

Emit a warning for constructs that changed meaning since PostgreSQL 9.4.

quoteAllIdentifiers

boolean

When generating SQL fragments, quote all identifiers.

standardConformingStrings

boolean

Causes '...' strings to treat backslashes literally.

synchronizeSeqscans

boolean

Enable synchronized sequential scans.

transformNullEquals

boolean

Treats "expr=NULL" as "expr IS NULL". When turned on, expressions of the form expr = NULL
(or NULL = expr) are treated as expr IS NULL, that is, they return true if expr evaluates to the
null value, and false otherwise. The correct behavior of expr = NULL is to always return null (unknown).

exitOnError

boolean

Terminate session on any error.

seqPageCost

number (double)

Sets the planner's estimate of the cost of a sequentially fetched disk page.

The minimum value is 0.

randomPageCost

number (double)

Sets the planner's estimate of the cost of a nonsequentially fetched disk page.

The minimum value is 0.

enableBitmapscan

boolean

Enables the planner's use of bitmap-scan plans.

enableHashagg

boolean

Enables the planner's use of hashed aggregation plans.

enableHashjoin

boolean

Enables the planner's use of hash join plans.

enableIndexscan

boolean

Enables the planner's use of index-scan plans.

enableIndexonlyscan

boolean

Enables the planner's use of index-only-scan plans.

enableMaterial

boolean

Enables the planner's use of materialization.

enableMergejoin

boolean

Enables the planner's use of merge join plans.

enableNestloop

boolean

Enables the planner's use of nested-loop join plans.

enableSeqscan

boolean

Enables the planner's use of sequential-scan plans.

enableSort

boolean

Enables the planner's use of explicit sort steps.

enableTidscan

boolean

Enables the planner's use of TID scan plans.

maxParallelWorkers

string (int64)

Sets the maximum number of parallel workers that can be active at one time.

Acceptable values are 0 to 1024, inclusive.

maxParallelWorkersPerGather

string (int64)

Sets the maximum number of parallel processes per executor node.

Acceptable values are 0 to 1024, inclusive.

timezone

string

Sets the time zone for displaying and interpreting time stamps.

effectiveIoConcurrency

string (int64)

Number of simultaneous requests that can be handled efficiently by the disk subsystem.

Acceptable values are 0 to 1000, inclusive.

effectiveCacheSize

string (int64)

Sets the planner's assumption about the effective size of the disk cache available to a single query. In bytes.

Acceptable values are 1048576 to 549755813888, inclusive.

Field

Description

recoveryMinApplyDelay

string (int64)

Sets the minimum delay for applying changes during recovery. In milliseconds.

sharedBuffers

string (int64)

Sets the number of shared memory buffers used by the server. In bytes.

tempBuffers

string (int64)

Sets the maximum number of temporary buffers used by each session. In bytes.

workMem

string (int64)

Sets the maximum memory to be used for query workspaces. This much memory can be used by each
internal sort operation and hash table before switching to temporary disk files. In bytes.

tempFileLimit

string (int64)

Limits the total size of all temporary files used by each process. -1 means no limit. In bytes.

backendFlushAfter

string (int64)

Specifies how much data a backend can write before forcing the operating system to issue the writes. In bytes.

Acceptable values are 0 to 2097152, inclusive.

oldSnapshotThreshold

string (int64)

Time before a snapshot is too old to read pages changed after the snapshot was taken.
A value of -1 disables this feature. In milliseconds.

maxStandbyStreamingDelay

string (int64)

Sets the maximum delay before canceling queries when a hot standby server is processing streamed WAL data. In milliseconds.

constraintExclusion

enum (ConstraintExclusion)

Enables the planner to use constraints to optimize queries.

• CONSTRAINT_EXCLUSION_ON: Enable planner's use of constraints for all tables.
• CONSTRAINT_EXCLUSION_OFF: Disable planner's use of constraints for all tables
• CONSTRAINT_EXCLUSION_PARTITION: Only use constraints for child tables and UNION ALL clauses.

cursorTupleFraction

number (double)

Sets the planner's estimate of the fraction of a cursor's rows that will be retrieved.

fromCollapseLimit

string (int64)

Sets the FROM-list size beyond which subqueries are not collapsed.

Acceptable values are 1 to 2147483647, inclusive.

joinCollapseLimit

string (int64)

Sets the FROM-list size beyond which JOIN constructs are not flattened.

Acceptable values are 1 to 2147483647, inclusive.

forceParallelMode

enum (ForceParallelMode)

Forces use of parallel query facilities. If possible, run query using a parallel worker and with parallel restrictions.

• FORCE_PARALLEL_MODE_ON: Forces parallel mode for queries considered safe, even when no performance benefit is expected.
• FORCE_PARALLEL_MODE_OFF: Uses parallel mode only when the planner expects it to improve performance.
• FORCE_PARALLEL_MODE_REGRESS: Behaves like ON, but hides added Gather nodes in EXPLAIN output and
  suppresses parallel-worker context lines to stabilize regression-test output.

clientMinMessages

enum (LogLevel)

Sets the message levels that are sent to the client.

• LOG_LEVEL_DEBUG5: Provides the most detailed diagnostic information for developers.
• LOG_LEVEL_DEBUG4: Provides more detailed diagnostic information than DEBUG3.
• LOG_LEVEL_DEBUG3: Provides more detailed diagnostic information than DEBUG2.
• LOG_LEVEL_DEBUG2: Provides more detailed diagnostic information than DEBUG1.
• LOG_LEVEL_DEBUG1: Provides diagnostic information for developers.
• LOG_LEVEL_LOG: Reports information of interest to database administrators.
• LOG_LEVEL_NOTICE: Reports information that may be helpful to users.
• LOG_LEVEL_WARNING: Reports a warning about a likely problem.
• LOG_LEVEL_ERROR: Reports an error that aborts the current command.
• LOG_LEVEL_FATAL: Reports an error that aborts the current session.
• LOG_LEVEL_PANIC: Reports an error that aborts all database sessions.

logMinMessages

enum (LogLevel)

Sets the message levels that are logged.

• LOG_LEVEL_DEBUG5: Provides the most detailed diagnostic information for developers.
• LOG_LEVEL_DEBUG4: Provides more detailed diagnostic information than DEBUG3.
• LOG_LEVEL_DEBUG3: Provides more detailed diagnostic information than DEBUG2.
• LOG_LEVEL_DEBUG2: Provides more detailed diagnostic information than DEBUG1.
• LOG_LEVEL_DEBUG1: Provides diagnostic information for developers.
• LOG_LEVEL_LOG: Reports information of interest to database administrators.
• LOG_LEVEL_NOTICE: Reports information that may be helpful to users.
• LOG_LEVEL_WARNING: Reports a warning about a likely problem.
• LOG_LEVEL_ERROR: Reports an error that aborts the current command.
• LOG_LEVEL_FATAL: Reports an error that aborts the current session.
• LOG_LEVEL_PANIC: Reports an error that aborts all database sessions.

logMinErrorStatement

enum (LogLevel)

Causes all statements generating error at or above this level to be logged.

• LOG_LEVEL_DEBUG5: Provides the most detailed diagnostic information for developers.
• LOG_LEVEL_DEBUG4: Provides more detailed diagnostic information than DEBUG3.
• LOG_LEVEL_DEBUG3: Provides more detailed diagnostic information than DEBUG2.
• LOG_LEVEL_DEBUG2: Provides more detailed diagnostic information than DEBUG1.
• LOG_LEVEL_DEBUG1: Provides diagnostic information for developers.
• LOG_LEVEL_LOG: Reports information of interest to database administrators.
• LOG_LEVEL_NOTICE: Reports information that may be helpful to users.
• LOG_LEVEL_WARNING: Reports a warning about a likely problem.
• LOG_LEVEL_ERROR: Reports an error that aborts the current command.
• LOG_LEVEL_FATAL: Reports an error that aborts the current session.
• LOG_LEVEL_PANIC: Reports an error that aborts all database sessions.

logMinDurationStatement

string (int64)

Sets the minimum execution time above which all statements will be logged. In milliseconds.

logCheckpoints

boolean

Logs each checkpoint.

logConnections

boolean

Logs each successful connection.

logDisconnections

boolean

Logs end of a session, including duration.

logDuration

boolean

Logs the duration of each completed SQL statement.

logErrorVerbosity

enum (LogErrorVerbosity)

Sets the verbosity of logged messages.

• LOG_ERROR_VERBOSITY_TERSE: DETAIL, HINT, QUERY, and CONTEXT fields are excluded from the error message.
• LOG_ERROR_VERBOSITY_DEFAULT: Default.
• LOG_ERROR_VERBOSITY_VERBOSE: Error message includes the SQLSTATE error code, source filename, function name, and the line number where the error occurred.

logLockWaits

boolean

Logs long lock waits.

logStatement

enum (LogStatement)

Sets the type of statements logged.

• LOG_STATEMENT_NONE: The filter is disabled, no SQL statements are logged.
• LOG_STATEMENT_DDL: System logs DDL statements, e.g., CREATE, ALTER, DROP etc.
• LOG_STATEMENT_MOD: System logs ddl-statements along with data modification commands, e.g., INSERT, UPDATE, etc.
• LOG_STATEMENT_ALL: System logs all SQL statements.

logTempFiles

string (int64)

Log the use of temporary files larger than this number of kilobytes.

searchPath

string

Sets the schema search order for names that are not schema-qualified.

rowSecurity

boolean

Enable row security.

defaultTransactionIsolation

enum (TransactionIsolation)

Sets the transaction isolation level of each new transaction.

• TRANSACTION_ISOLATION_READ_UNCOMMITTED: This level behaves like TRANSACTION_ISOLATION_READ_COMMITTED in PostgreSQL.
• TRANSACTION_ISOLATION_READ_COMMITTED: On this level query sees only data committed before the query began.
• TRANSACTION_ISOLATION_REPEATABLE_READ: On this level all subsequent queries in a transaction will see the same rows, that were read by the first SELECT or INSERT query in this transaction, unchanged (these rows are locked during the first query).
• TRANSACTION_ISOLATION_SERIALIZABLE: This level provides the strictest transaction isolation.
  All queries in the current transaction see only the rows that were fixed prior to execution of the first SELECT or INSERT query in this transaction.
  If read and write operations in a concurrent set of serializable transactions overlap and this may cause an inconsistency that is not possible during the serial transaction execution, then one of the transaction will be rolled back, triggering a serialization failure.

statementTimeout

string (int64)

Sets the maximum allowed duration of any statement. In milliseconds.

lockTimeout

string (int64)

Sets the maximum allowed duration of any wait for a lock. In milliseconds.

idleInTransactionSessionTimeout

string (int64)

Sets the maximum allowed idle time between queries, when in a transaction. In milliseconds.

Acceptable values are 0 to 2147483647, inclusive.

byteaOutput

enum (ByteaOutput)

Sets the output format for bytea.

• BYTEA_OUTPUT_HEX: Each byte is represented by two hexadecimal characters, e.g., 'SELECT '\xDEADBEEF';'.
• BYTEA_OUTPUT_ESCAPED: Standard PostgreSQL format with ASCII characters only.

xmlbinary

enum (XmlBinary)

Sets how binary values are to be encoded in XML.

• XML_BINARY_BASE64: Encodes binary values using Base64.
• XML_BINARY_HEX: Encodes binary values using hexadecimal notation.

xmloption

enum (XmlOption)

Sets whether XML data in implicit parsing and serialization operations is to be considered as documents or content fragments.

• XML_OPTION_DOCUMENT: Treats an XML value as a complete, well-formed document.
• XML_OPTION_CONTENT: Treats an XML value as a content fragment, which may contain multiple top-level elements or character nodes.

ginPendingListLimit

string (int64)

Sets the maximum size of the pending list for GIN index. In bytes.

deadlockTimeout

string (int64)

Sets the time to wait on a lock before checking for deadlock. In milliseconds.

Acceptable values are 1 to 2147483647, inclusive.

maxLocksPerTransaction

string (int64)

Sets the maximum number of locks per transaction. The shared lock table is sized on the assumption that
at most max_locks_per_transaction * max_connections distinct objects will need to be locked at any one time.

maxPredLocksPerTransaction

string (int64)

Sets the maximum number of predicate locks per transaction.The shared predicate lock table is sized on the assumption that
at most max_pred_locks_per_transaction * max_connections distinct objects will need to be locked at any one time.

arrayNulls

boolean

Enable input of NULL elements in arrays. When turned on, unquoted NULL in an array input
value means a null value; otherwise it is taken literally.

backslashQuote

enum (BackslashQuote)

Sets whether "\'" is allowed in string literals.

• BACKSLASH_QUOTE: Legacy invalid value. Do not use.
• BACKSLASH_QUOTE_ON: Quotation mark can be represented as '.
• BACKSLASH_QUOTE_OFF: Quotation mark can only be represented using the standard SQL syntax ''.
• BACKSLASH_QUOTE_SAFE_ENCODING: Representing a quotation mark as ' is only permitted for client encodings where \ is not used for multibyte characters.

defaultWithOids

boolean

WITH OIDS is no longer supported; this can only be false.

escapeStringWarning

boolean

Warn about backslash escapes in ordinary string literals.

loCompatPrivileges

boolean

Enables backward compatibility mode for privilege checks on large objects. Skips privilege checks
when reading or modifying large objects, for compatibility with PostgreSQL releases prior to 9.0.

quoteAllIdentifiers

boolean

When generating SQL fragments, quote all identifiers.

standardConformingStrings

boolean

Causes '...' strings to treat backslashes literally.

synchronizeSeqscans

boolean

Enable synchronized sequential scans.

transformNullEquals

boolean

Treats "expr=NULL" as "expr IS NULL". When turned on, expressions of the form expr = NULL
(or NULL = expr) are treated as expr IS NULL, that is, they return true if expr evaluates to the
null value, and false otherwise. The correct behavior of expr = NULL is to always return null (unknown).

exitOnError

boolean

Terminate session on any error.

seqPageCost

number (double)

Sets the planner's estimate of the cost of a sequentially fetched disk page.

The minimum value is 0.

randomPageCost

number (double)

Sets the planner's estimate of the cost of a nonsequentially fetched disk page.

The minimum value is 0.

enableBitmapscan

boolean

Enables the planner's use of bitmap-scan plans.

enableHashagg

boolean

Enables the planner's use of hashed aggregation plans.

enableHashjoin

boolean

Enables the planner's use of hash join plans.

enableIndexscan

boolean

Enables the planner's use of index-scan plans.

enableIndexonlyscan

boolean

Enables the planner's use of index-only-scan plans.

enableMaterial

boolean

Enables the planner's use of materialization.

enableMergejoin

boolean

Enables the planner's use of merge join plans.

enableNestloop

boolean

Enables the planner's use of nested-loop join plans.

enableSeqscan

boolean

Enables the planner's use of sequential-scan plans.

enableSort

boolean

Enables the planner's use of explicit sort steps.

enableTidscan

boolean

Enables the planner's use of TID scan plans.

maxParallelWorkers

string (int64)

Sets the maximum number of parallel workers that can be active at one time.

Acceptable values are 0 to 1024, inclusive.

maxParallelWorkersPerGather

string (int64)

Sets the maximum number of parallel processes per executor node.

Acceptable values are 0 to 1024, inclusive.

timezone

string

Sets the time zone for displaying and interpreting time stamps.

effectiveIoConcurrency

string (int64)

Number of simultaneous requests that can be handled efficiently by the disk subsystem.

Acceptable values are 0 to 1000, inclusive.

effectiveCacheSize

string (int64)

Sets the planner's assumption about the effective size of the disk cache available to a single query. In bytes.

Acceptable values are 1048576 to 549755813888, inclusive.

idleSessionTimeout

string (int64)

Sets the maximum allowed idle time between queries, when not in a transaction. In milliseconds.

Acceptable values are 0 to 2147483647, inclusive.

Field

Description

recoveryMinApplyDelay

string (int64)

Sets the minimum delay for applying changes during recovery. In milliseconds.

sharedBuffers

string (int64)

Sets the number of shared memory buffers used by the server. In bytes.

tempBuffers

string (int64)

Sets the maximum number of temporary buffers used by each session. In bytes.

workMem

string (int64)

Sets the maximum memory to be used for query workspaces. This much memory can be used by each
internal sort operation and hash table before switching to temporary disk files. In bytes.

tempFileLimit

string (int64)

Limits the total size of all temporary files used by each process. -1 means no limit. In bytes.

backendFlushAfter

string (int64)

Specifies how much data a backend can write before forcing the operating system to issue the writes. In bytes.

Acceptable values are 0 to 2097152, inclusive.

oldSnapshotThreshold

string (int64)

Time before a snapshot is too old to read pages changed after the snapshot was taken.
A value of -1 disables this feature. In milliseconds.

maxStandbyStreamingDelay

string (int64)

Sets the maximum delay before canceling queries when a hot standby server is processing streamed WAL data. In milliseconds.

constraintExclusion

enum (ConstraintExclusion)

Enables the planner to use constraints to optimize queries.

• CONSTRAINT_EXCLUSION_ON: Enable planner's use of constraints for all tables.
• CONSTRAINT_EXCLUSION_OFF: Disable planner's use of constraints for all tables
• CONSTRAINT_EXCLUSION_PARTITION: Only use constraints for child tables and UNION ALL clauses.

cursorTupleFraction

number (double)

Sets the planner's estimate of the fraction of a cursor's rows that will be retrieved.

fromCollapseLimit

string (int64)

Sets the FROM-list size beyond which subqueries are not collapsed.

Acceptable values are 1 to 2147483647, inclusive.

joinCollapseLimit

string (int64)

Sets the FROM-list size beyond which JOIN constructs are not flattened.

Acceptable values are 1 to 2147483647, inclusive.

forceParallelMode

enum (ForceParallelMode)

Forces use of parallel query facilities. If possible, run query using a parallel worker and with parallel restrictions.

• FORCE_PARALLEL_MODE_ON: Forces parallel mode for queries considered safe, even when no performance benefit is expected.
• FORCE_PARALLEL_MODE_OFF: Uses parallel mode only when the planner expects it to improve performance.
• FORCE_PARALLEL_MODE_REGRESS: Behaves like ON, but hides added Gather nodes in EXPLAIN output and
  suppresses parallel-worker context lines to stabilize regression-test output.

clientMinMessages

enum (LogLevel)

Sets the message levels that are sent to the client.

• LOG_LEVEL_DEBUG5: Provides the most detailed diagnostic information for developers.
• LOG_LEVEL_DEBUG4: Provides more detailed diagnostic information than DEBUG3.
• LOG_LEVEL_DEBUG3: Provides more detailed diagnostic information than DEBUG2.
• LOG_LEVEL_DEBUG2: Provides more detailed diagnostic information than DEBUG1.
• LOG_LEVEL_DEBUG1: Provides diagnostic information for developers.
• LOG_LEVEL_LOG: Reports information of interest to database administrators.
• LOG_LEVEL_NOTICE: Reports information that may be helpful to users.
• LOG_LEVEL_WARNING: Reports a warning about a likely problem.
• LOG_LEVEL_ERROR: Reports an error that aborts the current command.
• LOG_LEVEL_FATAL: Reports an error that aborts the current session.
• LOG_LEVEL_PANIC: Reports an error that aborts all database sessions.