Get Started on Cloud
BasicsAI AgentsPipelinesActions & ServicesEnvironmentsIntegrationsTargetsTestsDomainsSandboxesAgents & TunnelsYAMLBuddy GitCLIAPIFAQ

YAML for ClickHouse CLI

View as Markdown

Execute ClickHouse CLI commands on a ClickHouse database.

YAML parameters for ClickHouse CLI

PARAMETERS
commandsrequiredstring
List of shell commands to execute.
typerequiredstring

Value: CLICKHOUSE_CLI

actionrequiredstring
Unique identifier for the action within the pipeline.
targetsobject[]
The list of ClickHouse targets for this action
shellstring enum
The shell used to execute commands. Default: BASH.
Allowed enum:
SH,
BASH,
POWERSHELL
setup_commandsstring
Commands to run before the main commands (e.g., for installing dependencies).
execute_every_commandboolean
When true, execute all commands even if earlier ones fail.
build_tool_versionstring
Version of the CLI tool to use.
site_idstring
Site identifier for the CLI tool.
websitestring
Website URL for the CLI tool configuration.
valid_for_daysinteger
Number of days the results are valid for.
versionstring
Version of the CLI tool.
trigger_timestring enum
Specifies when the action should be executed.
Allowed enum:
ON_EVERY_EXECUTION,
ON_FAILURE,
ON_BACK_TO_SUCCESS,
ON_WARNING,
ON_WAIT_FOR_APPROVE,
ON_TERMINATE
loopstring[]
The list of variables for dynamic action execution. The action runs once for each value.
run_only_on_first_failureboolean
Defines whether the action should be executed on each failure. Restricted to and required if the trigger_time is ON_FAILURE.
disabledboolean
When set to true the action is disabled. By default it is set to false.
timeoutinteger
The timeout in seconds.
ignore_errorsboolean
If set to true the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions.
retry_intervalinteger
Delay time between auto retries in seconds.
retry_countinteger
Number of retries if the action fails.

Constraints: ≤ 10

run_nextstring enum
Defines whether the action should run in parallel with the next one.
Allowed enum:
WAIT_ON_SUCCESS,
IN_SOFT_PARALLEL,
IN_HARD_PARALLEL
trigger_conditionsTriggerConditionYaml[]
The list of trigger conditions to meet so that the action can be triggered.
variablesVariableYaml[]
The list of variables you can use in the action.

Last modified on Sep 7, 2026

Previous pageClear CacheNext pageCloudflare

YAML examples for ClickHouse CLI

Minimal ClickHouse commands

yaml
  - action: "Run ClickHouse queries"
    type: "CLICKHOUSE_CLI"
    commands: "clickhouse-client -q 'SHOW DATABASES'"
    targets:
      - target: my_database
        type: CLICKHOUSE
        name: My ClickHouse Database
        host: clickhouse.example.com
        auth:
        username: deploy_user
        password: secured

Execute ClickHouse commands

yaml
  - action: "Run ClickHouse queries"
    type: "CLICKHOUSE_CLI"
    trigger_time: "ON_EVERY_EXECUTION"
    version: "24"
    shell: "BASH"
    commands: |-
      clickhouse-client -q 'SHOW DATABASES'
      clickhouse-client --queries-file migrate.sql
    setup_commands: "apt-get install -y curl"
    targets:
      - 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