.执行集群脚本命令

使用 “版本 ”下拉列表切换服务。 了解有关导航的详细信息
适用于:✅ Azure Data Explorer

在作用域中执行一批管理命令是群集。

注释

命令不支持 .execute cluster script 数据库级命令。 请改用 .execute database script 命令。 在运行前选择完整的命令文本。 否则,它将在脚本中的第一个空行处停止。

Permissions

必须具有 Cluster AllDatabasesAdmin 权限才能运行此命令。

Syntax

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

详细了解语法约定

参数

姓名 类型 必选 Description
ControlCommandsScript string ✔️ 包含一个或多个管理命令的文本。
PropertyName、PropertyValue string 可选属性。 请参阅 支持的属性

支持的属性

PropertyName 类型 Description
ContinueOnErrors bool 如果设置为 false - 脚本在第一个错误时停止。 如果设置为 true - 脚本执行将继续。 默认值:false
ThrowOnErrors bool 如果设置为 true - 脚本在第一个错误上引发错误(失败)。 不能一 ContinueOnErrors起使用,只允许一个。 默认值:false

退货

脚本中显示的每个命令都报告为输出表中的单独记录。 每个记录具有以下字段:

输出参数 类型 Description
OperationId guid 命令的标识符。
命令类型 string 命令的类型。
CommandText string 特定命令的文本。
结果 string 特定命令执行的结果。
原因 string 有关命令执行结果的详细信息。

注释

  • 脚本文本可能包括命令之间的空行和注释。
  • 命令按输入脚本中显示的顺序按顺序执行。
  • 脚本执行是顺序的,但非事务性执行,并且不会在错误时执行回滚。 建议在使用 .execute cluster script时使用命令的幂等形式。
  • 该命令的默认行为是在第一个错误时失败。 这可以通过使用属性参数进行更改: ContinueOnErrors
  • 不执行只读管理命令(.show 命令),并报告状态 Skipped