az synapse sql-script

管理 synapse 工作區中的 SQL 腳本。

命令

名稱	Description	類型	狀態
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	將 CLI 置於等候狀態，直到符合 sql 腳本的條件為止。	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'

必要參數

--file -f

SQL 查詢檔案路徑。

--name -n

SQL 文稿名稱。

--workspace-name

工作區名稱。

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--additional-properties

SQL 腳本其他屬性。

--description

SQL 文稿描述。

--folder-name

這個 SQL 腳本位於的資料夾。如果未指定，此 SQL 腳本將會出現在根層級。例如：資料夾/子資料夾1。

--no-wait

請勿等候長時間執行的作業完成。

屬性	值
預設值:	False

--result-limit

SQL 查詢結果限制。預設值為 5000。 '-1' 沒有限制。

屬性	值
預設值:	5000
接受的值:	-1, 5000

--sql-database-name

SQL 資料庫名稱。

--sql-pool-name

SQL 集區名稱。

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --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

必要參數

--name -n

SQL 文稿名稱。

--workspace-name

工作區名稱。

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--no-wait

請勿等候長時間執行的作業完成。

屬性	值
預設值:	False

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --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'

必要參數

--output-folder

SQL 文稿匯出路徑。

--workspace-name

工作區名稱。

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--name -n

SQL 文稿名稱。

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --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'

必要參數

--file -f

SQL 查詢檔案路徑。

--name -n

SQL 文稿名稱。

--workspace-name

工作區名稱。

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--additional-properties

SQL 腳本其他屬性。

--description

SQL 文稿描述。

--folder-name

這個 SQL 腳本位於的資料夾。如果未指定，此 SQL 腳本將會出現在根層級。例如：資料夾/子資料夾1。

--no-wait

請勿等候長時間執行的作業完成。

屬性	值
預設值:	False

--result-limit

SQL 查詢結果限制。預設值為 5000。 '-1' 沒有限制。

屬性	值
預設值:	5000
接受的值:	-1, 5000

--sql-database-name

SQL 資料庫名稱。

--sql-pool-name

SQL 集區名稱。

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --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

必要參數

--workspace-name

工作區名稱。

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --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

必要參數

--name -n

SQL 文稿名稱。

--workspace-name

工作區名稱。

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

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' 建立。

屬性	值
參數群組:	Wait Condition Arguments
預設值:	False

--custom

等到條件符合自定義 JMESPath 查詢為止。例如 provisioningState！='InProgress'， instanceView.statuses[？code=='PowerState/running']。

屬性	值
參數群組:	Wait Condition Arguments

--deleted

等到刪除為止。

屬性	值
參數群組:	Wait Condition Arguments
預設值:	False

--exists

等候資源存在。

屬性	值
參數群組:	Wait Condition Arguments
預設值:	False

--interval

輪詢間隔以秒為單位。

屬性	值
參數群組:	Wait Condition Arguments
預設值:	30

--timeout

以秒為單位的等候上限。

屬性	值
參數群組:	Wait Condition Arguments
預設值:	3600

--updated

等到 provisioningState 更新為 'Succeeded'。

屬性	值
參數群組:	Wait Condition Arguments
預設值:	False

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

意見反應

此頁面對您有幫助嗎？