az synapse sql-script

リファレンス

synapse ワークスペースで SQL スクリプトを管理します。

コマンド

名前	説明	型	状態
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	SQL スクリプトの条件が満たされるまで、CLI を待機状態にします。	コア	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

編集

SQL スクリプトの条件が満たされるまで、CLI を待機状態にします。

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

必須のパラメーター

--name -n

SQL スクリプト名。

--workspace-name

ワークスペース名。

省略可能のパラメーター

--created

'provisioningState' が 'Succeeded' で作成されるまで待ちます。

規定値: 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 を使います。

次の方法で共有

az synapse sql-script

コマンド

az synapse sql-script create

例

必須のパラメーター

省略可能のパラメーター

az synapse sql-script delete

例

必須のパラメーター

省略可能のパラメーター

az synapse sql-script export

例

必須のパラメーター

省略可能のパラメーター

az synapse sql-script import

例

必須のパラメーター

省略可能のパラメーター

az synapse sql-script list

例

必須のパラメーター

az synapse sql-script show

例

必須のパラメーター

az synapse sql-script wait

必須のパラメーター

省略可能のパラメーター

その他のリソース