Method update

Updates the specified PostgreSQL cluster.

HTTP request

PATCH https://mdb.api.cloud.yandex.net/managed-postgresql/v1/clusters/{clusterId}

Path parameters

Parameter Description
clusterId Required. ID of the PostgreSQL Cluster resource to update. To get the PostgreSQL cluster ID, use a list request. The maximum string length in characters is 50.

Body parameters

{
  "updateMask": "string",
  "description": "string",
  "labels": "object",
  "configSpec": {
    "version": "string",
    "poolerConfig": {
      "poolingMode": "string",
      "poolDiscard": true
    },
    "resources": {
      "resourcePresetId": "string",
      "diskSize": "string",
      "diskTypeId": "string"
    },
    "autofailover": true,
    "backupWindowStart": {
      "hours": "integer",
      "minutes": "integer",
      "seconds": "integer",
      "nanos": "integer"
    },
    "access": {
      "dataLens": true
    },

    // `configSpec` includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10`, `postgresqlConfig_11`
    "postgresqlConfig_9_6": {
      "maxConnections": "integer",
      "sharedBuffers": "integer",
      "tempBuffers": "integer",
      "maxPreparedTransactions": "integer",
      "workMem": "integer",
      "maintenanceWorkMem": "integer",
      "replacementSortTuples": "integer",
      "autovacuumWorkMem": "integer",
      "tempFileLimit": "integer",
      "vacuumCostDelay": "integer",
      "vacuumCostPageHit": "integer",
      "vacuumCostPageMiss": "integer",
      "vacuumCostPageDirty": "integer",
      "vacuumCostLimit": "integer",
      "bgwriterDelay": "integer",
      "bgwriterLruMaxpages": "integer",
      "bgwriterLruMultiplier": "number",
      "bgwriterFlushAfter": "integer",
      "backendFlushAfter": "integer",
      "oldSnapshotThreshold": "integer",
      "walLevel": "string",
      "synchronousCommit": "string",
      "checkpointTimeout": "integer",
      "checkpointCompletionTarget": "number",
      "checkpointFlushAfter": "integer",
      "maxWalSize": "integer",
      "minWalSize": "integer",
      "maxStandbyStreamingDelay": "integer",
      "defaultStatisticsTarget": "integer",
      "constraintExclusion": "string",
      "cursorTupleFraction": "number",
      "fromCollapseLimit": "integer",
      "joinCollapseLimit": "integer",
      "forceParallelMode": "string",
      "clientMinMessages": "string",
      "logMinMessages": "string",
      "logMinErrorStatement": "string",
      "logMinDurationStatement": "integer",
      "logCheckpoints": true,
      "logConnections": true,
      "logDisconnections": true,
      "logDuration": true,
      "logErrorVerbosity": "string",
      "logLockWaits": true,
      "logStatement": "string",
      "logTempFiles": "integer",
      "searchPath": "string",
      "rowSecurity": true,
      "defaultTransactionIsolation": "string",
      "statementTimeout": "integer",
      "lockTimeout": "integer",
      "idleInTransactionSessionTimeout": "integer",
      "byteaOutput": "string",
      "xmlbinary": "string",
      "xmloption": "string",
      "ginPendingListLimit": "integer",
      "deadlockTimeout": "integer",
      "maxLocksPerTransaction": "integer",
      "maxPredLocksPerTransaction": "integer",
      "arrayNulls": true,
      "backslashQuote": "string",
      "defaultWithOids": true,
      "escapeStringWarning": true,
      "loCompatPrivileges": true,
      "operatorPrecedenceWarning": true,
      "quoteAllIdentifiers": true,
      "standardConformingStrings": true,
      "synchronizeSeqscans": true,
      "transformNullEquals": true,
      "exitOnError": true,
      "seqPageCost": "number",
      "randomPageCost": "number",
      "sqlInheritance": true,
      "autovacuumMaxWorkers": "integer",
      "autovacuumVacuumCostDelay": "integer",
      "autovacuumVacuumCostLimit": "integer",
      "autovacuumNaptime": "integer",
      "archiveTimeout": "integer",
      "trackActivityQuerySize": "integer"
    },
    "postgresqlConfig_10": {
      "maxConnections": "integer",
      "sharedBuffers": "integer",
      "tempBuffers": "integer",
      "maxPreparedTransactions": "integer",
      "workMem": "integer",
      "maintenanceWorkMem": "integer",
      "replacementSortTuples": "integer",
      "autovacuumWorkMem": "integer",
      "tempFileLimit": "integer",
      "vacuumCostDelay": "integer",
      "vacuumCostPageHit": "integer",
      "vacuumCostPageMiss": "integer",
      "vacuumCostPageDirty": "integer",
      "vacuumCostLimit": "integer",
      "bgwriterDelay": "integer",
      "bgwriterLruMaxpages": "integer",
      "bgwriterLruMultiplier": "number",
      "bgwriterFlushAfter": "integer",
      "backendFlushAfter": "integer",
      "oldSnapshotThreshold": "integer",
      "walLevel": "string",
      "synchronousCommit": "string",
      "checkpointTimeout": "integer",
      "checkpointCompletionTarget": "number",
      "checkpointFlushAfter": "integer",
      "maxWalSize": "integer",
      "minWalSize": "integer",
      "maxStandbyStreamingDelay": "integer",
      "defaultStatisticsTarget": "integer",
      "constraintExclusion": "string",
      "cursorTupleFraction": "number",
      "fromCollapseLimit": "integer",
      "joinCollapseLimit": "integer",
      "forceParallelMode": "string",
      "clientMinMessages": "string",
      "logMinMessages": "string",
      "logMinErrorStatement": "string",
      "logMinDurationStatement": "integer",
      "logCheckpoints": true,
      "logConnections": true,
      "logDisconnections": true,
      "logDuration": true,
      "logErrorVerbosity": "string",
      "logLockWaits": true,
      "logStatement": "string",
      "logTempFiles": "integer",
      "searchPath": "string",
      "rowSecurity": true,
      "defaultTransactionIsolation": "string",
      "statementTimeout": "integer",
      "lockTimeout": "integer",
      "idleInTransactionSessionTimeout": "integer",
      "byteaOutput": "string",
      "xmlbinary": "string",
      "xmloption": "string",
      "ginPendingListLimit": "integer",
      "deadlockTimeout": "integer",
      "maxLocksPerTransaction": "integer",
      "maxPredLocksPerTransaction": "integer",
      "arrayNulls": true,
      "backslashQuote": "string",
      "defaultWithOids": true,
      "escapeStringWarning": true,
      "loCompatPrivileges": true,
      "operatorPrecedenceWarning": true,
      "quoteAllIdentifiers": true,
      "standardConformingStrings": true,
      "synchronizeSeqscans": true,
      "transformNullEquals": true,
      "exitOnError": true,
      "seqPageCost": "number",
      "randomPageCost": "number",
      "autovacuumMaxWorkers": "integer",
      "autovacuumVacuumCostDelay": "integer",
      "autovacuumVacuumCostLimit": "integer",
      "autovacuumNaptime": "integer",
      "archiveTimeout": "integer",
      "trackActivityQuerySize": "integer",
      "enableBitmapscan": true,
      "enableHashagg": true,
      "enableHashjoin": true,
      "enableIndexscan": true,
      "enableIndexonlyscan": true,
      "enableMaterial": true,
      "enableMergejoin": true,
      "enableNestloop": true,
      "enableSeqscan": true,
      "enableSort": true,
      "enableTidscan": true,
      "maxWorkerProcesses": "integer",
      "maxParallelWorkers": "integer",
      "maxParallelWorkersPerGather": "integer",
      "autovacuumVacuumScaleFactor": "number",
      "autovacuumAnalyzeScaleFactor": "number",
      "defaultTransactionReadOnly": true,
      "timezone": "string"
    },
    "postgresqlConfig_11": {
      "maxConnections": "integer",
      "sharedBuffers": "integer",
      "tempBuffers": "integer",
      "maxPreparedTransactions": "integer",
      "workMem": "integer",
      "maintenanceWorkMem": "integer",
      "autovacuumWorkMem": "integer",
      "tempFileLimit": "integer",
      "vacuumCostDelay": "integer",
      "vacuumCostPageHit": "integer",
      "vacuumCostPageMiss": "integer",
      "vacuumCostPageDirty": "integer",
      "vacuumCostLimit": "integer",
      "bgwriterDelay": "integer",
      "bgwriterLruMaxpages": "integer",
      "bgwriterLruMultiplier": "number",
      "bgwriterFlushAfter": "integer",
      "backendFlushAfter": "integer",
      "oldSnapshotThreshold": "integer",
      "walLevel": "string",
      "synchronousCommit": "string",
      "checkpointTimeout": "integer",
      "checkpointCompletionTarget": "number",
      "checkpointFlushAfter": "integer",
      "maxWalSize": "integer",
      "minWalSize": "integer",
      "maxStandbyStreamingDelay": "integer",
      "defaultStatisticsTarget": "integer",
      "constraintExclusion": "string",
      "cursorTupleFraction": "number",
      "fromCollapseLimit": "integer",
      "joinCollapseLimit": "integer",
      "forceParallelMode": "string",
      "clientMinMessages": "string",
      "logMinMessages": "string",
      "logMinErrorStatement": "string",
      "logMinDurationStatement": "integer",
      "logCheckpoints": true,
      "logConnections": true,
      "logDisconnections": true,
      "logDuration": true,
      "logErrorVerbosity": "string",
      "logLockWaits": true,
      "logStatement": "string",
      "logTempFiles": "integer",
      "searchPath": "string",
      "rowSecurity": true,
      "defaultTransactionIsolation": "string",
      "statementTimeout": "integer",
      "lockTimeout": "integer",
      "idleInTransactionSessionTimeout": "integer",
      "byteaOutput": "string",
      "xmlbinary": "string",
      "xmloption": "string",
      "ginPendingListLimit": "integer",
      "deadlockTimeout": "integer",
      "maxLocksPerTransaction": "integer",
      "maxPredLocksPerTransaction": "integer",
      "arrayNulls": true,
      "backslashQuote": "string",
      "defaultWithOids": true,
      "escapeStringWarning": true,
      "loCompatPrivileges": true,
      "operatorPrecedenceWarning": true,
      "quoteAllIdentifiers": true,
      "standardConformingStrings": true,
      "synchronizeSeqscans": true,
      "transformNullEquals": true,
      "exitOnError": true,
      "seqPageCost": "number",
      "randomPageCost": "number",
      "autovacuumMaxWorkers": "integer",
      "autovacuumVacuumCostDelay": "integer",
      "autovacuumVacuumCostLimit": "integer",
      "autovacuumNaptime": "integer",
      "archiveTimeout": "integer",
      "trackActivityQuerySize": "integer",
      "enableBitmapscan": true,
      "enableHashagg": true,
      "enableHashjoin": true,
      "enableIndexscan": true,
      "enableIndexonlyscan": true,
      "enableMaterial": true,
      "enableMergejoin": true,
      "enableNestloop": true,
      "enableSeqscan": true,
      "enableSort": true,
      "enableTidscan": true,
      "maxWorkerProcesses": "integer",
      "maxParallelWorkers": "integer",
      "maxParallelWorkersPerGather": "integer",
      "autovacuumVacuumScaleFactor": "number",
      "autovacuumAnalyzeScaleFactor": "number",
      "defaultTransactionReadOnly": true,
      "timezone": "string",
      "enableParallelAppend": true,
      "enableParallelHash": true,
      "enablePartitionPruning": true,
      "enablePartitionwiseAggregate": true,
      "enablePartitionwiseJoin": true,
      "jit": true,
      "maxParallelMaintenanceWorkers": "integer",
      "parallelLeaderParticipation": true,
      "vacuumCleanupIndexScaleFactor": "number"
    },
    // end of the list of possible fields`configSpec`

  },
  "name": "string"
}
Field Description
updateMask string

Field mask that specifies which fields of the PostgreSQL Cluster resource should be updated.

A comma-separated names off ALL fields to be updated. Оnly the specified fields will be changed. The others will be left untouched. If the field is specified in updateMask and no value for that field was sent in the request, the field's value will be reset to the default. The default value for most fields is null or 0.

If updateMask is not sent in the request, all fields' values will be updated. Fields specified in the request will be updated to provided values. The rest of the fields will be reset to the default.

description string

New description of the PostgreSQL cluster.

The maximum string length in characters is 256.

labels object

Custom labels for the PostgreSQL cluster as key:value pairs. Maximum 64 per resource. For example, "project": "mvp" or "source": "dictionary".

The new set of labels will completely replace the old ones. To add a label, request the current set with the get method, then send an update request with the new label added to the set.

No more than 64 per resource. The maximum string length in characters for each key is 63. Each key must match the regular expression [a-z][-_0-9a-z]. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_0-9a-z].

configSpec object

New configuration and resources for hosts in the cluster.

configSpec.
version
string

Version of PostgreSQL used in the cluster. Possible values:

  • 9.6
  • 10
  • 11
configSpec.
poolerConfig
object
Configuration of the connection pooler.
configSpec.
poolerConfig.
poolingMode
string

Mode that the connection pooler is working in. See descriptions of all modes in the documentation for PgBouncer.

  • SESSION: Session pooling mode.
  • TRANSACTION: Transaction pooling mode.
  • STATEMENT: Statement pooling mode.
