# ClickHouse

ClickHouse target for executing queries on a ClickHouse database.

## YAML Parameters

```typescript
interface YAMLParameters {
  /** The hostname or IP address of the ClickHouse server */
  host: string;
  /** The human-readable ID of the target */
  target: string;
  /** The name of the target */
  name?: string;
  /** The native protocol port of the ClickHouse server. Default: 9000 */
  port?: string;
  /** The default database name */
  database?: string;
  /** Whether to use a TLS-secured native protocol connection. Default: false */
  secure?: boolean;
  /** ClickHouse authentication credentials */
  auth?: ClickhouseAuthYaml;
  /** SSH proxy target for tunneling to private ClickHouse servers */
  proxy?: string;
  /** Access permissions for the target */
  permissions?: PermissionsYaml;
  /** Indicates if this target is disabled (default: false) */
  disabled?: boolean;
  /** The list of tags associated with the target */
  tags?: string[];
  /** Defines how the target can be used (as deployment target, proxy, or both) */
  use_as?: UseAsYaml;
  /** Note for this resource */
  note?: string;
  /** YAML note for AI agents operating on this resource */
  agent_note?: string;
  type?: "CLICKHOUSE";
}
```

## Type Definitions

```typescript
interface ClickhouseAuthYaml {
  /** The ClickHouse username */
  username?: string;
  /** The ClickHouse password */
  password?: string;
}

interface PermissionsYaml {
  /** Access level for other workspace members */
  others?: "DENIED" | "READ_ONLY" | "USE_ONLY" | "BLIND" | "RUN_ONLY" | "READ_WRITE" | "MANAGE" | "DEFAULT" | "ALLOWED" | "STAGE" | "COMMIT";
  /** List of specific users with their access levels */
  users?: object;
  /** List of user groups with their access levels */
  groups?: object;
  /** List of pipelines allowed to access this resource */
  pipelines?: AllowedPipelineYaml[];
  /** List of sandboxes allowed to access this resource */
  sandboxes?: AllowedSandboxYaml[];
}

interface AllowedPipelineYaml {
  /** When true, allow all pipelines to access this resource */
  all?: "DENIED" | "READ_ONLY" | "USE_ONLY" | "BLIND" | "RUN_ONLY" | "READ_WRITE" | "MANAGE" | "DEFAULT" | "ALLOWED" | "STAGE" | "COMMIT";
  /** Project name containing the allowed pipeline */
  project?: string;
  /** Pipeline identifier that is allowed to access this resource */
  pipeline?: string;
  /** Access level granted to the pipeline */
  access?: "DENIED" | "READ_ONLY" | "USE_ONLY" | "BLIND" | "RUN_ONLY" | "READ_WRITE" | "MANAGE" | "DEFAULT" | "ALLOWED" | "STAGE" | "COMMIT";
}

interface AllowedSandboxYaml {
  /** When true, allow all sandboxes to access this resource */
  all?: "DENIED" | "READ_ONLY" | "USE_ONLY" | "BLIND" | "RUN_ONLY" | "READ_WRITE" | "MANAGE" | "DEFAULT" | "ALLOWED" | "STAGE" | "COMMIT";
  /** Project name containing the allowed sandbox */
  project?: string;
  /** Sandbox identifier that is allowed to access this resource */
  sandbox?: string;
  /** Access level granted to the sandbox */
  access?: "DENIED" | "READ_ONLY" | "USE_ONLY" | "BLIND" | "RUN_ONLY" | "READ_WRITE" | "MANAGE" | "DEFAULT" | "ALLOWED" | "STAGE" | "COMMIT";
}

interface UseAsYaml {
  /** Whether the target can be used as a deployment target (default: on) */
  target?: boolean | "on" | "off";
  /** Whether the target can be used as a proxy (default: on) */
  proxy?: boolean | "on" | "off";
}

```

## YAML Examples

### ClickHouse target with password authentication

```yaml
- target: my_database
  type: CLICKHOUSE
  name: My ClickHouse Database
  host: clickhouse.example.com
  port: "9000"
  database: myapp
  secure: true
  auth:
    username: deploy_user
    password: secured
  tags:
    - clickhouse

```

### Minimal

```yaml
- target: my_database
  type: CLICKHOUSE
  name: My ClickHouse Database
  host: clickhouse.example.com
  auth:
    username: deploy_user
    password: secured

```


---
Original source: https://buddy.works/docs/yaml/yaml-targets/clickhouse