> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# ClickHouse Cloud: Clickhouse Click Pipe Settings Get

> Get the advanced settings of a ClickPipe, such as insert wait time and object storage polling. Includes inputs, outputs, SDK V2 examples, and Deepline cost.

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

> [!NOTE]
>
> 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.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
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

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
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`. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Returns the advanced settings for the specified ClickPipe.",
    "properties": {
      "organizationId": {
        "type": "string",
        "description": "ID of the organization that owns the service.",
        "format": "uuid"
      },
      "serviceId": {
        "type": "string",
        "description": "ID of the service that owns the ClickPipe.",
        "format": "uuid"
      },
      "clickPipeId": {
        "type": "string",
        "description": "ID of the ClickPipe to get settings for.",
        "format": "uuid"
      }
    },
    "required": [
      "organizationId",
      "serviceId",
      "clickPipeId"
    ],
    "additionalProperties": false
  }
  ```
</details>

## 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). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "status": {
            "type": "number",
            "description": "HTTP status code."
          },
          "requestId": {
            "type": "string",
            "description": "Unique id assigned to every request. UUIDv4",
            "format": "uuid"
          },
          "result": {
            "properties": {
              "streaming_max_insert_wait_ms": {
                "type": [
                  "integer",
                  "null"
                ],
                "description": "Streaming max insert wait time. Configures the max wait period before inserting data into the ClickHouse.",
                "minimum": 500,
                "maximum": 60000
              },
              "object_storage_concurrency": {
                "type": [
                  "integer",
                  "null"
                ],
                "description": "Object storage concurrency. Number of concurrent file processing threads",
                "minimum": 1,
                "maximum": 35
              },
              "object_storage_polling_interval_ms": {
                "type": [
                  "integer",
                  "null"
                ],
                "description": "Object storage polling interval. Configures the refresh interval for querying continuous ingest for new object storage data",
                "minimum": 100,
                "maximum": 3600000
              },
              "object_storage_max_insert_bytes": {
                "type": [
                  "integer",
                  "null"
                ],
                "description": "Max insert bytes. Number of bytes to process in a single insert batch",
                "minimum": 10485760,
                "maximum": 53687091200
              },
              "object_storage_max_file_count": {
                "type": [
                  "integer",
                  "null"
                ],
                "description": "Max file count. Maximum number of files to process in a single insert batch",
                "minimum": 1,
                "maximum": 10000
              },
              "clickhouse_max_threads": {
                "type": [
                  "integer",
                  "null"
                ],
                "description": "Max threads. Maximum number of concurrent threads for file processing",
                "minimum": 0,
                "maximum": 64
              },
              "clickhouse_max_insert_threads": {
                "type": [
                  "integer",
                  "null"
                ],
                "description": "Max insert threads. Maximum number of concurrent insert threads",
                "minimum": 0,
                "maximum": 16
              },
              "clickhouse_min_insert_block_size_bytes": {
                "type": [
                  "integer",
                  "null"
                ],
                "description": "Min insert block size bytes. Minimum size of data block for insert (in bytes)",
                "minimum": 0,
                "maximum": 10737418240
              },
              "clickhouse_max_download_threads": {
                "type": [
                  "integer",
                  "null"
                ],
                "description": "Max download threads. Maximum number of concurrent download threads",
                "minimum": 0,
                "maximum": 32
              },
              "clickhouse_parallel_distributed_insert_select": {
                "type": [
                  "integer",
                  "null"
                ],
                "description": "Parallel distributed insert select. Parallel distributed insert select setting",
                "minimum": 0,
                "maximum": 2
              },
              "object_storage_use_cluster_function": {
                "type": [
                  "boolean",
                  "null"
                ],
                "description": "use cluster function. Whether to use ClickHouse cluster function for distributed processing"
              },
              "clickhouse_parallel_view_processing": {
                "type": [
                  "boolean",
                  "null"
                ],
                "description": "parallel view processing. Whether to enable pushing to attached views concurrently instead of sequentially"
              }
            },
            "additionalProperties": false
          }
        },
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [ClickHouse Cloud provider guide](https://deepline.com/docs/providers/clickhouse/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.