configSpec.
poolerConfig.
poolDiscard
boolean (boolean)

Setting pool_discard in Odyssey; server_reset_query_always in PgBouncer

configSpec.
resources
object
Resources allocated to PostgreSQL hosts.
configSpec.
resources.
resourcePresetId
string

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

configSpec.
resources.
diskSize
string (int64)

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

configSpec.
resources.
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.
configSpec.
autofailover
boolean (boolean)

Configuration setting which enables/disables autofailover in cluster.

configSpec.
backupWindowStart
object
Time to start the daily backup, in the UTC timezone.

Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and google.protobuf.Timestamp.

configSpec.
backupWindowStart.
hours
integer (int32)

Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.

configSpec.
backupWindowStart.
minutes
integer (int32)

Minutes of hour of day. Must be from 0 to 59.

configSpec.
backupWindowStart.
seconds
integer (int32)

Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.

configSpec.
backupWindowStart.
nanos
integer (int32)

Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

configSpec.
access
object
Access policy to DB
configSpec.
access.
dataLens
boolean (boolean)

Allow access for DataLens

configSpec.
postgresqlConfig_9_6
object
Configuration for a PostgreSQL 9.6 cluster.
configSpec includes only one of the fields postgresqlConfig_9_6, postgresqlConfig_10, postgresqlConfig_11

Options and structure of PostgresqlConfig reflects PostgreSQL configuration file parameters whose detailed description is available in PostgreSQL documentation.

configSpec.
postgresqlConfig_9_6.
maxConnections
integer (int64)
configSpec.
postgresqlConfig_9_6.
sharedBuffers
integer (int64)
configSpec.
postgresqlConfig_9_6.
tempBuffers
integer (int64)
configSpec.
postgresqlConfig_9_6.
maxPreparedTransactions
integer (int64)
configSpec.
postgresqlConfig_9_6.
workMem
integer (int64)
configSpec.
postgresqlConfig_9_6.
maintenanceWorkMem
integer (int64)
configSpec.
postgresqlConfig_9_6.
replacementSortTuples
integer (int64)
configSpec.
postgresqlConfig_9_6.
autovacuumWorkMem
integer (int64)
configSpec.
postgresqlConfig_9_6.
tempFileLimit
integer (int64)
configSpec.
postgresqlConfig_9_6.
vacuumCostDelay
integer (int64)
configSpec.
postgresqlConfig_9_6.
vacuumCostPageHit
integer (int64)
configSpec.
postgresqlConfig_9_6.
vacuumCostPageMiss
integer (int64)
configSpec.
postgresqlConfig_9_6.
vacuumCostPageDirty
integer (int64)
configSpec.
postgresqlConfig_9_6.
vacuumCostLimit
integer (int64)
configSpec.
postgresqlConfig_9_6.
bgwriterDelay
integer (int64)

