通过

az synapse sql-script

  • 参考

在 synapse 工作区中管理 SQL 脚本。

命令

名称 说明 类型 Status
az synapse sql-script create

创建或更新 SQL 脚本。

 核心 GA
az synapse sql-script delete

删除 SQL 脚本。

 核心 GA
az synapse sql-script export

导出 SQL 脚本。

 核心 GA
az synapse sql-script import

导入 SQL 脚本。

 核心 GA
az synapse sql-script list

列出 synapse 工作区中的 SQL 脚本。

 核心 GA
az synapse sql-script show

获取 SQL 脚本。

 核心 GA
az synapse sql-script wait

将 CLI 置于等待状态，直到满足 sql 脚本的条件。

 核心 GA

az synapse sql-script create

编辑

创建或更新 SQL 脚本。

az synapse sql-script create --file
                             --name
                             --workspace-name
                             [--additional-properties]
                             [--description]
                             [--folder-name]
                             [--no-wait]
                             [--result-limit {-1, 5000}]
                             [--sql-database-name]
                             [--sql-pool-name]

示例

创建 SQL 脚本。

az synapse sql-script create --workspace-name testsynapseworkspace \
  --name testsqlscriptname \
  --file 'path/test.sql'

必需参数

--file -f

SQL 查询文件路径。

--name -n

SQL 脚本名称。

--workspace-name

工作区名称。

可选参数

--additional-properties

SQL 脚本附加属性。

--description

SQL 脚本说明。

--folder-name

此 SQL 脚本所在的文件夹。 如果未指定，此 SQL 脚本将显示在根级别。 例如：folder/subfolder1。

--no-wait

不等待长时间运行的操作完成。

默认值: False
--result-limit

SQL 查询结果限制。 默认值为 5000。 “-1”没有限制。

接受的值: -1, 5000
默认值: 5000
--sql-database-name

SQL 数据库名称。

--sql-pool-name

SQL 池名称。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

az synapse sql-script delete

编辑

删除 SQL 脚本。

az synapse sql-script delete --name
                             --workspace-name
                             [--no-wait]

示例

删除 SQL 脚本。

az synapse sql-script delete --workspace-name testsynapseworkspace \
  --name testsqlscriptname

必需参数

--name -n

SQL 脚本名称。

--workspace-name

工作区名称。

可选参数

--no-wait

不等待长时间运行的操作完成。

默认值: False
全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

az synapse sql-script export

编辑

导出 SQL 脚本。

az synapse sql-script export --output-folder
                             --workspace-name
                             [--name]

示例

导出 SQL 脚本。

az synapse sql-script export --workspace-name testsynapseworkspace \
  --name testsqlscriptname \
  --output-folder 'path/folder'

必需参数

--output-folder

SQL 脚本导出路径。

--workspace-name

工作区名称。

可选参数

--name -n

SQL 脚本名称。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

az synapse sql-script import

编辑

导入 SQL 脚本。

az synapse sql-script import --file
                             --name
                             --workspace-name
                             [--additional-properties]
                             [--description]
                             [--folder-name]
                             [--no-wait]
                             [--result-limit {-1, 5000}]
                             [--sql-database-name]
                             [--sql-pool-name]

示例

导入 SQL 脚本。

az synapse sql-script import --workspace-name testsynapseworkspace \
  --name testsqlscriptname \
  --file 'path/test.sql'

必需参数

--file -f

SQL 查询文件路径。

--name -n

SQL 脚本名称。

--workspace-name

工作区名称。

可选参数

--additional-properties

SQL 脚本附加属性。

--description

SQL 脚本说明。

--folder-name

此 SQL 脚本所在的文件夹。 如果未指定，此 SQL 脚本将显示在根级别。 例如：folder/subfolder1。

--no-wait

不等待长时间运行的操作完成。

默认值: False
--result-limit

SQL 查询结果限制。 默认值为 5000。 “-1”没有限制。

接受的值: -1, 5000
默认值: 5000
--sql-database-name

SQL 数据库名称。

--sql-pool-name

SQL 池名称。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

az synapse sql-script list

编辑

列出 synapse 工作区中的 SQL 脚本。

az synapse sql-script list --workspace-name

示例

列出 SQL 脚本。

az synapse sql-script list --workspace-name testsynapseworkspace

必需参数

--workspace-name

工作区名称。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

az synapse sql-script show

编辑

获取 SQL 脚本。

az synapse sql-script show --name
                           --workspace-name

示例

获取 SQL 脚本。

az synapse sql-script show --workspace-name testsynapseworkspace \
  --name testsqlscriptname

必需参数

--name -n

SQL 脚本名称。

--workspace-name

工作区名称。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

az synapse sql-script wait

编辑

将 CLI 置于等待状态，直到满足 sql 脚本的条件。

az synapse sql-script wait --name
                           --workspace-name
                           [--created]
                           [--custom]
                           [--deleted]
                           [--exists]
                           [--interval]
                           [--timeout]
                           [--updated]

必需参数

--name -n

SQL 脚本名称。

--workspace-name

工作区名称。

可选参数

--created

等待在“Succeeded”中使用“provisioningState”创建。

默认值: False
--custom

等待条件满足自定义 JMESPath 查询。 例如 provisioningState！='InProgress'， instanceView.statuses[？code=='PowerState/running']。

--deleted

等到删除为止。

默认值: False
--exists

等待资源存在。

默认值: False
--interval

轮询间隔（以秒为单位）。

默认值: 30
--timeout

最大等待（以秒为单位）。

默认值: 3600
--updated

等到 provisioningState 更新为“Succeeded”。

默认值: False
全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。