Partilhar via

az synapse sql-script

Gerencie scripts SQL em um espaço de trabalho de sinapse.

Comandos

Name Description Tipo Status
az synapse sql-script create

Crie ou atualize um script SQL.

 Core disponibilidade geral
az synapse sql-script delete

Exclua um script SQL.

 Core disponibilidade geral
az synapse sql-script export

Exporte um script SQL.

 Core disponibilidade geral
az synapse sql-script import

Importe um script SQL.

 Core disponibilidade geral
az synapse sql-script list

Liste scripts SQL em um espaço de trabalho de sinapse.

 Core disponibilidade geral
az synapse sql-script show

Obtenha um script SQL.

 Core disponibilidade geral
az synapse sql-script wait

Coloque a CLI em um estado de espera até que uma condição de um script sql seja atendida.

 Core disponibilidade geral

az synapse sql-script create

Editar

Crie ou atualize um script 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]

Exemplos

Crie um script SQL.

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

Parâmetros Obrigatórios

--file -f

O caminho do arquivo de consulta SQL.

--name -n

O nome do script SQL.

--workspace-name

O nome do espaço de trabalho.

Parâmetros Opcionais

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--additional-properties

As propriedades adicionais do script SQL.

--description

A descrição do script SQL.

--folder-name

A pasta em que este script SQL está. Se não for especificado, esse script SQL aparecerá no nível raiz. Por exemplo: pasta/subpasta1.

--no-wait

Não espere que a operação de longa duração termine.

Propriedade Valor
Default value: False
--result-limit

O limite de resultados da consulta SQL. O padrão é 5000. '-1' não tem limite.

Propriedade Valor
Default value: 5000
Valores aceites: -1, 5000
--sql-database-name

O nome do banco de dados SQL.

--sql-pool-name

O nome do pool SQL.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

az synapse sql-script delete

Editar

Exclua um script SQL.

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

Exemplos

Exclua um script SQL.

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

Parâmetros Obrigatórios

--name -n

O nome do script SQL.

--workspace-name

O nome do espaço de trabalho.

Parâmetros Opcionais

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

Não espere que a operação de longa duração termine.

Propriedade Valor
Default value: False
Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

az synapse sql-script export

Editar

Exporte um script SQL.

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

Exemplos

Exporte um script SQL.

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

Parâmetros Obrigatórios

--output-folder

O caminho de exportação do script SQL.

--workspace-name

O nome do espaço de trabalho.

Parâmetros Opcionais

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--name -n

O nome do script SQL.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

az synapse sql-script import

Editar

Importe um script 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]

Exemplos

Importe um script SQL.

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

Parâmetros Obrigatórios

--file -f

O caminho do arquivo de consulta SQL.

--name -n

O nome do script SQL.

--workspace-name

O nome do espaço de trabalho.

Parâmetros Opcionais

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--additional-properties

As propriedades adicionais do script SQL.

--description

A descrição do script SQL.

--folder-name

A pasta em que este script SQL está. Se não for especificado, esse script SQL aparecerá no nível raiz. Por exemplo: pasta/subpasta1.

--no-wait

Não espere que a operação de longa duração termine.

Propriedade Valor
Default value: False
--result-limit

O limite de resultados da consulta SQL. O padrão é 5000. '-1' não tem limite.

Propriedade Valor
Default value: 5000
Valores aceites: -1, 5000
--sql-database-name

O nome do banco de dados SQL.

--sql-pool-name

O nome do pool SQL.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

az synapse sql-script list

Editar

Liste scripts SQL em um espaço de trabalho de sinapse.

az synapse sql-script list --workspace-name

Exemplos

Listar scripts SQL.

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

Parâmetros Obrigatórios

--workspace-name

O nome do espaço de trabalho.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

az synapse sql-script show

Editar

Obtenha um script SQL.

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

Exemplos

Obtenha um script SQL.

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

Parâmetros Obrigatórios

--name -n

O nome do script SQL.

--workspace-name

O nome do espaço de trabalho.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

az synapse sql-script wait

Editar

Coloque a CLI em um estado de espera até que uma condição de um script sql seja atendida.

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

Parâmetros Obrigatórios

--name -n

O nome do script SQL.

--workspace-name

O nome do espaço de trabalho.

Parâmetros Opcionais

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

Aguarde até ser criado com 'provisioningState' em 'Succeeded'.

Propriedade Valor
Parameter group: Wait Condition Arguments
Default value: False
--custom

Aguarde até que a condição satisfaça uma consulta JMESPath personalizada. Por exemplo, provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Propriedade Valor
Parameter group: Wait Condition Arguments
--deleted

Aguarde até ser excluído.

Propriedade Valor
Parameter group: Wait Condition Arguments
Default value: False
--exists

Aguarde até que o recurso exista.

Propriedade Valor
Parameter group: Wait Condition Arguments
Default value: False
--interval

Intervalo de sondagem em segundos.

Propriedade Valor
Parameter group: Wait Condition Arguments
Default value: 30
--timeout

Espera máxima em segundos.

Propriedade Valor
Parameter group: Wait Condition Arguments
Default value: 3600
--updated

Aguarde até ser atualizado com provisioningState em 'Succeeded'.

Propriedade Valor
Parameter group: Wait Condition Arguments
Default value: False
Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False