ClickHouse Cloud: Clickhouse Postgres Instance Config Patch

Change some Postgres or PgBouncer settings of a ClickHouse Cloud Postgres service.

Tool ID: clickhouse_postgres_instance_config_patch

Run this action

This action has conditional or dynamic inputs. A static example cannot describe these inputs reliably. Read the live contract before you execute this action:

deepline describe clickhouse_postgres_instance_config_patch --json

Example response

The SDK returns this shape at result.toolResponse.raw. The example values illustrate the response.

{
  "data": {
    "status": 123,
    "requestId": "123e4567-e89b-42d3-a456-426614174000"
  }
}

Use deepline describe clickhouse_postgres_instance_config_patch --json for the latest machine-readable contract.

Input reference

This endpoint is in beta. API contract is stable, and no breaking changes are expected in the future. Update the existing Postgres service and pgBouncer configuration.

Name	Type	Required	Default	Details
`payload.organizationId`	`string`	Yes	—	ID of the organization that owns the Postgres service. Format: `uuid`.
`payload.postgresId`	`string`	Yes	—	ID of the requested Postgres service. Format: `uuid`.
`payload.pgConfig`	`object`	Yes	—	Postgres runtime configuration configuration.
`payload.pgBouncerConfig`	`record`	Yes	—	PgBouncer runtime configuration configuration.

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Provider response payload.
`result.data.status`	`number`	No	—	HTTP status code.
`result.data.requestId`	`string`	No	—	Unique id assigned to every request. UUIDv4 Format: `uuid`.
`result.data.result`	`object`	No	—	—
`result.data.result.pgConfig`	`object`	Yes	—	Postgres runtime configuration configuration.
`result.data.result.pgConfig.max_connections`	`string \| integer`	No	—	Sets the maximum number of concurrent connections to the database server. Minimum: 1.
`result.data.result.pgConfig.default_transaction_isolation`	`"read committed" \| "repeatable read" \| "serializable"`	No	—	Sets the default transaction isolation level for new transactions. Allowed: `read committed`, `repeatable read`, `serializable`.
`result.data.result.pgConfig.ssl_min_protocol_version`	`"TLSv1" \| "TLSv1.1" \| "TLSv1.2" \| "TLSv1.3"`	No	—	Sets the minimum SSL/TLS protocol version allowed for client connections. Allowed: `TLSv1`, `TLSv1.1`, `TLSv1.2`, `TLSv1.3`.
`result.data.result.pgConfig.maintenance_work_mem`	`string \| integer`	No	—	Sets the maximum memory to be used for maintenance operations. Minimum: 64.
`result.data.result.pgConfig.work_mem`	`string \| integer`	No	—	Sets the amount of memory Postgres will use for internal operations like sorting and hashing as part of executing a query. Minimum: 64.
`result.data.result.pgConfig.effective_cache_size`	`string \| integer`	No	—	Sets the planner’s assumption about the total size of data caches. Minimum: 8.
`result.data.result.pgConfig.random_page_cost`	`string \| number`	No	—	Sets the planner’s estimate of the cost of a non-sequentially-fetched disk page. Lower values (1.1-1.5) are better for SSDs. Minimum: 0.
`result.data.result.pgConfig.effective_io_concurrency`	`string \| integer`	No	—	Number of concurrent disk I/O operations the planner expects. Higher values (100-200) benefit SSDs. Minimum: 0.
`result.data.result.pgConfig.max_worker_processes`	`string \| integer`	No	—	Maximum number of background processes the system can support. Includes parallel query workers, logical replication, and more. Minimum: 0.
`result.data.result.pgConfig.max_parallel_workers`	`string \| integer`	No	—	Maximum number of workers that can be used for parallel operations. Cannot exceed max_worker_processes. Minimum: 0.
`result.data.result.pgConfig.max_parallel_workers_per_gather`	`string \| integer`	No	—	Maximum number of parallel workers per executor node for parallel queries. Use 0 to disable parallel queries. Minimum: 0.
`result.data.result.pgConfig.max_parallel_maintenance_workers`	`string \| integer`	No	—	Maximum number of parallel workers for maintenance operations like CREATE INDEX and VACUUM. Minimum: 0.
`result.data.result.pgConfig.statement_timeout`	`string \| integer`	No	—	Abort any statement that runs longer than the specified time. Use 0 to disable. Minimum: 0.
`result.data.result.pgConfig.lock_timeout`	`string \| integer`	No	—	Abort any statement that waits longer than the specified time while attempting to acquire a lock. Use 0 to disable. Minimum: 0.
`result.data.result.pgConfig.idle_session_timeout`	`string \| integer`	No	—	Terminate any session that has been idle for longer than the specified time. Use 0 to disable. Minimum: 0.
`result.data.result.pgConfig.idle_in_transaction_session_timeout`	`string \| integer`	No	—	Terminate any session that has been idle within an open transaction for longer than the specified time. Use 0 to disable. Minimum: 0.
`result.data.result.pgConfig.transaction_timeout`	`string \| integer`	No	—	Terminate any statement that takes more than the specified time, even while active. Use 0 to disable. Minimum: 0.
`result.data.result.pgConfig.wal_sender_timeout`	`string \| integer`	No	—	Terminate replication connections that are inactive for longer than this time. Use 0 to disable. Minimum: 0.
`result.data.result.pgConfig.wal_keep_size`	`string \| integer`	No	—	Minimum size of past WAL files kept in pg_wal for standby servers. Use 0 to disable. Minimum: 0.
`result.data.result.pgConfig.min_wal_size`	`string \| integer`	No	—	Minimum size to shrink the WAL to. WAL files are recycled rather than removed when below this size. Minimum: 32768.
`result.data.result.pgConfig.max_wal_size`	`string \| integer`	No	—	Maximum size WAL can grow between checkpoints. Larger values improve write performance but increase crash recovery time. Minimum: 32768.
`result.data.result.pgConfig.max_slot_wal_keep_size`	`string \| integer`	No	—	Specifies the maximum size of WAL files that replication slots are allowed to retain. Use -1 for unlimited. Minimum: 0.
`result.data.result.pgConfig.wal_compression`	`"off" \| "on" \| "lz4" \| "zstd"`	No	—	Compress full-page writes in WAL. Reduces I/O at the cost of CPU. Options vary by PostgreSQL version. Allowed: `off`, `on`, `lz4`, `zstd`.
`result.data.result.pgConfig.autovacuum_max_workers`	`string \| integer`	No	—	Maximum number of autovacuum worker processes that can run at the same time. Workers share a single cost-limit budget, so raising this alone may not speed up vacuuming. Minimum: 1.
`result.data.result.pgConfig.autovacuum_naptime`	`string \| integer`	No	—	Minimum delay between autovacuum runs. Lower values make autovacuum check for work more frequently. Minimum: 1.
`result.data.result.pgConfig.autovacuum_work_mem`	`string \| integer`	No	—	Maximum memory each autovacuum worker uses to track dead tuples. Higher values reduce repeated index-vacuum passes on large tables. Use -1 to fall back to maintenance_work_mem. Minimum: 1024.
`result.data.result.pgConfig.autovacuum_vacuum_scale_factor`	`string \| number`	No	—	Fraction of a table’s rows that must change before autovacuum runs. Lower values vacuum large tables more frequently. Minimum: 0.
`result.data.result.pgConfig.autovacuum_analyze_scale_factor`	`string \| number`	No	—	Fraction of a table’s rows that must change before autovacuum runs ANALYZE to refresh planner statistics. Minimum: 0.
`result.data.result.pgConfig.autovacuum_vacuum_insert_scale_factor`	`string \| number`	No	—	Fraction of a table’s rows that must be inserted before autovacuum runs. Helps vacuum insert-heavy, rarely-updated tables. Minimum: 0.
`result.data.result.pgConfig.autovacuum_vacuum_cost_limit`	`string \| integer`	No	—	Cost-accounting limit shared across all autovacuum workers before they pause. Use -1 to inherit vacuum_cost_limit. Minimum: 1.
`result.data.result.pgConfig.autovacuum_vacuum_cost_delay`	`string \| integer`	No	—	Time autovacuum sleeps when the cost limit is reached. Lower values speed up vacuuming at the cost of more I/O. Minimum: 0.
`result.data.result.pgBouncerConfig`	`record`	Yes	—	PgBouncer runtime configuration configuration.
`result.data.result.message`	`string`	No	—	Informational message about the configuration update, such as restart requirements.
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

This output schema is too large for an inline display. Read the complete live contract with deepline describe clickhouse_postgres_instance_config_patch --json.

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

​Run this action

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

Example response

Input reference

Output reference

Deepline cost

Related documentation