scalings
Creates, updates, deletes, gets or lists a scalings resource.
Overview
| Name | scalings |
| Type | Resource |
| Id | clickhouse.clickpipes.scalings |
Fields
The following fields are returned by SELECT queries:
SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
update | update | service_id, click_pipe_id, organization_id | Change scaling settings for the specified ClickPipe. This endpoint supports Kafka, Kinesis, and object storage pipes (S3, GCS, Azure Blob).<br /><br />Note: For database ClickPipes (PostgreSQL, MySQL, MongoDB, BigQuery), use the [Update CDC ClickPipes scaling](#tag/ClickPipes/operation/clickPipeCdcScalingUpdate) endpoint instead. |
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 |
|---|---|---|
click_pipe_id | string (uuid) | ID of the ClickPipe to update scaling settings. (wire: clickPipeId) |
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) |
UPDATE examples
- update
Change scaling settings for the specified ClickPipe. This endpoint supports Kafka, Kinesis, and object storage pipes (S3, GCS, Azure Blob).<br /><br />Note: For database ClickPipes (PostgreSQL, MySQL, MongoDB, BigQuery), use the [Update CDC ClickPipes scaling](#tag/ClickPipes/operation/clickPipeCdcScalingUpdate) endpoint instead.
UPDATE clickhouse.clickpipes.scalings
SET
replicas = {{ replicas }},
concurrency = {{ concurrency }},
replica_cpu_millicores = {{ replica_cpu_millicores }},
replica_memory_gb = {{ replica_memory_gb }}
WHERE
service_id = '{{ service_id }}' --required
AND click_pipe_id = '{{ click_pipe_id }}' --required
AND organization_id = '{{ organization_id }}' --required unless CLICKHOUSE_ORG_ID is set
RETURNING
request_id,
result,
status;