snow stage execute¶

Syntaxe¶

snow stage execute
  <stage_path>
  --on-error <on_error>
  --variable <variables>
  --connection <connection>
  --host <host>
  --port <port>
  --account <account>
  --user <user>
  --password <password>
  --authenticator <authenticator>
  --workload-identity-provider <workload_identity_provider>
  --private-key-file <private_key_file>
  --token <token>
  --token-file-path <token_file_path>
  --database <database>
  --schema <schema>
  --role <role>
  --warehouse <warehouse>
  --temporary-connection
  --mfa-passcode <mfa_passcode>
  --enable-diag
  --diag-log-path <diag_log_path>
  --diag-allowlist-path <diag_allowlist_path>
  --oauth-client-id <oauth_client_id>
  --oauth-client-secret <oauth_client_secret>
  --oauth-authorization-url <oauth_authorization_url>
  --oauth-token-request-url <oauth_token_request_url>
  --oauth-redirect-uri <oauth_redirect_uri>
  --oauth-scope <oauth_scope>
  --oauth-disable-pkce
  --oauth-enable-refresh-tokens
  --oauth-enable-single-use-refresh-tokens
  --client-store-temporary-credential
  --format <format>
  --verbose
  --debug
  --silent
  --enhanced-exit-codes

Arguments¶

stage_path

