ClickHouse Cloud: Clickhouse Click Pipe Schema Discovery

Discover ClickPipe source schema.

Tool ID: clickhouse_click_pipe_schema_discovery

Run this action

Use the TypeScript SDK for a single call. Put ctx.tools.execute(...) inside a Play when the call should be durable, scheduled, or run across a CSV.

import { Deepline } from 'deepline';

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

console.log(result.toolResponse.raw);

CLI

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

Example response

The SDK exposes this shape at result.toolResponse.raw. Values below are representative.

{
  "data": {
    "status": 123,
    "requestId": "123e4567-e89b-42d3-a456-426614174000",
    "result": {
      "fields": [
        {
          "name": "Example",
          "type": "example",
          "optional": false
        }
      ]
    }
  }
}

Use deepline tools get clickhouse_click_pipe_schema_discovery --json for the latest machine-readable contract.

Input reference

This endpoint is in beta. API contract is stable, and no breaking changes are expected in the future. Infers the schema (field names and ClickHouse data types) of a streaming ClickPipe source without creating a pipe. Supported for Kafka, Kinesis sources.

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 to run schema discovery against. Format: `uuid`.
`payload.source`	`object`	No	—	—

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.fields`	`array`	No	—	Inferred schema fields with their ClickHouse data types.
`result.data.result.fields[].name`	`string`	No	—	Name of the inferred field.
`result.data.result.fields[].type`	`string`	No	—	Inferred ClickHouse data type of the field.
`result.data.result.fields[].optional`	`boolean \| null`	No	—	Whether the field is optional (nullable) in the source.
`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.

Get started

Build and automate

Common workflows

Data and integrations

Reference

ClickHouse Cloud: Clickhouse Click Pipe Schema Discovery

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

​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