ClickHouse Cloud: Clickhouse Click Pipe Settings Get

Get the advanced settings of a ClickPipe, such as insert wait time and object storage polling.

Tool ID: clickhouse_click_pipe_settings_get

Run this action

Use the TypeScript SDK for one call. Use ctx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'clickhouse_click_pipe_settings_get',
  {
    "organizationId": "123e4567-e89b-42d3-a456-426614174000",
    "serviceId": "123e4567-e89b-42d3-a456-426614174000",
    "clickPipeId": "123e4567-e89b-42d3-a456-426614174000"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute clickhouse_click_pipe_settings_get --input '{
  "organizationId": "123e4567-e89b-42d3-a456-426614174000",
  "serviceId": "123e4567-e89b-42d3-a456-426614174000",
  "clickPipeId": "123e4567-e89b-42d3-a456-426614174000"
}' --json

Example response

The static output schema lacks the details for a reliable example. Use deepline describe clickhouse_click_pipe_settings_get --json for the complete live contract.

Input reference

Returns the advanced settings for the specified ClickPipe.

Name	Type	Required	Default	Details
`payload.organizationId`	`string`	Yes	—	ID of the organization that owns the service. Format: `uuid`.
`payload.serviceId`	`string`	Yes	—	ID of the service that owns the ClickPipe. Format: `uuid`.
`payload.clickPipeId`	`string`	Yes	—	ID of the ClickPipe to get settings for. Format: `uuid`.

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.streaming_max_insert_wait_ms`	`integer \| null`	No	—	Streaming max insert wait time. Configures the max wait period before inserting data into the ClickHouse. Minimum: 500. Maximum: 60000.
`result.data.result.object_storage_concurrency`	`integer \| null`	No	—	Object storage concurrency. Number of concurrent file processing threads Minimum: 1. Maximum: 35.
`result.data.result.object_storage_polling_interval_ms`	`integer \| null`	No	—	Object storage polling interval. Configures the refresh interval for querying continuous ingest for new object storage data Minimum: 100. Maximum: 3600000.
`result.data.result.object_storage_max_insert_bytes`	`integer \| null`	No	—	Max insert bytes. Number of bytes to process in a single insert batch Minimum: 10485760. Maximum: 53687091200.
`result.data.result.object_storage_max_file_count`	`integer \| null`	No	—	Max file count. Maximum number of files to process in a single insert batch Minimum: 1. Maximum: 10000.
`result.data.result.clickhouse_max_threads`	`integer \| null`	No	—	Max threads. Maximum number of concurrent threads for file processing Minimum: 0. Maximum: 64.
`result.data.result.clickhouse_max_insert_threads`	`integer \| null`	No	—	Max insert threads. Maximum number of concurrent insert threads Minimum: 0. Maximum: 16.
`result.data.result.clickhouse_min_insert_block_size_bytes`	`integer \| null`	No	—	Min insert block size bytes. Minimum size of data block for insert (in bytes) Minimum: 0. Maximum: 10737418240.
`result.data.result.clickhouse_max_download_threads`	`integer \| null`	No	—	Max download threads. Maximum number of concurrent download threads Minimum: 0. Maximum: 32.
`result.data.result.clickhouse_parallel_distributed_insert_select`	`integer \| null`	No	—	Parallel distributed insert select. Parallel distributed insert select setting Minimum: 0. Maximum: 2.
`result.data.result.object_storage_use_cluster_function`	`boolean \| null`	No	—	use cluster function. Whether to use ClickHouse cluster function for distributed processing
`result.data.result.clickhouse_parallel_view_processing`	`boolean \| null`	No	—	parallel view processing. Whether to enable pushing to attached views concurrently instead of sequentially
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

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

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation