az synapse sql-script
synapse ワークスペースで SQL スクリプトを管理します。
コマンド
| 名前 | 説明 | 型 | 状態 |
|---|---|---|---|
| az synapse sql-script create |
SQL スクリプトを作成または更新します。 |
Core | GA |
| az synapse sql-script delete |
SQL スクリプトを削除します。 |
Core | GA |
| az synapse sql-script export |
SQL スクリプトをエクスポートします。 |
Core | GA |
| az synapse sql-script import |
SQL スクリプトをインポートします。 |
Core | GA |
| az synapse sql-script list |
synapse ワークスペース内の SQL スクリプトを一覧表示します。 |
Core | GA |
| az synapse sql-script show |
SQL スクリプトを取得します。 |
Core | GA |
| az synapse sql-script wait |
SQL スクリプトの条件が満たされるまで、CLI を待機状態にします。 |
Core | 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'
必須のパラメーター
SQL クエリ ファイルのパス。
SQL スクリプト名。
ワークスペース名。
オプションのパラメーター
次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。
SQL スクリプトの追加プロパティ。
SQL スクリプトの説明。
この SQL スクリプトが存在するフォルダー。 指定しない場合、この SQL スクリプトはルート レベルで表示されます。 例: folder/subfolder1。
実行時間の長い操作が完了するまで待つ必要はありません。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
SQL クエリの結果の制限。 既定値は 5000 です。 '-1' は制限なし。
| プロパティ | 値 |
|---|---|
| 規定値: | 5000 |
| 指定可能な値: | -1, 5000 |
SQL データベース名。
SQL プール名。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
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
必須のパラメーター
SQL スクリプト名。
ワークスペース名。
オプションのパラメーター
次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。
実行時間の長い操作が完了するまで待つ必要はありません。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
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'
必須のパラメーター
SQL スクリプトのエクスポート パス。
ワークスペース名。
オプションのパラメーター
次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。
SQL スクリプト名。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
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'
必須のパラメーター
SQL クエリ ファイルのパス。
SQL スクリプト名。
ワークスペース名。
オプションのパラメーター
次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。
SQL スクリプトの追加プロパティ。
SQL スクリプトの説明。
この SQL スクリプトが存在するフォルダー。 指定しない場合、この SQL スクリプトはルート レベルで表示されます。 例: folder/subfolder1。
実行時間の長い操作が完了するまで待つ必要はありません。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
SQL クエリの結果の制限。 既定値は 5000 です。 '-1' は制限なし。
| プロパティ | 値 |
|---|---|
| 規定値: | 5000 |
| 指定可能な値: | -1, 5000 |
SQL データベース名。
SQL プール名。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
az synapse sql-script list
synapse ワークスペース内の SQL スクリプトを一覧表示します。
az synapse sql-script list --workspace-name
例
SQL スクリプトを一覧表示します。
az synapse sql-script list --workspace-name testsynapseworkspace
必須のパラメーター
ワークスペース名。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
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
必須のパラメーター
SQL スクリプト名。
ワークスペース名。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
az synapse sql-script wait
SQL スクリプトの条件が満たされるまで、CLI を待機状態にします。
az synapse sql-script wait --name
--workspace-name
[--created]
[--custom]
[--deleted]
[--exists]
[--interval]
[--timeout]
[--updated]
必須のパラメーター
SQL スクリプト名。
ワークスペース名。
オプションのパラメーター
次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。
'provisioningState' が 'Succeeded' で作成されるまで待ちます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Wait Condition Arguments |
| 規定値: | False |
条件がカスタム JMESPath クエリを満たすまで待ちます。 例: provisioningState!='InProgress'、instanceView.statuses[?code=='PowerState/running']。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Wait Condition Arguments |
削除されるまで待ちます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Wait Condition Arguments |
| 規定値: | False |
リソースが存在するまで待ちます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Wait Condition Arguments |
| 規定値: | False |
ポーリング間隔 (秒単位)。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Wait Condition Arguments |
| 規定値: | 30 |
最大待機時間 (秒単位)。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Wait Condition Arguments |
| 規定値: | 3600 |
provisioningState が 'Succeeded' で更新されるまで待ちます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Wait Condition Arguments |
| 規定値: | False |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |