通过

.execute cluster script 命令

  • 项目

适用于：✅Azure 数据资源管理器

在群集范围内执行一系列管理命令。

注意

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

权限

你必须具有群集 AllDatabasesAdmin 权限才能运行此命令。

语法

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

详细了解语法约定。

参数

客户 类型​​ 必需 说明
ControlCommandsScript string ✔️ 包含一个或多个管理命令的文本。
PropertyName, PropertyValue string 可选属性。 请参阅支持的属性。

支持的属性

PropertyName 类型 说明
ContinueOnErrors bool 如果设置为 false - 脚本在发生第一个错误时停止。 如果设置为 true，脚本将继续执行。 默认：false。
ThrowOnErrors bool 如果设置为 true - 脚本在发生第一个错误时引发错误（失败）。 不能与 ContinueOnErrors 一起使用，只允许使用一个。 默认：false。

返回

脚本中显示的每个命令在输出表中都显示为一条单独记录。 每个记录都具有以下字段：

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

注意

  • 脚本文本可能包括命令之间的空行和注释。
  • 命令按它们在输入脚本中出现的顺序依次执行。
  • 脚本执行是按顺序的，但不是事务性的，并且在出现错误时不会执行回滚。 建议在使用 .execute cluster script 时使用幂等形式的命令。
  • 该命令的默认行为是在第一次出现错误时失败。 可以使用属性参数 ContinueOnErrors 来更改它。
  • 不执行只读管理命令（.show 命令），并以 Skipped 状态报告这些命令。