YAML for ClickHouse

View as Markdown

ClickHouse target for executing queries on a ClickHouse database.

YAML parameters for ClickHouse

PARAMETERS

hostrequiredstring

The hostname or IP address of the ClickHouse server

targetrequiredstring

The human-readable ID of the target

namestring

The name of the target

portstring

The native protocol port of the ClickHouse server. Default: 9000

databasestring

The default database name

secureboolean

Whether to use a TLS-secured native protocol connection. Default: false

authClickhouseAuthYaml

ClickHouse authentication credentials

proxystring

SSH proxy target for tunneling to private ClickHouse servers

permissionsPermissionsYaml

Access permissions for the target

disabledboolean

Indicates if this target is disabled (default: false)

tagsstring[]

The list of tags associated with the target

use_asUseAsYaml

Defines how the target can be used (as deployment target, proxy, or both)

notestring

Note for this resource

agent_notestring

YAML note for AI agents operating on this resource

typestring

Value: CLICKHOUSE

Last modified on Sep 17, 2026

Azure Kubernetes Service DigitalOcean Droplet

YAML examples for ClickHouse

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