Edit

Share via

.execute cluster script command

Applies to: ✅ Azure Data Explorer

Executes a batch of management commands in the scope is a cluster.

Note

Database-level commands are not supported by .execute cluster script command. Use .execute database script command instead. Select the full command text before running it. Otherwise, it will stop at the first empty line in the script.

Permissions

You must have Cluster AllDatabasesAdmin permissions to run this command.

Syntax

.execute cluster script
[with ( PropertyName = PropertyValue [, ...])] <| ControlCommandsScript

Learn more about syntax conventions.

Parameters

Name Type Required Description
ControlCommandsScript string ✔️ Text with one or more management commands.
PropertyName, PropertyValue string Optional properties. See Supported properties.

Supported properties

PropertyName Type Description
ContinueOnErrors bool If set to false - the script stops on the first error. If set to true - the script execution continues. Default: false.
ThrowOnErrors bool If set to true - the script throws an error (fail) on the first error. Doesn't work together with ContinueOnErrors, only one is allowed. Default: false.

Returns

Each command appearing in the script is reported as a separate record in the output table. Each record has the following fields:

Output parameter Type Description
OperationId guid Identifier of the command.
CommandType string The type of the command.
CommandText string Text of the specific command.
Result string Outcome of the specific command execution.
Reason string Detailed information about command execution outcome.

Note

  • The script text may include empty lines and comments between the commands.
  • Commands are executed sequentially, in the order they appear in the input script.
  • Script execution is sequential, but non-transactional, and no rollback is performed upon error. It's advised to use the idempotent form of commands when using .execute cluster script.
  • The default behavior of the command is to fail on the first error. This can be changed by using the property argument: ContinueOnErrors.
  • Read-only management commands (.show commands) aren't executed and are reported with status Skipped.