Partager via

az synapse sql-script

Gérer des scripts SQL dans un espace de travail synapse.

Commandes

Nom Description Type État
az synapse sql-script create

Créez ou mettez à jour un script SQL.

 Core GA
az synapse sql-script delete

Supprimez un script SQL.

 Core GA
az synapse sql-script export

Exportez un script SQL.

 Core GA
az synapse sql-script import

Importez un script SQL.

 Core GA
az synapse sql-script list

Répertorier les scripts SQL dans un espace de travail synapse.

 Core GA
az synapse sql-script show

Obtenir un script SQL.

 Core GA
az synapse sql-script wait

Placez l’interface CLI dans un état d’attente jusqu’à ce qu’une condition d’un script sql soit remplie.

 Core GA

az synapse sql-script create

Modifier

Créez ou mettez à jour 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]

Exemples

Créez un script SQL.

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

Paramètres obligatoires

--file -f

Chemin du fichier de requête SQL.

--name -n

Nom du script SQL.

--workspace-name

Nom de l’espace de travail.

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--additional-properties

Propriétés supplémentaires du script SQL.

--description

Description du script SQL.

--folder-name

Dossier dans lequel se trouve ce script SQL. S’il n’est pas spécifié, ce script SQL apparaît au niveau racine. Par exemple : dossier/sous-dossier1.

--no-wait

Ne pas attendre la fin de l’opération de longue durée.

Propriété Valeur
Valeur par défaut: False
--result-limit

Limite des résultats de la requête SQL. La valeur par défaut est 5000. '-1' n’est pas limite.

Propriété Valeur
Valeur par défaut: 5000
Valeurs acceptées: -1, 5000
--sql-database-name

Nom de la base de données SQL.

--sql-pool-name

Nom du pool SQL.

Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut à l’aide de az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.

Propriété Valeur
Valeur par défaut: False

az synapse sql-script delete

Modifier

Supprimez un script SQL.

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

Exemples

Supprimez un script SQL.

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

Paramètres obligatoires

--name -n

Nom du script SQL.

--workspace-name

Nom de l’espace de travail.

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--no-wait

Ne pas attendre la fin de l’opération de longue durée.

Propriété Valeur
Valeur par défaut: False
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut à l’aide de az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.

Propriété Valeur
Valeur par défaut: False

az synapse sql-script export

Modifier

Exportez un script SQL.

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

Exemples

Exportez un script SQL.

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

Paramètres obligatoires

--output-folder

Chemin d’exportation du script SQL.

--workspace-name

Nom de l’espace de travail.

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--name -n

Nom du script SQL.

Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut à l’aide de az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.

Propriété Valeur
Valeur par défaut: False

az synapse sql-script import

Modifier

Importez 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]

Exemples

Importez un script SQL.

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

Paramètres obligatoires

--file -f

Chemin du fichier de requête SQL.

--name -n

Nom du script SQL.

--workspace-name

Nom de l’espace de travail.

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--additional-properties

Propriétés supplémentaires du script SQL.

--description

Description du script SQL.

--folder-name

Dossier dans lequel se trouve ce script SQL. S’il n’est pas spécifié, ce script SQL apparaît au niveau racine. Par exemple : dossier/sous-dossier1.

--no-wait

Ne pas attendre la fin de l’opération de longue durée.

Propriété Valeur
Valeur par défaut: False
--result-limit

Limite des résultats de la requête SQL. La valeur par défaut est 5000. '-1' n’est pas limite.

Propriété Valeur
Valeur par défaut: 5000
Valeurs acceptées: -1, 5000
--sql-database-name

Nom de la base de données SQL.

--sql-pool-name

Nom du pool SQL.

Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut à l’aide de az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.

Propriété Valeur
Valeur par défaut: False

az synapse sql-script list

Modifier

Répertorier les scripts SQL dans un espace de travail synapse.

az synapse sql-script list --workspace-name

Exemples

Répertorier les scripts SQL.

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

Paramètres obligatoires

--workspace-name

Nom de l’espace de travail.

Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut à l’aide de az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.

Propriété Valeur
Valeur par défaut: False

az synapse sql-script show

Modifier

Obtenir un script SQL.

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

Exemples

Obtenir un script SQL.

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

Paramètres obligatoires

--name -n

Nom du script SQL.

--workspace-name

Nom de l’espace de travail.

Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut à l’aide de az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.

Propriété Valeur
Valeur par défaut: False

az synapse sql-script wait

Modifier

Placez l’interface CLI dans un état d’attente jusqu’à ce qu’une condition d’un script sql soit remplie.

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

Paramètres obligatoires

--name -n

Nom du script SQL.

--workspace-name

Nom de l’espace de travail.

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--created

Attendez la création avec « provisioningState » sur « Succeeded ».

Propriété Valeur
Groupe de paramètres: Wait Condition Arguments
Valeur par défaut: False
--custom

Attendez que la condition réponde à une requête JMESPath personnalisée. Par exemple, provisioningState !='InProgress', instanceView.statuses[ ?code=='PowerState/running'].

Propriété Valeur
Groupe de paramètres: Wait Condition Arguments
--deleted

Attendez la suppression.

Propriété Valeur
Groupe de paramètres: Wait Condition Arguments
Valeur par défaut: False
--exists

Attendez que la ressource existe.

Propriété Valeur
Groupe de paramètres: Wait Condition Arguments
Valeur par défaut: False
--interval

Intervalle d’interrogation en secondes.

Propriété Valeur
Groupe de paramètres: Wait Condition Arguments
Valeur par défaut: 30
--timeout

Délai maximal d’attente en secondes.

Propriété Valeur
Groupe de paramètres: Wait Condition Arguments
Valeur par défaut: 3600
--updated

Attendez la mise à jour avec provisioningState sur « Réussi ».

Propriété Valeur
Groupe de paramètres: Wait Condition Arguments
Valeur par défaut: False
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut à l’aide de az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.

Propriété Valeur
Valeur par défaut: False