Get Started on Cloud
BasicsPipelinesActions & ServicesEnvironmentsIntegrationsTargetsTestsDomainsSandboxesAgents & TunnelsYAML

YAML for MSSQL CLI

View as Markdown

Execute MSSQL (sqlcmd) commands on a Microsoft SQL Server database.

YAML parameters for MSSQL CLI

PARAMETERS
execute_commandsrequiredstring[]
List of shell commands to execute.
typerequiredstring

Value: MSSQL_CLI

actionrequiredstring
Unique identifier for the action within the pipeline.
targetsobject[]
The list of MSSQL targets for this action
shellstring enum
Shell to use for executing commands: BASH (default), SH, or ZSH.
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_SUCCESS,
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.
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 May 11, 2026

Previous pageMongosh CLINext pageMySQL CLI

YAML examples for MSSQL CLI

Execute MSSQL commands

yaml
  - action: "Run MSSQL queries"
    type: "MSSQL_CLI"
    trigger_time: "ON_EVERY_EXECUTION"
    shell: "BASH"
    execute_commands:
      - "sqlcmd -Q 'SELECT @@VERSION'"
      - "sqlcmd -i migrate.sql"
    setup_commands:
      - "apt-get update"
    targets:
      - target: my_mssql_database
        type: MSSQL
        name: My MSSQL Database
        host: mssql.example.com
        port: '1433'
        database: app
        auth:
        username: app_user
        password: secured