> ## 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 Click Pipe Settings Get: Inputs, Cost & CLI

> Get ClickPipe settings. Clickhouse Clickhouse Click Pipe Settings Get docs include request fields, response shape, pricing notes, and Deepline CLI examples.

## Run in Enrichment Spreadsheet

<Info>
  Use this function as a column step in `deepline enrich`.
</Info>

```bash theme={null}
deepline enrich --input leads.csv --output leads.enriched.csv --with 'result=clickhouse_click_pipe_settings_get:{"organizationId":"{{organizationId}}","serviceId":"{{serviceId}}","clickPipeId":"{{clickPipeId}}"}' --json
```

<Tip>
  Map payload values to spreadsheet columns with `{{column_name}}` placeholders.
</Tip>

## Input Schema

| Name                     | Type     | Required | Default | Description                                   |
| ------------------------ | -------- | -------- | ------- | --------------------------------------------- |
| `payload.organizationId` | `string` | Yes      |         | ID of the organization that owns the service. |
| `payload.serviceId`      | `string` | Yes      |         | ID of the service that owns the ClickPipe.    |
| `payload.clickPipeId`    | `string` | Yes      |         | ID of the ClickPipe to get settings for.      |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "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 Schema

| Name          | Type     | Required | Default | Description                                    |
| ------------- | -------- | -------- | ------- | ---------------------------------------------- |
| `result.data` | `object` | Yes      |         | Provider response payload.                     |
| `result.meta` | `object` | No       |         | Additional response metadata (status, paging). |

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

  ### Output JSON Schema

  ```json theme={null}
  {
    "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>

## Advanced: Direct CLI

<Info>
  Use direct execution for single payload debugging.
</Info>

```bash theme={null}
deepline tools execute clickhouse_click_pipe_settings_get --payload '{
  "organizationId": "string",
  "serviceId": "string",
  "clickPipeId": "string"
}' --json
```

### CLI flags

| Flag                        | Description                                         |
| --------------------------- | --------------------------------------------------- |
| `--json`                    | Print machine-readable output.                      |
| `--wait`                    | Wait for terminal provider status when supported.   |
| `--debug`                   | Enable wait mode with additional status/log output. |
| `--wait-timeout SECONDS`    | Max seconds to wait in wait mode.                   |
| `--poll-interval SECONDS`   | Polling interval in seconds during wait mode.       |
| `--timeout SECONDS`         | Request timeout in seconds.                         |
| `--connect-timeout SECONDS` | Connection timeout in seconds.                      |

## Cost

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