Chemin de la zone de préparation avec les fichiers à exécuter. Par exemple @stage/dev/*.

Options¶

--on-error [break|continue]

Que faire en cas d’erreur ? La valeur par défaut est break. La valeur par défaut est : break.

--variable, -D TEXT

Variables pour le contexte d’exécution ; par exemple : -D "<key>=<value>". Pour des fichiers SQL, les variables sont utilisées pour développer le modèle, et toute variable inconnue provoquera une erreur (pensez à intégrer des guillemets dans le fichier). Pour les fichiers Python, les variables sont utilisées pour mettre à jour le dictionnaire os.environ. Les clés fournies sont en majuscules pour respecter les meilleures pratiques. En cas de fichiers SQL, les valeurs des chaînes doivent être entre guillemets '' (pensez à intégrer des guillemets dans le fichier).

--connection, -c, --environment TEXT

Nom de la connexion, tel que défini dans votre fichier config.toml. Défaut : défaut.

--host TEXT

Adresse de l’hôte pour la connexion. Remplace la valeur spécifiée pour la connexion.

--port INTEGER

Port pour la connexion. Remplace la valeur spécifiée pour la connexion.

--account, --accountname TEXT

Nom attribué à votre compte Snowflake. Remplace la valeur spécifiée pour la connexion.

--user, --username TEXT

Nom d’utilisateur pour se connecter à Snowflake. Remplace la valeur spécifiée pour la connexion.

--password TEXT

Mot de passe Snowflake. Remplace la valeur spécifiée pour la connexion.

--authenticator TEXT

Authentificateur Snowflake. Remplace la valeur spécifiée pour la connexion.

--workload-identity-provider TEXT

Fournisseur d’identité de charge de travail (AWS, AZURE, GCP, OIDC). Remplace la valeur spécifiée pour la connexion.

--private-key-file, --private-key-path TEXT

Chemin du fichier de clé privée Snowflake. Remplace la valeur spécifiée pour la connexion.

--token TEXT

Jeton OAuth à utiliser lors de la connexion à Snowflake.

--token-file-path TEXT

Chemin d’accès au fichier contenant un jeton OAuth à utiliser lors de la connexion à Snowflake.

--database, --dbname TEXT

Base de données à utiliser. Remplace la valeur spécifiée pour la connexion.

--schema, --schemaname TEXT

Schéma de la base de données à utiliser. Remplace la valeur spécifiée pour la connexion.

--role, --rolename TEXT

Rôle à utiliser. Remplace la valeur spécifiée pour la connexion.

--warehouse TEXT

Entrepôt à utiliser. Remplace la valeur spécifiée pour la connexion.

--temporary-connection, -x

Utilise une connexion définie avec les paramètres de la ligne de commande, au lieu d’une connexion définie dans la configuration. Par défaut : false.

--mfa-passcode TEXT

Jeton à utiliser pour l’authentification multifactorielle (MFA)

--enable-diag

Indique s’il faut générer un rapport de diagnostic de la connexion. Par défaut : false.

--diag-log-path TEXT

Chemin d’accès au rapport généré. Il s’agit du répertoire temporaire du système par défaut. Par défaut : <system_temporary_directory>.

--diag-allowlist-path TEXT

Chemin d’accès à un fichier JSON contenant les paramètres de la liste d’autorisations.

--oauth-client-id TEXT

Valeur de l’identifiant du client fourni par le fournisseur d’identité pour l’intégration dans Snowflake.

--oauth-client-secret TEXT

Valeur du secret du client fourni par le fournisseur d’identité pour l’intégration dans Snowflake.

--oauth-authorization-url TEXT

Point de terminaison du fournisseur d’identité fournissant le code d’autorisation au pilote.

--oauth-token-request-url TEXT

Point de terminaison du fournisseur d’identité fournissant les jetons d’accès au pilote.

--oauth-redirect-uri TEXT

URI à utiliser pour la redirection du code d’autorisation.

--oauth-scope TEXT

Champ d’application demandé dans la requête d’autorisation du fournisseur d’identité.

--oauth-disable-pkce

Désactive la clé de preuve pour l’échange de code (PKCE). Par défaut : False.

--oauth-enable-refresh-tokens

Permet une réauthentification silencieuse lorsque le jeton d’accès actuel n’est plus valable. Par défaut : False.

--oauth-enable-single-use-refresh-tokens

Indique s’il faut choisir une sémantique de jeton d’actualisation à usage unique. Par défaut : False.

--client-store-temporary-credential

Enregistrez les identifiants de connexion temporaires.

--format [TABLE|JSON|JSON_EXT|CSV]

Spécifie le format de sortie. Par défaut : TABLE.

--verbose, -v

Affiche les entrées de journal pour les niveaux de journalisation info et supérieurs. Par défaut : false.

--debug

Affiche les entrées de journal pour les niveaux de journalisation debug et supérieurs ; les journaux de débogage contiennent des informations supplémentaires. Par défaut : false.

--silent

Désactive la sortie intermédiaire vers la console. Par défaut : false.

--enhanced-exit-codes

Différenciez les codes d’erreur de sortie en fonction du type d’erreur. Par défaut : false.

--help

Affiche le texte d’aide de cette commande.

Notes sur l’utilisation¶

• La commande recherche les fichiers ayant une extension .sql dans le répertoire STAGE_PATH spécifié et exécute EXECUTE IMMEDIATE sur chacun d’entre eux. STAGE_PATH peut être :

  • Uniquement un nom de zone de préparation, tel que @scripts, qui exécute tous les fichiers .sql de la zone de préparation.

  • Modèle de type global, tel que @scripts/dir/*, qui exécute les fichiers .sql à partir du répertoire dir.

  • Chemin d’accès direct au fichier, tel que @scripts/script.sql, qui exécute uniquement le fichier script.sql à partir du fichier scripts.

Les options --silent permettent de masquer les messages intermédiaires avec les résultats de l’exécution du fichier.

Lorsque vous utilisez des modèles Jinja pour les fichiers SQL, vous pouvez transmettre des variables de modèle en utilisant l’option -D (ou --variable), comme -D "<clé>=<valeur>". Les valeurs des chaînes doivent être placées entre guillemets simples ('').

Exemples¶

• Spécifiez uniquement un nom de zone de préparation pour exécuter tous les fichiers .sql de cette zone de préparation :

  snow stage execute "@scripts"
  

  Copy

  SUCCESS - scripts/script1.sql
  SUCCESS - scripts/script2.sql
  SUCCESS - scripts/dir/script.sql
  +------------------------------------------+
  | File                   | Status  | Error |
  |------------------------+---------+-------|
  | scripts/script1.sql    | SUCCESS | None  |
  | scripts/script2.sql    | SUCCESS | None  |
  | scripts/dir/script.sql | SUCCESS | None  |
  +------------------------------------------+
  

• Spécifiez un modèle de type global pour exécuter tous les fichiers .sql dans le répertoire dir :

  snow stage execute "@scripts/dir/*"
  

  Copy

  SUCCESS - scripts/dir/script.sql
  +------------------------------------------+
  | File                   | Status  | Error |
  |------------------------+---------+-------|
  | scripts/dir/script.sql | SUCCESS | None  |
  +------------------------------------------+
  

• Spécifiez un modèle de type glob pour exécuter uniquement les fichiers .sql du répertoire dir qui commencent par « script », suivi d’un caractère :

  snow stage execute "@scripts/script?.sql"
  

  Copy

  SUCCESS - scripts/script1.sql
  SUCCESS - scripts/script2.sql
  +---------------------------------------+
  | File                | Status  | Error |
  |---------------------+---------+-------|
  | scripts/script1.sql | SUCCESS | None  |
  | scripts/script2.sql | SUCCESS | None  |
  +---------------------------------------+
  

• Spécifiez un chemin d’accès direct au fichier avec l’option --silent :

  snow stage execute "@scripts/script1.sql" --silent
  

  Copy

  +---------------------------------------+
  | File                | Status  | Error |
  |---------------------+---------+-------|
  | scripts/script1.sql | SUCCESS | None  |
  +---------------------------------------+