Update ClickPipe settings | ClickHouse Docs

PUT/v1/organizations/{organizationId}/services/{serviceId}/clickpipes/{clickPipeId}/settings

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

Authorizations

Authorizationstringheaderrequired
Use key ID and key secret obtained in ClickHouse Cloud console: https://clickhouse.com/docs/cloud/manage/openapi

Path parameters

organizationIdstringrequired
ID of the organization that owns the service.

format: uuid
serviceIdstringrequired
ID of the service that owns the ClickPipe.

format: uuid
clickPipeIdstringrequired
ID of the ClickPipe to update settings for.

format: uuid

Request bodyJSON

streaming_max_insert_wait_msoptionalinteger | null
Streaming max insert wait time. Configures the max wait period before inserting data into the ClickHouse.

maximum: 60000, minimum: 500
Example: 5000
object_storage_concurrencyoptionalinteger | null
Object storage concurrency. Number of concurrent file processing threads

maximum: 35, minimum: 1
Example: 1
object_storage_polling_interval_msoptionalinteger | null
Object storage polling interval. Configures the refresh interval for querying continuous ingest for new object storage data

maximum: 3600000, minimum: 100
Example: 30000
object_storage_max_insert_bytesoptionalinteger | null
Max insert bytes. Number of bytes to process in a single insert batch

maximum: 53687091200, minimum: 10485760
Example: 10737418240
object_storage_max_file_countoptionalinteger | null
Max file count. Maximum number of files to process in a single insert batch

maximum: 10000, minimum: 1
Example: 100
clickhouse_max_threadsoptionalinteger | null
Max threads. Maximum number of concurrent threads for file processing

maximum: 64, minimum: 0
Example: 8
clickhouse_max_insert_threadsoptionalinteger | null
Max insert threads. Maximum number of concurrent insert threads

maximum: 16, minimum: 0
Example: 1
clickhouse_min_insert_block_size_bytesoptionalinteger | null
Min insert block size bytes. Minimum size of data block for insert (in bytes)

maximum: 10737418240, minimum: 0
Example: 1073741824
clickhouse_max_download_threadsoptionalinteger | null
Max download threads. Maximum number of concurrent download threads

maximum: 32, minimum: 0
Example: 4
clickhouse_parallel_distributed_insert_selectoptionalinteger | null
Parallel distributed insert select. Parallel distributed insert select setting

maximum: 2, minimum: 0
Example: 2
kafka_read_committedoptionalboolean
Kafka Read Committed. Whether Kafka consumers read only committed messages

Example: false
object_storage_use_cluster_functionoptionalboolean | null
use cluster function. Whether to use ClickHouse cluster function for distributed processing

Example: true
clickhouse_parallel_view_processingoptionalboolean | null
parallel view processing. Whether to enable pushing to attached views concurrently instead of sequentially

Example: false

Response

JSON

200

Successful response

JSON

statusoptionalnumber
HTTP status code.

Example: 200
requestIdoptionalstring
Unique id assigned to every request. UUIDv4

format: uuid
resultoptionalobject
13 properties
- streaming_max_insert_wait_msoptionalinteger | null
  Streaming max insert wait time. Configures the max wait period before inserting data into the ClickHouse.
  
  maximum: 60000, minimum: 500
  Example: 5000
- object_storage_concurrencyoptionalinteger | null
  Object storage concurrency. Number of concurrent file processing threads
  
  maximum: 35, minimum: 1
  Example: 1
- object_storage_polling_interval_msoptionalinteger | null
  Object storage polling interval. Configures the refresh interval for querying continuous ingest for new object storage data
  
  maximum: 3600000, minimum: 100
  Example: 30000
- object_storage_max_insert_bytesoptionalinteger | null
  Max insert bytes. Number of bytes to process in a single insert batch
  
  maximum: 53687091200, minimum: 10485760
  Example: 10737418240
- object_storage_max_file_countoptionalinteger | null
  Max file count. Maximum number of files to process in a single insert batch
  
  maximum: 10000, minimum: 1
  Example: 100
- clickhouse_max_threadsoptionalinteger | null
  Max threads. Maximum number of concurrent threads for file processing
  
  maximum: 64, minimum: 0
  Example: 8
- clickhouse_max_insert_threadsoptionalinteger | null
  Max insert threads. Maximum number of concurrent insert threads
  
  maximum: 16, minimum: 0
  Example: 1
- clickhouse_min_insert_block_size_bytesoptionalinteger | null
  Min insert block size bytes. Minimum size of data block for insert (in bytes)
  
  maximum: 10737418240, minimum: 0
  Example: 1073741824
