cdc_scalings
Creates, updates, deletes, gets or lists a cdc_scalings resource.
Overview
| Name | cdc_scalings |
| Type | Resource |
| Id | clickhouse.clickpipes.cdc_scalings |
Fields
The following fields are returned by SELECT queries:
- get
| Name | Datatype | Description |
|---|---|---|
replica_cpu_millicores | integer | CPU in millicores for DB ClickPipes. (wire: replicaCpuMillicores) |
replica_memory_gb | number | Memory in GiB for DB ClickPipes. Must be 4× the CPU core count. (wire: replicaMemoryGb) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | service_id, organization_id | Get scaling settings for database ClickPipes (PostgreSQL, MySQL, MongoDB, BigQuery).<br /><br />The infrastructure is shared between all database ClickPipes in the service, both for initial load and CDC. For billing purposes, 2 CPU cores and 8 GB of RAM [correspond](https://clickhouse.com/docs/cloud/manage/billing/overview#clickpipes-for-postgres-cdc) to one compute unit.<br /><br />Note: For Kafka, Kinesis, and object storage pipes (S3, GCS, Azure Blob), see [Get ClickPipe](#tag/ClickPipes/operation/clickPipeGet).<br /><br />This endpoint becomes available once at least one database ClickPipe was provisioned. | |
update | update | service_id, organization_id | Update scaling settings for database ClickPipes (PostgreSQL, MySQL, MongoDB, BigQuery).<br /><br />The infrastructure is shared between all database ClickPipes in the service, both for initial load and CDC. Scaling settings may take a few minutes to fully propagate.<br /><br />For billing purposes, 2 CPU cores and 8 GB of RAM [correspond](https://clickhouse.com/docs/cloud/manage/billing/overview#clickpipes-for-postgres-cdc) to one compute unit. If your organization tier changes, database ClickPipes will be [rescaled](https://clickhouse.com/docs/cloud/manage/billing/overview#compute) appropriately.<br /><br />Note: For Kafka, Kinesis, and object storage pipes (S3, GCS, Azure Blob), see [Get ClickPipe](#tag/ClickPipes/operation/clickPipeGet).<br /><br />This endpoint becomes available once at least one database ClickPipe was provisioned. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
organization_id | string | ClickHouse Cloud organization ID. Resolved from the CLICKHOUSE_ORG_ID environment variable when it is set (x-stackQL-envVar); otherwise it must be supplied on every query as WHERE organization_id = <uuid>. A WHERE value always takes precedence over the environment. (x-stackQL-envVar: CLICKHOUSE_ORG_ID) |
service_id | string (uuid) | ID of the service that owns the ClickPipe. (wire: serviceId) |
SELECT examples
- get
Get scaling settings for database ClickPipes (PostgreSQL, MySQL, MongoDB, BigQuery).<br /><br />The infrastructure is shared between all database ClickPipes in the service, both for initial load and CDC. For billing purposes, 2 CPU cores and 8 GB of RAM [correspond](https://clickhouse.com/docs/cloud/manage/billing/overview#clickpipes-for-postgres-cdc) to one compute unit.<br /><br />Note: For Kafka, Kinesis, and object storage pipes (S3, GCS, Azure Blob), see [Get ClickPipe](#tag/ClickPipes/operation/clickPipeGet).<br /><br />This endpoint becomes available once at least one database ClickPipe was provisioned.
SELECT
replica_cpu_millicores,
replica_memory_gb
FROM clickhouse.clickpipes.cdc_scalings
WHERE service_id = '{{ service_id }}' -- required
AND organization_id = '{{ organization_id }}' -- required unless CLICKHOUSE_ORG_ID is set
;
UPDATE examples
- update
Update scaling settings for database ClickPipes (PostgreSQL, MySQL, MongoDB, BigQuery).<br /><br />The infrastructure is shared between all database ClickPipes in the service, both for initial load and CDC. Scaling settings may take a few minutes to fully propagate.<br /><br />For billing purposes, 2 CPU cores and 8 GB of RAM [correspond](https://clickhouse.com/docs/cloud/manage/billing/overview#clickpipes-for-postgres-cdc) to one compute unit. If your organization tier changes, database ClickPipes will be [rescaled](https://clickhouse.com/docs/cloud/manage/billing/overview#compute) appropriately.<br /><br />Note: For Kafka, Kinesis, and object storage pipes (S3, GCS, Azure Blob), see [Get ClickPipe](#tag/ClickPipes/operation/clickPipeGet).<br /><br />This endpoint becomes available once at least one database ClickPipe was provisioned.
UPDATE clickhouse.clickpipes.cdc_scalings
SET
replica_cpu_millicores = {{ replica_cpu_millicores }},
replica_memory_gb = {{ replica_memory_gb }}
WHERE
service_id = '{{ service_id }}' --required
AND organization_id = '{{ organization_id }}' --required unless CLICKHOUSE_ORG_ID is set
RETURNING
request_id,
result,
status;