snow object create¶

Syntaxe¶

snow object create
  <object_type>
  <object_attributes>
  --json <object_json>
  --if-not-exists
  --replace
  --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¶

object_type

Type d’objet. Par exemple, table, base de données, pool de calcul.

object_attributes...

Attributs d’objet fournis sous forme de liste de paires clé=valeur, par exemple name=my_db comment=”created with Snowflake CLI”. Consultez la documentation pour obtenir la liste complète des paramètres disponibles pour chaque objet.

Options¶

--json TEXT

Définition d’objet au format JSON, par exemple “{« name »: « my_db », « comment »: « created with Snowflake CLI »}”. Consultez la documentation pour obtenir la liste complète des paramètres disponibles pour chaque objet.

--if-not-exists

Cette opération ne s’applique que si l’objet spécifié n’existe pas encore. Par défaut : false.

--replace

Remplacez cet objet s’il existe déjà. Par défaut : false.

--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 snow object create crée l’un des types d’objets Snowflake suivants, en fonction des attributs ou des définitions d’objet fournis :

• account

• catalog-integration

• compute-pool

• database

• database-role

• dynamic-table

• event-table

• external-volume

• function

• image-repository

• managed-account

• network-policy

• notebook

• notification-integration

• pipe

• procedure

• role

• schema

• service

• stage

• stream

• table

• task

• user-defined-function

• view

• warehouse

Pour chaque objet, vous devez spécifier les détails d’objet appropriés à l’aide des attributs d’objet ou des définitions d’objet.

• Utilisez le paramètre object_attributes qui spécifie les détails de l’objet sous la forme d’une série de paires <key>=<value>, telles que :

  snow object create database name=my_db comment="Created with Snowflake CLI"
  

  Copy

• Utilisez l’option --json object_definition pour spécifier les détails de l’objet comme JSON, tel que :

  snow object create table name=my_table columns='[{"name":"col1","datatype":"number", "nullable":false}]' constraints='[{"name":"prim_key", "column_names":["col1"], "constraint_type":"PRIMARY KEY"}]' --database my_db --schema public
  

  Copy

• Voir Exemples pour plus d’exemples.

Les sections suivantes décrivent les attributs que Snowflake CLI prend en charge pour les types d’objets sélectionnés.

• compute-pool

• base de données

• image-repository

• schéma

• service

• table

• tâche

• warehouse

Vous pouvez trouver des attributs pour d’autres types d’objets en vérifiant leurs références de commandes SQL CREATE correspondantes, telles que CREATE ACCOUNT.

Exemples¶

• Créez un objet de base de données à l’aide du paramètre codenowrap:option-attributes :

  snow object create database name=my_db comment='Created with Snowflake CLI'
  

  Copy

• Créez un objet de table à l’aide du paramètre codenowrap:option-attributes :

  snow object create table name=my_table columns='[{"name":"col1","datatype":"number", "nullable":false}]' constraints='[{"name":"prim_key", "column_names":["col1"], "constraint_type":"PRIMARY KEY"}]' --database my_db --schema public
  

  Copy

• Créez une base de données à l’aide de l’option --json object-definition :

  snow object create database --json '{"name":"my_db", "comment":"Created with Snowflake CLI"}'
  

  Copy

• Créez une table à l’aide de l’option --json object-definition :

  snow object create table --json "$(cat table.json)" --database my_db
  

  Copy

  où table.json contient les éléments suivants :

  {
    "name": "my_table",
    "columns": [
      {
        "name": "col1",
        "datatype": "number",
        "nullable": false
      }
    ],
    "constraints": [
      {
        "name": "prim_key",
        "column_names": ["col1"],
        "constraint_type": "PRIMARY KEY"
      }
    ]
  }
  

  Copy