déploiement du notebook snow¶
Charge un notebook et les fichiers requis dans une zone de préparation et crée un notebook Snowflake.
Syntaxe¶
snow notebook deploy
<entity_id>
--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¶
entity_id
ID de l’entité du notebook.
Options¶
--replace
Remplacez l’objet de notebook s’il existe déjà. 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.
--prune / --no-prune
Supprimez les fichiers qui existent dans la zone de préparation, mais pas dans le système de fichiers local. 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 notebook deploy
télécharge les fichiers locaux vers une zone de préparation et crée un nouvel objet de notebook dans la base de données et le schéma que vous avez choisis. Votre fichier de définition du projet doit spécifier le fichier notebook principal et l’entrepôt de requêtes. L’option --replace
remplace l’objet de notebook spécifié s’il existe déjà.
Exemples¶
L’exemple suivant télécharge les fichiers spécifiés dans votre fichier de définition de projet et crée un nouveau notebook nommé my_notebook
:
snow notebook deploy my_notebook
Uploading artifacts to @notebooks/my_notebook
Creating stage notebooks if not exists
Uploading artifacts
Creating notebook my_notebook
Notebook successfully deployed and available under https://snowflake.com/provider-deduced-from-connection/#/notebooks/DB.SCHEMA.MY_NOTEBOOK