Compartir a través de

az synapse sql-script

Administrar scripts SQL en un área de trabajo de Synapse.

Comandos

Nombre Description Tipo Estado
az synapse sql-script create

Cree o actualice un script SQL.

 Core GA
az synapse sql-script delete

Elimine un script SQL.

 Core GA
az synapse sql-script export

Exporte un script SQL.

 Core GA
az synapse sql-script import

Importe un script SQL.

 Core GA
az synapse sql-script list

Enumeración de scripts SQL en un área de trabajo de Synapse.

 Core GA
az synapse sql-script show

Obtenga un script SQL.

 Core GA
az synapse sql-script wait

Coloque la CLI en un estado de espera hasta que se cumpla una condición de un script sql.

 Core GA

az synapse sql-script create

Editar

Cree o actualice un 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]

Ejemplos

Cree un script SQL.

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

Parámetros requeridos

--file -f

Ruta de acceso del archivo de consulta SQL.

--name -n

Nombre del script SQL.

--workspace-name

Nombre del área de trabajo.

Parámetros opcionales

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

--additional-properties

Propiedades adicionales del script SQL.

--description

Descripción del script SQL.

--folder-name

Carpeta en la que se encuentra este script SQL. Si no se especifica, este script SQL aparecerá en el nivel raíz. Por ejemplo: carpeta/subcarpeta1.

--no-wait

No espere a que finalice la operación de ejecución prolongada.

Propiedad Valor
Valor predeterminado: False
--result-limit

Límite de resultados de la consulta SQL. El valor predeterminado es 5000. '-1' no es límite.

Propiedad Valor
Valor predeterminado: 5000
Valores aceptados: -1, 5000
--sql-database-name

Nombre de la base de datos SQL.

--sql-pool-name

Nombre del grupo de SQL.

Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Formato de salida.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False

az synapse sql-script delete

Editar

Elimine un script SQL.

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

Ejemplos

Elimine un script SQL.

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

Parámetros requeridos

--name -n

Nombre del script SQL.

--workspace-name

Nombre del área de trabajo.

Parámetros opcionales

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

--no-wait

No espere a que finalice la operación de ejecución prolongada.

Propiedad Valor
Valor predeterminado: False
Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Formato de salida.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False

az synapse sql-script export

Editar

Exporte un script SQL.

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

Ejemplos

Exporte un script SQL.

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

Parámetros requeridos

--output-folder

Ruta de exportación del script SQL.

--workspace-name

Nombre del área de trabajo.

Parámetros opcionales

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

--name -n

Nombre del script SQL.

Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Formato de salida.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False

az synapse sql-script import

Editar

Importe un 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]

Ejemplos

Importe un script SQL.

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

Parámetros requeridos

--file -f

Ruta de acceso del archivo de consulta SQL.

--name -n

Nombre del script SQL.

--workspace-name

Nombre del área de trabajo.

Parámetros opcionales

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

--additional-properties

Propiedades adicionales del script SQL.

--description

Descripción del script SQL.

--folder-name

Carpeta en la que se encuentra este script SQL. Si no se especifica, este script SQL aparecerá en el nivel raíz. Por ejemplo: carpeta/subcarpeta1.

--no-wait

No espere a que finalice la operación de ejecución prolongada.

Propiedad Valor
Valor predeterminado: False
--result-limit

Límite de resultados de la consulta SQL. El valor predeterminado es 5000. '-1' no es límite.

Propiedad Valor
Valor predeterminado: 5000
Valores aceptados: -1, 5000
--sql-database-name

Nombre de la base de datos SQL.

--sql-pool-name

Nombre del grupo de SQL.

Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Formato de salida.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False

az synapse sql-script list

Editar

Enumeración de scripts SQL en un área de trabajo de Synapse.

az synapse sql-script list --workspace-name

Ejemplos

Enumerar scripts SQL.

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

Parámetros requeridos

--workspace-name

Nombre del área de trabajo.

Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Formato de salida.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False

az synapse sql-script show

Editar

Obtenga un script SQL.

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

Ejemplos

Obtenga un script SQL.

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

Parámetros requeridos

--name -n

Nombre del script SQL.

--workspace-name

Nombre del área de trabajo.

Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Formato de salida.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False

az synapse sql-script wait

Editar

Coloque la CLI en un estado de espera hasta que se cumpla una condición de un script sql.

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

Parámetros requeridos

--name -n

Nombre del script SQL.

--workspace-name

Nombre del área de trabajo.

Parámetros opcionales

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

--created

Espere hasta que se cree con "provisioningState" en "Succeeded".

Propiedad Valor
Grupo de parámetros: Wait Condition Arguments
Valor predeterminado: False
--custom

Espere hasta que la condición cumpla una consulta JMESPath personalizada. Por ejemplo, provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Propiedad Valor
Grupo de parámetros: Wait Condition Arguments
--deleted

Espere hasta que se elimine.

Propiedad Valor
Grupo de parámetros: Wait Condition Arguments
Valor predeterminado: False
--exists

Espere hasta que exista el recurso.

Propiedad Valor
Grupo de parámetros: Wait Condition Arguments
Valor predeterminado: False
--interval

Intervalo de sondeo en segundos.

Propiedad Valor
Grupo de parámetros: Wait Condition Arguments
Valor predeterminado: 30
--timeout

Espera máxima en segundos.

Propiedad Valor
Grupo de parámetros: Wait Condition Arguments
Valor predeterminado: 3600
--updated

Espere hasta que se actualice con provisioningState en "Succeeded".

Propiedad Valor
Grupo de parámetros: Wait Condition Arguments
Valor predeterminado: False
Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Formato de salida.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False