snow snowpark deploy¶
Déploie les procédures et les fonctions définies dans le projet. Le déploiement du projet modifie tous les objets qui y sont définis. Par défaut, si l’un des objets existe déjà, les commandes échoueront à moins que l’indicateur --replace
ne soit fourni. Les artefacts requis sont déployés avant la création de fonctions ou de procédures. Les dépendances sont déployées une fois à chaque étape spécifiée dans les définitions.
Syntaxe¶
snow snowpark deploy
--replace
--force-replace
--prune / --no-prune
--project <project_definition>
--env <env_overrides>
--connection <connection>
--host <host>
--port <port>
--account <account>
--user <user>
--password <password>
--authenticator <authenticator>
--private-key-file <private_key_file>
--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¶
Aucun(e)
Options¶
--replace
Remplace la procédure ou la fonction si la définition a été modifiée. Il télécharge uniquement les nouveaux fichiers et écrase les fichiers existants, mais ne supprime pas les fichiers déjà présents sur la zone de préparation. Par défaut : false.
--force-replace
Remplacez cet objet, même si l’état n’a pas changé. Par défaut : false.
--prune / --no-prune
Supprimez le contenu de la zone de préparation avant de charger les artefacts. Par défaut : false.
-p, --project TEXT
Chemin où le projet Snowflake est stocké. La valeur par défaut est le répertoire de travail actuel.
--env TEXT
Chaîne au format clé=valeur. Remplace les variables de la section env utilisées pour les modèles. Par défaut : [].
--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.
--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-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]
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 snow snowpark deploy
permet d’effectuer les opérations suivantes :
Vérifie si les objets listés pour le déploiement existent déjà. Si les objets existent, vous devez utiliser l’option
--replace
.Note
Si vous souhaitez mettre à jour des objets et des fichiers, même s’ils n’ont pas changé, vous pouvez utiliser l’option
--force-replace
.Crée une zone de préparation dans la base de données spécifiée pour votre connexion. Si aucune zone de préparation n’est définie, la commande crée une zone de préparation nommée
deployments
.Si l’option
--prune
a été spécifiée, supprime le contenu existant de la zone de préparation utilisée par les objets de procédure et de fonction définis.Charge les nouveaux artefacts.
Crée les objets spécifiés dans le fichier
snowflake.yml
en exécutant les requêtes SQL CREATE PROCEDURE ou CREATE FUNCTION.
La commande déploie le code source et les dépendances à partir de la version la plus récente. Si vous avez modifié le code ou ajouté des exigences depuis la dernière version intermédiaire, vous devez exécuter à nouveau la commande snow snowpark build avant de déployer la nouvelle version.
Exemples¶
L’exemple suivant montre comment déployer des fonctions et des procédures dans le répertoire actuel.
snow snowpark deploy
+-----------------------------------------------------------------------------------+
| object | type | status |
|----------------------------------------------------+-----------+------------------|
| MY_DATABASE.PUBLIC.HELLO_PROCEDURE(name string) | procedure | packages updated |
| MY_DATABASE.PUBLIC.TEST_PROCEDURE() | procedure | created |
| MY_DATABASE.PUBLIC.HELLO_FUNCTION(name string) | function | packages updated |
+-----------------------------------------------------------------------------------+
L’exemple suivant montre ce qui se passe lorsque des objets existent déjà et que vous les déployez sans spécifier l’option --replace
.
snow snowpark deploy
╭─ Error ──────────────────────────────────────────────────────────╮
│ Following objects already exists. Consider using --replace. |
│ function: MY_DATABASE.PUBLIC.HELLO_FUNCTION(string) |
│ procedure: MY_DATABASE.PUBLIC.HELLO_PROCEDURE(string) |
│ procedure: MY_DATABASE.PUBLIC.TEST_PROCEDURE() |
╰──────────────────────────────────────────────────────────────────╯