Acceptable values are 10 to 10000, inclusive.

configSpec.
postgresqlConfig_9_6.
bgwriterLruMaxpages
integer (int64)
configSpec.
postgresqlConfig_9_6.
bgwriterLruMultiplier
number (double)
configSpec.
postgresqlConfig_9_6.
bgwriterFlushAfter
integer (int64)

Acceptable values are 0 to 2048, inclusive.

configSpec.
postgresqlConfig_9_6.
backendFlushAfter
integer (int64)

Acceptable values are 0 to 2048, inclusive.

configSpec.
postgresqlConfig_9_6.
oldSnapshotThreshold
integer (int64)

Acceptable values are -1 to 86400000, inclusive.

configSpec.
postgresqlConfig_9_6.
walLevel
string
configSpec.
postgresqlConfig_9_6.
synchronousCommit
string
configSpec.
postgresqlConfig_9_6.
checkpointTimeout
integer (int64)

Acceptable values are 30000 to 86400000, inclusive.

configSpec.
postgresqlConfig_9_6.
checkpointCompletionTarget
number (double)
configSpec.
postgresqlConfig_9_6.
checkpointFlushAfter
integer (int64)

Acceptable values are 0 to 2048, inclusive.

configSpec.
postgresqlConfig_9_6.
maxWalSize
integer (int64)
configSpec.
postgresqlConfig_9_6.
minWalSize
integer (int64)
configSpec.
postgresqlConfig_9_6.
maxStandbyStreamingDelay
integer (int64)
configSpec.
postgresqlConfig_9_6.
defaultStatisticsTarget
integer (int64)
configSpec.
postgresqlConfig_9_6.
constraintExclusion
string
configSpec.
postgresqlConfig_9_6.
cursorTupleFraction
number (double)
configSpec.
postgresqlConfig_9_6.
fromCollapseLimit
integer (int64)

Acceptable values are 1 to 2147483647, inclusive.

configSpec.
postgresqlConfig_9_6.
joinCollapseLimit
integer (int64)

Acceptable values are 1 to 2147483647, inclusive.

configSpec.
postgresqlConfig_9_6.
forceParallelMode
string
configSpec.
postgresqlConfig_9_6.
clientMinMessages
string
configSpec.
postgresqlConfig_9_6.
logMinMessages
string
configSpec.
postgresqlConfig_9_6.
logMinErrorStatement
string
configSpec.
postgresqlConfig_9_6.
logMinDurationStatement
integer (int64)
configSpec.
postgresqlConfig_9_6.
logCheckpoints
boolean (boolean)
configSpec.
postgresqlConfig_9_6.
logConnections
boolean (boolean)
configSpec.
postgresqlConfig_9_6.
logDisconnections
boolean (boolean)
configSpec.
postgresqlConfig_9_6.
logDuration
boolean (boolean)
configSpec.
postgresqlConfig_9_6.
logErrorVerbosity
string
configSpec.
postgresqlConfig_9_6.
logLockWaits
boolean (boolean)
configSpec.
postgresqlConfig_9_6.
logStatement
string
configSpec.
postgresqlConfig_9_6.
logTempFiles
integer (int64)
configSpec.
postgresqlConfig_9_6.
searchPath
string
configSpec.
postgresqlConfig_9_6.
rowSecurity
boolean (boolean)
configSpec.
postgresqlConfig_9_6.
defaultTransactionIsolation
string
configSpec.
postgresqlConfig_9_6.
statementTimeout
integer (int64)
configSpec.
postgresqlConfig_9_6.
lockTimeout
integer (int64)
configSpec.
postgresqlConfig_9_6.
idleInTransactionSessionTimeout
integer (int64)
configSpec.
postgresqlConfig_9_6.
byteaOutput
string
configSpec.
postgresqlConfig_9_6.
xmlbinary
string
configSpec.
postgresqlConfig_9_6.
xmloption
string
configSpec.
postgresqlConfig_9_6.
ginPendingListLimit
integer (int64)
configSpec.
postgresqlConfig_9_6.
deadlockTimeout
integer (int64)
configSpec.
postgresqlConfig_9_6.
maxLocksPerTransaction
integer (int64)
configSpec.
postgresqlConfig_9_6.
maxPredLocksPerTransaction
integer (int64)
configSpec.
postgresqlConfig_9_6.
arrayNulls
boolean (boolean)
configSpec.
postgresqlConfig_9_6.
backslashQuote
string
configSpec.
postgresqlConfig_9_6.
defaultWithOids
boolean (boolean)
configSpec.
postgresqlConfig_9_6.
escapeStringWarning
boolean (boolean)
configSpec.
postgresqlConfig_9_6.
loCompatPrivileges
boolean (boolean)
configSpec.
postgresqlConfig_9_6.
operatorPrecedenceWarning
boolean (boolean)
configSpec.
postgresqlConfig_9_6.
quoteAllIdentifiers
boolean (boolean)
configSpec.
postgresqlConfig_9_6.
standardConformingStrings
boolean (boolean)
configSpec.
postgresqlConfig_9_6.
synchronizeSeqscans
boolean (boolean)
configSpec.
postgresqlConfig_9_6.
transformNullEquals
boolean (boolean)
configSpec.
postgresqlConfig_9_6.
exitOnError
boolean (boolean)
configSpec.
postgresqlConfig_9_6.
seqPageCost
number (double)
configSpec.
postgresqlConfig_9_6.
randomPageCost
number (double)
configSpec.
postgresqlConfig_9_6.
sqlInheritance
boolean (boolean)