- clickhouse_max_download_threadsoptionalinteger | null
  Max download threads. Maximum number of concurrent download threads
  
  maximum: 32, minimum: 0
  Example: 4
- clickhouse_parallel_distributed_insert_selectoptionalinteger | null
  Parallel distributed insert select. Parallel distributed insert select setting
  
  maximum: 2, minimum: 0
  Example: 2
- kafka_read_committedoptionalboolean
  Kafka Read Committed. Whether Kafka consumers read only committed messages
  
  Example: false
- object_storage_use_cluster_functionoptionalboolean | null
  use cluster function. Whether to use ClickHouse cluster function for distributed processing
  
  Example: true
- clickhouse_parallel_view_processingoptionalboolean | null
  parallel view processing. Whether to enable pushing to attached views concurrently instead of sequentially
  
  Example: false

Update ClickPipe settings

curl --request PUT \
  --url https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/services/497f6eca-6276-4993-bfeb-53cbbbba6f08/clickpipes/497f6eca-6276-4993-bfeb-53cbbbba6f08/settings \
  --header 'Authorization: Basic <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "streaming_max_insert_wait_ms": 5000,
  "object_storage_concurrency": 1,
  "object_storage_polling_interval_ms": 30000,
  "object_storage_max_insert_bytes": 10737418240,
  "object_storage_max_file_count": 100,
  "clickhouse_max_threads": 8,
  "clickhouse_max_insert_threads": 1,
  "clickhouse_min_insert_block_size_bytes": 1073741824,
  "clickhouse_max_download_threads": 4,
  "clickhouse_parallel_distributed_insert_select": 2,
  "kafka_read_committed": false,
  "object_storage_use_cluster_function": true,
  "clickhouse_parallel_view_processing": false
}
'

const url = 'https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/services/497f6eca-6276-4993-bfeb-53cbbbba6f08/clickpipes/497f6eca-6276-4993-bfeb-53cbbbba6f08/settings';
const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json', Authorization: 'Basic <token>'},
  body: JSON.stringify({
    streaming_max_insert_wait_ms: 5000,
    object_storage_concurrency: 1,
    object_storage_polling_interval_ms: 30000,
    object_storage_max_insert_bytes: 10737418240,
    object_storage_max_file_count: 100,
    clickhouse_max_threads: 8,
    clickhouse_max_insert_threads: 1,
    clickhouse_min_insert_block_size_bytes: 1073741824,
    clickhouse_max_download_threads: 4,
    clickhouse_parallel_distributed_insert_select: 2,
    kafka_read_committed: false,
    object_storage_use_cluster_function: true,
    clickhouse_parallel_view_processing: false
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/services/497f6eca-6276-4993-bfeb-53cbbbba6f08/clickpipes/497f6eca-6276-4993-bfeb-53cbbbba6f08/settings"

payload = {
    "streaming_max_insert_wait_ms": 5000,
    "object_storage_concurrency": 1,
    "object_storage_polling_interval_ms": 30000,
    "object_storage_max_insert_bytes": 10737418240,
    "object_storage_max_file_count": 100,
    "clickhouse_max_threads": 8,
    "clickhouse_max_insert_threads": 1,
    "clickhouse_min_insert_block_size_bytes": 1073741824,
    "clickhouse_max_download_threads": 4,
    "clickhouse_parallel_distributed_insert_select": 2,
    "kafka_read_committed": False,
    "object_storage_use_cluster_function": True,
    "clickhouse_parallel_view_processing": False
}
headers = {
    "Content-Type": "application/json",
    "Authorization": "Basic <token>"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

Response example

{
  "status": 200,
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  "result": {
    "streaming_max_insert_wait_ms": 5000,
    "object_storage_concurrency": 1,
    "object_storage_polling_interval_ms": 30000,
    "object_storage_max_insert_bytes": 10737418240,
    "object_storage_max_file_count": 100,
    "clickhouse_max_threads": 8,
    "clickhouse_max_insert_threads": 1,
    "clickhouse_min_insert_block_size_bytes": 1073741824,
    "clickhouse_max_download_threads": 4,
    "clickhouse_parallel_distributed_insert_select": 2,
    "kafka_read_committed": false,
    "object_storage_use_cluster_function": true,
    "clickhouse_parallel_view_processing": false
  }
}

{
  "status": 400,
  "error": "string",
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6"
}

{
  "status": 500,
  "error": "string",
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6"
}