settings

Creates, updates, deletes, gets or lists a settings resource.

Overview

Name	settings
Type	Resource
Id	clickhouse.clickpipes.settings

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
clickhouse_max_download_threads	integer	Max download threads. Maximum number of concurrent download threads
clickhouse_max_insert_threads	integer	Max insert threads. Maximum number of concurrent insert threads
clickhouse_max_threads	integer	Max threads. Maximum number of concurrent threads for file processing
clickhouse_min_insert_block_size_bytes	integer	Min insert block size bytes. Minimum size of data block for insert (in bytes)
clickhouse_parallel_distributed_insert_select	integer	Parallel distributed insert select. Parallel distributed insert select setting
clickhouse_parallel_view_processing	boolean	parallel view processing. Whether to enable pushing to attached views concurrently instead of sequentially
kafka_read_committed	boolean	Kafka Read Committed. Whether Kafka consumers read only committed messages
object_storage_concurrency	integer	Object storage concurrency. Number of concurrent file processing threads
object_storage_max_file_count	integer	Max file count. Maximum number of files to process in a single insert batch
object_storage_max_insert_bytes	integer	Max insert bytes. Number of bytes to process in a single insert batch
object_storage_polling_interval_ms	integer	Object storage polling interval. Configures the refresh interval for querying continuous ingest for new object storage data
object_storage_use_cluster_function	boolean	use cluster function. Whether to use ClickHouse cluster function for distributed processing
streaming_max_insert_wait_ms	integer	Streaming max insert wait time. Configures the max wait period before inserting data into the ClickHouse.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	service_id, click_pipe_id, organization_id		Returns the advanced settings for the specified ClickPipe.
update	update	service_id, click_pipe_id, organization_id		Update the advanced settings for the specified ClickPipe. Send key-value pairs where values can be strings, numbers, or booleans.

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 settings for. (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)

SELECT examples

get

Returns the advanced settings for the specified ClickPipe.

SELECT
clickhouse_max_download_threads,
clickhouse_max_insert_threads,
clickhouse_max_threads,
clickhouse_min_insert_block_size_bytes,
clickhouse_parallel_distributed_insert_select,
clickhouse_parallel_view_processing,
kafka_read_committed,
object_storage_concurrency,
object_storage_max_file_count,
object_storage_max_insert_bytes,
object_storage_polling_interval_ms,
object_storage_use_cluster_function,
streaming_max_insert_wait_ms
FROM clickhouse.clickpipes.settings
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
;

UPDATE examples

update

Update the advanced settings for the specified ClickPipe. Send key-value pairs where values can be strings, numbers, or booleans.

UPDATE clickhouse.clickpipes.settings
SET 
streaming_max_insert_wait_ms = {{ streaming_max_insert_wait_ms }},
object_storage_concurrency = {{ object_storage_concurrency }},
object_storage_polling_interval_ms = {{ object_storage_polling_interval_ms }},
object_storage_max_insert_bytes = {{ object_storage_max_insert_bytes }},
object_storage_max_file_count = {{ object_storage_max_file_count }},
clickhouse_max_threads = {{ clickhouse_max_threads }},
clickhouse_max_insert_threads = {{ clickhouse_max_insert_threads }},
clickhouse_min_insert_block_size_bytes = {{ clickhouse_min_insert_block_size_bytes }},
clickhouse_max_download_threads = {{ clickhouse_max_download_threads }},
clickhouse_parallel_distributed_insert_select = {{ clickhouse_parallel_distributed_insert_select }},
kafka_read_committed = {{ kafka_read_committed }},
object_storage_use_cluster_function = {{ object_storage_use_cluster_function }},
clickhouse_parallel_view_processing = {{ clickhouse_parallel_view_processing }}
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;