This option has been removed in PostgreSQL 10.

configSpec.
postgresqlConfig_9_6.
autovacuumMaxWorkers
integer (int64)

Acceptable values are 1 to 32, inclusive.

configSpec.
postgresqlConfig_9_6.
autovacuumVacuumCostDelay
integer (int64)

Acceptable values are -1 to 100, inclusive.

configSpec.
postgresqlConfig_9_6.
autovacuumVacuumCostLimit
integer (int64)

Acceptable values are -1 to 10000, inclusive.

configSpec.
postgresqlConfig_9_6.
autovacuumNaptime
integer (int64)

Acceptable values are 1000 to 86400000, inclusive.

configSpec.
postgresqlConfig_9_6.
archiveTimeout
integer (int64)

Acceptable values are 10000 to 600000, inclusive.

configSpec.
postgresqlConfig_9_6.
trackActivityQuerySize
integer (int64)

Acceptable values are 100 to 102400, inclusive.

configSpec.
postgresqlConfig_10
object
Configuration for a PostgreSQL 10 cluster.
configSpec includes only one of the fields postgresqlConfig_9_6, postgresqlConfig_10, postgresqlConfig_11

Options and structure of PostgresqlConfig reflects PostgreSQL configuration file parameters whose detailed description is available in PostgreSQL documentation.

configSpec.
postgresqlConfig_10.
maxConnections
integer (int64)
configSpec.
postgresqlConfig_10.
sharedBuffers
integer (int64)
configSpec.
postgresqlConfig_10.
tempBuffers
integer (int64)
configSpec.
postgresqlConfig_10.
maxPreparedTransactions
integer (int64)
configSpec.
postgresqlConfig_10.
workMem
integer (int64)
configSpec.
postgresqlConfig_10.
maintenanceWorkMem
integer (int64)
configSpec.
postgresqlConfig_10.
replacementSortTuples
integer (int64)
configSpec.
postgresqlConfig_10.
autovacuumWorkMem
integer (int64)
configSpec.
postgresqlConfig_10.
tempFileLimit
integer (int64)
configSpec.
postgresqlConfig_10.
vacuumCostDelay
integer (int64)
configSpec.
postgresqlConfig_10.
vacuumCostPageHit
integer (int64)
configSpec.
postgresqlConfig_10.
vacuumCostPageMiss
integer (int64)
configSpec.
postgresqlConfig_10.
vacuumCostPageDirty
integer (int64)
configSpec.
postgresqlConfig_10.
vacuumCostLimit
integer (int64)
configSpec.
postgresqlConfig_10.
bgwriterDelay
integer (int64)

Acceptable values are 10 to 10000, inclusive.

configSpec.
postgresqlConfig_10.
bgwriterLruMaxpages
integer (int64)
configSpec.
postgresqlConfig_10.
bgwriterLruMultiplier
number (double)
configSpec.
postgresqlConfig_10.
bgwriterFlushAfter
integer (int64)

Acceptable values are 0 to 2048, inclusive.

configSpec.
postgresqlConfig_10.
backendFlushAfter
integer (int64)

Acceptable values are 0 to 2048, inclusive.

configSpec.
postgresqlConfig_10.
oldSnapshotThreshold
integer (int64)

Acceptable values are -1 to 86400000, inclusive.

configSpec.
postgresqlConfig_10.
walLevel
string
configSpec.
postgresqlConfig_10.
synchronousCommit
string
configSpec.
postgresqlConfig_10.
checkpointTimeout
integer (int64)

Acceptable values are 30000 to 86400000, inclusive.

configSpec.
postgresqlConfig_10.
checkpointCompletionTarget
number (double)
configSpec.
postgresqlConfig_10.
checkpointFlushAfter
integer (int64)

Acceptable values are 0 to 2048, inclusive.

configSpec.
postgresqlConfig_10.
maxWalSize
integer (int64)
configSpec.
postgresqlConfig_10.
minWalSize
integer (int64)
configSpec.
postgresqlConfig_10.
maxStandbyStreamingDelay
integer (int64)
configSpec.
postgresqlConfig_10.
defaultStatisticsTarget
integer (int64)
configSpec.
postgresqlConfig_10.
constraintExclusion
string
configSpec.
postgresqlConfig_10.
cursorTupleFraction
number (double)
configSpec.
postgresqlConfig_10.
fromCollapseLimit
integer (int64)

Acceptable values are 1 to 2147483647, inclusive.

configSpec.
postgresqlConfig_10.
joinCollapseLimit
integer (int64)

Acceptable values are 1 to 2147483647, inclusive.

configSpec.
postgresqlConfig_10.
forceParallelMode
string
configSpec.
postgresqlConfig_10.
clientMinMessages
string
configSpec.
postgresqlConfig_10.
logMinMessages
string
configSpec.
postgresqlConfig_10.
logMinErrorStatement
string
configSpec.
postgresqlConfig_10.
logMinDurationStatement
integer (int64)
configSpec.
postgresqlConfig_10.
logCheckpoints
boolean (boolean)
configSpec.
postgresqlConfig_10.
logConnections
boolean (boolean)
configSpec.
postgresqlConfig_10.
logDisconnections
boolean (boolean)
configSpec.
postgresqlConfig_10.
logDuration
boolean (boolean)
configSpec.
postgresqlConfig_10.
logErrorVerbosity
string
configSpec.
postgresqlConfig_10.
logLockWaits
boolean (boolean)
configSpec.
postgresqlConfig_10.
logStatement
string
configSpec.
postgresqlConfig_10.
logTempFiles
integer (int64)
configSpec.
postgresqlConfig_10.
searchPath
string
configSpec.
postgresqlConfig_10.
rowSecurity
boolean (boolean)
configSpec.
postgresqlConfig_10.
defaultTransactionIsolation
string
configSpec.
postgresqlConfig_10.
statementTimeout
integer (int64)
configSpec.
postgresqlConfig_10.
lockTimeout
integer (int64)
configSpec.
postgresqlConfig_10.
idleInTransactionSessionTimeout
integer (int64)
configSpec.
postgresqlConfig_10.
byteaOutput
string
configSpec.
postgresqlConfig_10.
xmlbinary
string
configSpec.
postgresqlConfig_10.
xmloption
string
configSpec.
postgresqlConfig_10.
ginPendingListLimit
integer (int64)
configSpec.
postgresqlConfig_10.
deadlockTimeout
integer (int64)
configSpec.
postgresqlConfig_10.
maxLocksPerTransaction
integer (int64)
configSpec.
postgresqlConfig_10.
maxPredLocksPerTransaction
integer (int64)
configSpec.
postgresqlConfig_10.
arrayNulls
boolean (boolean)
configSpec.
postgresqlConfig_10.
backslashQuote
string
configSpec.
postgresqlConfig_10.
defaultWithOids
boolean (boolean)
configSpec.
postgresqlConfig_10.
escapeStringWarning
boolean (boolean)
configSpec.
postgresqlConfig_10.
loCompatPrivileges
boolean (boolean)
configSpec.
postgresqlConfig_10.
operatorPrecedenceWarning
boolean (boolean)
configSpec.
postgresqlConfig_10.
quoteAllIdentifiers
boolean (boolean)
configSpec.
postgresqlConfig_10.
standardConformingStrings
boolean (boolean)
configSpec.
postgresqlConfig_10.
synchronizeSeqscans
boolean (boolean)
configSpec.
postgresqlConfig_10.
transformNullEquals
boolean (boolean)
configSpec.
postgresqlConfig_10.
exitOnError
boolean (boolean)
configSpec.
postgresqlConfig_10.
seqPageCost
number (double)
configSpec.
postgresqlConfig_10.
randomPageCost
number (double)
configSpec.
postgresqlConfig_10.
autovacuumMaxWorkers
integer (int64)

Acceptable values are 1 to 32, inclusive.

configSpec.
postgresqlConfig_10.
autovacuumVacuumCostDelay
integer (int64)

Acceptable values are -1 to 100, inclusive.

configSpec.
postgresqlConfig_10.
autovacuumVacuumCostLimit
integer (int64)

Acceptable values are -1 to 10000, inclusive.

configSpec.
postgresqlConfig_10.
autovacuumNaptime
integer (int64)

Acceptable values are 1000 to 86400000, inclusive.

configSpec.
postgresqlConfig_10.
archiveTimeout
integer (int64)

Acceptable values are 10000 to 600000, inclusive.

configSpec.
postgresqlConfig_10.
trackActivityQuerySize
integer (int64)

Acceptable values are 100 to 102400, inclusive.

configSpec.
postgresqlConfig_10.
enableBitmapscan
boolean (boolean)
configSpec.
postgresqlConfig_10.
enableHashagg
boolean (boolean)
configSpec.
postgresqlConfig_10.
enableHashjoin
boolean (boolean)
configSpec.
postgresqlConfig_10.
enableIndexscan
boolean (boolean)
configSpec.
postgresqlConfig_10.
enableIndexonlyscan
boolean (boolean)
configSpec.
postgresqlConfig_10.
enableMaterial
boolean (boolean)
configSpec.
postgresqlConfig_10.
enableMergejoin
boolean (boolean)
configSpec.
postgresqlConfig_10.
enableNestloop
boolean (boolean)
configSpec.
postgresqlConfig_10.
enableSeqscan
boolean (boolean)
configSpec.
postgresqlConfig_10.
enableSort
boolean (boolean)
configSpec.
postgresqlConfig_10.
enableTidscan
boolean (boolean)
configSpec.
postgresqlConfig_10.
maxWorkerProcesses
integer (int64)

Acceptable values are 0 to 1024, inclusive.

configSpec.
postgresqlConfig_10.
maxParallelWorkers
integer (int64)

Acceptable values are 0 to 1024, inclusive.

configSpec.
postgresqlConfig_10.
maxParallelWorkersPerGather
integer (int64)

Acceptable values are 0 to 1024, inclusive.

configSpec.
postgresqlConfig_10.
autovacuumVacuumScaleFactor
number (double)

Acceptable values are 0 to 1, inclusive.

configSpec.
postgresqlConfig_10.
autovacuumAnalyzeScaleFactor
number (double)

Acceptable values are 0 to 1, inclusive.

configSpec.
postgresqlConfig_10.
defaultTransactionReadOnly
boolean (boolean)
configSpec.
postgresqlConfig_10.
timezone
string
configSpec.
postgresqlConfig_11
object
Configuration for a PostgreSQL 11 cluster.
configSpec includes only one of the fields postgresqlConfig_9_6, postgresqlConfig_10, postgresqlConfig_11

Options and structure of PostgresqlConfig reflects PostgreSQL configuration file parameters which detailed description is available in PostgreSQL documentation.

configSpec.
postgresqlConfig_11.
maxConnections
integer (int64)
configSpec.
postgresqlConfig_11.
sharedBuffers
integer (int64)
configSpec.
postgresqlConfig_11.
tempBuffers
integer (int64)
configSpec.
postgresqlConfig_11.
maxPreparedTransactions
integer (int64)
configSpec.
postgresqlConfig_11.
workMem
integer (int64)
configSpec.
postgresqlConfig_11.
maintenanceWorkMem
integer (int64)
configSpec.
postgresqlConfig_11.
autovacuumWorkMem
integer (int64)
configSpec.
postgresqlConfig_11.
tempFileLimit
integer (int64)
configSpec.
postgresqlConfig_11.
vacuumCostDelay
integer (int64)
configSpec.
postgresqlConfig_11.
vacuumCostPageHit
integer (int64)
configSpec.
postgresqlConfig_11.
vacuumCostPageMiss
integer (int64)
configSpec.
postgresqlConfig_11.
vacuumCostPageDirty
integer (int64)
configSpec.
postgresqlConfig_11.
vacuumCostLimit
integer (int64)
configSpec.
postgresqlConfig_11.
bgwriterDelay
integer (int64)

Acceptable values are 10 to 10000, inclusive.

configSpec.
postgresqlConfig_11.
bgwriterLruMaxpages
integer (int64)
configSpec.
postgresqlConfig_11.
bgwriterLruMultiplier
number (double)
configSpec.
postgresqlConfig_11.
bgwriterFlushAfter
integer (int64)

Acceptable values are 0 to 2048, inclusive.

configSpec.
postgresqlConfig_11.
backendFlushAfter
integer (int64)

Acceptable values are 0 to 2048, inclusive.

configSpec.
postgresqlConfig_11.
oldSnapshotThreshold
integer (int64)

Acceptable values are -1 to 86400000, inclusive.

configSpec.
postgresqlConfig_11.
walLevel
string
configSpec.
postgresqlConfig_11.
synchronousCommit
string
configSpec.
postgresqlConfig_11.
checkpointTimeout
integer (int64)

Acceptable values are 30000 to 86400000, inclusive.

configSpec.
postgresqlConfig_11.
checkpointCompletionTarget
number (double)
configSpec.
postgresqlConfig_11.
checkpointFlushAfter
integer (int64)

Acceptable values are 0 to 2048, inclusive.

configSpec.
postgresqlConfig_11.
maxWalSize
integer (int64)
configSpec.
postgresqlConfig_11.
minWalSize
integer (int64)
configSpec.
postgresqlConfig_11.
maxStandbyStreamingDelay
integer (int64)
configSpec.
postgresqlConfig_11.
defaultStatisticsTarget
integer (int64)
configSpec.
postgresqlConfig_11.
constraintExclusion
string
configSpec.
postgresqlConfig_11.
cursorTupleFraction
number (double)
configSpec.
postgresqlConfig_11.
fromCollapseLimit
integer (int64)

Acceptable values are 1 to 2147483647, inclusive.

configSpec.
postgresqlConfig_11.
joinCollapseLimit
integer (int64)

Acceptable values are 1 to 2147483647, inclusive.

configSpec.
postgresqlConfig_11.
forceParallelMode
string
configSpec.
postgresqlConfig_11.
clientMinMessages
string
configSpec.
postgresqlConfig_11.
logMinMessages
string
configSpec.
postgresqlConfig_11.
logMinErrorStatement
string
configSpec.
postgresqlConfig_11.
logMinDurationStatement
integer (int64)
configSpec.
postgresqlConfig_11.
logCheckpoints
boolean (boolean)
configSpec.
postgresqlConfig_11.
logConnections
boolean (boolean)
configSpec.
postgresqlConfig_11.
logDisconnections
boolean (boolean)
configSpec.
postgresqlConfig_11.
logDuration
boolean (boolean)
configSpec.
postgresqlConfig_11.
logErrorVerbosity
string
configSpec.
postgresqlConfig_11.
logLockWaits
boolean (boolean)
configSpec.
postgresqlConfig_11.
logStatement
string
configSpec.
postgresqlConfig_11.
logTempFiles
integer (int64)
configSpec.
postgresqlConfig_11.
searchPath
string
configSpec.
postgresqlConfig_11.
rowSecurity
boolean (boolean)
configSpec.
postgresqlConfig_11.
defaultTransactionIsolation
string
configSpec.
postgresqlConfig_11.
statementTimeout
integer (int64)
configSpec.
postgresqlConfig_11.
lockTimeout
integer (int64)
configSpec.
postgresqlConfig_11.
idleInTransactionSessionTimeout
integer (int64)
configSpec.
postgresqlConfig_11.
byteaOutput
string
configSpec.
postgresqlConfig_11.
xmlbinary
string
configSpec.
postgresqlConfig_11.
xmloption
string
configSpec.
postgresqlConfig_11.
ginPendingListLimit
integer (int64)
configSpec.
postgresqlConfig_11.
deadlockTimeout
integer (int64)
configSpec.
postgresqlConfig_11.
maxLocksPerTransaction
integer (int64)
configSpec.
postgresqlConfig_11.
maxPredLocksPerTransaction
integer (int64)
configSpec.
postgresqlConfig_11.
arrayNulls
boolean (boolean)
configSpec.
postgresqlConfig_11.
backslashQuote
string
configSpec.
postgresqlConfig_11.
defaultWithOids
boolean (boolean)
configSpec.
postgresqlConfig_11.
escapeStringWarning
boolean (boolean)
configSpec.
postgresqlConfig_11.
loCompatPrivileges
boolean (boolean)
configSpec.
postgresqlConfig_11.
operatorPrecedenceWarning
boolean (boolean)
configSpec.
postgresqlConfig_11.
quoteAllIdentifiers
boolean (boolean)
configSpec.
postgresqlConfig_11.
standardConformingStrings
boolean (boolean)
configSpec.
postgresqlConfig_11.
synchronizeSeqscans
boolean (boolean)
configSpec.
postgresqlConfig_11.
transformNullEquals
boolean (boolean)
configSpec.
postgresqlConfig_11.
exitOnError
boolean (boolean)
configSpec.
postgresqlConfig_11.
seqPageCost
number (double)
configSpec.
postgresqlConfig_11.
randomPageCost
number (double)
configSpec.
postgresqlConfig_11.
autovacuumMaxWorkers
integer (int64)

Acceptable values are 1 to 32, inclusive.

configSpec.
postgresqlConfig_11.
autovacuumVacuumCostDelay
integer (int64)

Acceptable values are -1 to 100, inclusive.

configSpec.
postgresqlConfig_11.
autovacuumVacuumCostLimit
integer (int64)

Acceptable values are -1 to 10000, inclusive.

configSpec.
postgresqlConfig_11.
autovacuumNaptime
integer (int64)

Acceptable values are 1000 to 86400000, inclusive.

configSpec.
postgresqlConfig_11.
archiveTimeout
integer (int64)

Acceptable values are 10000 to 600000, inclusive.

configSpec.
postgresqlConfig_11.
trackActivityQuerySize
integer (int64)

Acceptable values are 100 to 102400, inclusive.

configSpec.
postgresqlConfig_11.
enableBitmapscan
boolean (boolean)
configSpec.
postgresqlConfig_11.
enableHashagg
boolean (boolean)
configSpec.
postgresqlConfig_11.
enableHashjoin
boolean (boolean)
configSpec.
postgresqlConfig_11.
enableIndexscan
boolean (boolean)
configSpec.
postgresqlConfig_11.
enableIndexonlyscan
boolean (boolean)
configSpec.
postgresqlConfig_11.
enableMaterial
boolean (boolean)
configSpec.
postgresqlConfig_11.
enableMergejoin
boolean (boolean)
configSpec.
postgresqlConfig_11.
enableNestloop
boolean (boolean)
configSpec.
postgresqlConfig_11.
enableSeqscan
boolean (boolean)
configSpec.
postgresqlConfig_11.
enableSort
boolean (boolean)
configSpec.
postgresqlConfig_11.
enableTidscan
boolean (boolean)
configSpec.
postgresqlConfig_11.
maxWorkerProcesses
integer (int64)

Acceptable values are 0 to 1024, inclusive.

configSpec.
postgresqlConfig_11.
maxParallelWorkers
integer (int64)

Acceptable values are 0 to 1024, inclusive.

configSpec.
postgresqlConfig_11.
maxParallelWorkersPerGather
integer (int64)

Acceptable values are 0 to 1024, inclusive.

configSpec.
postgresqlConfig_11.
autovacuumVacuumScaleFactor
number (double)

Acceptable values are 0 to 1, inclusive.

configSpec.
postgresqlConfig_11.
autovacuumAnalyzeScaleFactor
number (double)

Acceptable values are 0 to 1, inclusive.

configSpec.
postgresqlConfig_11.
defaultTransactionReadOnly
boolean (boolean)
configSpec.
postgresqlConfig_11.
timezone
string
configSpec.
postgresqlConfig_11.
enableParallelAppend
boolean (boolean)
configSpec.
postgresqlConfig_11.
enableParallelHash
boolean (boolean)
configSpec.
postgresqlConfig_11.
enablePartitionPruning
boolean (boolean)
configSpec.
postgresqlConfig_11.
enablePartitionwiseAggregate
boolean (boolean)
configSpec.
postgresqlConfig_11.
enablePartitionwiseJoin
boolean (boolean)
configSpec.
postgresqlConfig_11.
jit
boolean (boolean)
configSpec.
postgresqlConfig_11.
maxParallelMaintenanceWorkers
integer (int64)

The minimum value is 0.

configSpec.
postgresqlConfig_11.
parallelLeaderParticipation
boolean (boolean)
configSpec.
postgresqlConfig_11.
vacuumCleanupIndexScaleFactor
number (double)

Acceptable values are 0 to 10000000000, inclusive.

name string

New name for the cluster.

The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]*.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": true,
  "metadata": "object",

  //  includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": "object",
  // end of the list of possible fields

}

An Operation resource. For more information, see Operation.

Field Description
id string

ID of the operation.

description string

Description of the operation. 0-256 characters long.

createdAt string (date-time)

Creation timestamp.

String in RFC3339 text format.

createdBy string

ID of the user or service account who initiated the operation.

modifiedAt string (date-time)

The time when the Operation resource was last modified.

String in RFC3339 text format.

done boolean (boolean)

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.

metadata object

Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.

error object
The error result of the operation in case of failure or cancellation.
includes only one of the fields error, response

The error result of the operation in case of failure or cancellation.

error.
code
integer (int32)

Error code. An enum value of google.rpc.Code.

error.
message
string

An error message.

error.
details[]
object

A list of messages that carry the error details.

response object
includes only one of the fields error, response

The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any.