Installation de Snowflake CLI

Cette rubrique explique comment installer Snowflake CLI sur toutes les plateformes prises en charge par. Noter que Snowflake CLI n’est pas actuellement disponible pour les systèmes AIX.

Snowflake recommande d’utiliser des méthodes d’installation binaires, telles que des gestionnaires de paquets, pour installer Snowflake CLI sur votre système. Vous pouvez télécharger les programmes d’installation binaires à partir du référentiel de CLI Snowflake.

Exigences

  • Avant d’utiliser Snowflake CLI, vous devez disposer d’un compte Snowflake valide.

  • Pour exécuter Streamlit dans Snowflake à l’aide de Snowflake CLI, vous devez disposer d’un compte Snowflake avec l’autorisation d’utiliser Streamlit.

  • Pour exécuter Snowpark Container Services dans Snowflake à l’aide de Snowflake CLI, vous devez disposer d’un compte Snowflake doté des privilèges nécessaires à l’utilisation de Snowpark Container Services.

Astuce

Si votre compte Snowflake nécessite MFA (authentification multifactorielle), Snowflake CLI nécessite une approbation pour chaque commande. Vous pouvez utiliser la mise en cache MFA pour ne nécessiter l’authentification qu’une fois toutes les quatre heures. Pour plus d’informations, voir Utiliser l’authentification multifactorielle (MFA).

Installer Snowflake CLI à l’aide de gestionnaires de paquets

Pour installer Snowflake CLI à l’aide de gestionnaires de paquets spécifiques à une plateforme, utilisez l’une des procédures suivantes :

Installer à l’aide de gestionnaires de paquets Linux

Si vous utilisez un système d’exploitation Linux, vous pouvez installer Snowflake CLI avec des gestionnaires de paquets qui prennent en charge les éléments suivants :

  • paquets deb,

  • paquets rpm.

Pour installer Snowflake CLI en utilisant le gestionnaire de paquets deb :

  1. Téléchargez Snowflake CLI deb depuis le référentiel de CLI Snowflake.

  2. Installez le paquet en exécutant la commande suivante :

    sudo dpkg -i snowflake-cli-<version>.deb
    
    Copy

Pour installer Snowflake CLI en utilisant le gestionnaire de paquets rpm :

  1. Téléchargez le paquet Snowflake CLI rpm à partir du référentiel de CLI Snowflake.

  2. Installez le paquet en exécutant la commande suivante :

    sudo rpm -i snowflake-cli-<version>.deb
    
    Copy
  3. Pour vérifier que le logiciel a été installé avec succès, exécutez la commande suivante :

    snow --help
    
    Copy
    Usage: snow [OPTIONS] COMMAND [ARGS]...
    
    Snowflake CLI tool for developers.
    
    ╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
    │ --version                           Shows version of the Snowflake CLI                                                                   │
    │ --info                              Shows information about the Snowflake CLI                                                            │
    │ --config-file                 FILE  Specifies Snowflake CLI configuration file that should be used [default: None]                       │
    │ --install-completion                Install completion for the current shell.                                                            │
    │ --show-completion                   Show completion for the current shell, to copy it or customize the installation.                     │
    │ --help                -h            Show this message and exit.                                                                          │
    ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
    ╭─ Commands ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
    │ app          Manages a Snowflake Native App                                                                                              │
    │ connection   Manages connections to Snowflake.                                                                                           │
    │ cortex       Provides access to Snowflake Cortex.                                                                                        │
    │ git          Manages git repositories in Snowflake.                                                                                      │
    │ notebook     Manages notebooks in Snowflake.                                                                                             │
    │ object       Manages Snowflake objects like warehouses and stages                                                                        │
    │ snowpark     Manages procedures and functions.                                                                                           │
    │ spcs         Manages Snowpark Container Services compute pools, services, image registries, and image repositories.                      │
    │ sql          Executes Snowflake query.                                                                                                   │
    │ stage        Manages stages.                                                                                                             │
    │ streamlit    Manages a Streamlit app in Snowflake.                                                                                       │
    ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
    
  4. Configurer la connexion Snowflake.

Installer avec le programme d’installation de paquets MacOS

Pour installer Snowflake CLI sur MacOS, procédez comme suit :

  1. Téléchargez le programme d’installation Snowflake CLI depuis le référentiel de CLI Snowflake.

  2. Exécutez le programme d’installation et suivez les instructions pour installer Snowflake CLI.

  3. Pour vérifier que le logiciel a été installé avec succès, ouvrez un nouveau terminal et exécutez la commande suivante :

    snow --help
    
    Copy
    Usage: snow [OPTIONS] COMMAND [ARGS]...
    
    Snowflake CLI tool for developers.
    
    ╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
    │ --version                           Shows version of the Snowflake CLI                                                                   │
    │ --info                              Shows information about the Snowflake CLI                                                            │
    │ --config-file                 FILE  Specifies Snowflake CLI configuration file that should be used [default: None]                       │
    │ --install-completion                Install completion for the current shell.                                                            │
    │ --show-completion                   Show completion for the current shell, to copy it or customize the installation.                     │
    │ --help                -h            Show this message and exit.                                                                          │
    ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
    ╭─ Commands ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
    │ app          Manages a Snowflake Native App                                                                                              │
    │ connection   Manages connections to Snowflake.                                                                                           │
    │ cortex       Provides access to Snowflake Cortex.                                                                                        │
    │ git          Manages git repositories in Snowflake.                                                                                      │
    │ notebook     Manages notebooks in Snowflake.                                                                                             │
    │ object       Manages Snowflake objects like warehouses and stages                                                                        │
    │ snowpark     Manages procedures and functions.                                                                                           │
    │ spcs         Manages Snowpark Container Services compute pools, services, image registries, and image repositories.                      │
    │ sql          Executes Snowflake query.                                                                                                   │
    │ stage        Manages stages.                                                                                                             │
    │ streamlit    Manages a Streamlit app in Snowflake.                                                                                       │
    ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
    
  4. Configurer la connexion Snowflake.

Installer avec le programme d’installation de Windows

Pour installer Snowflake CLI sous Windows, procédez comme suit :

  1. Téléchargez le programme d’installation Snowflake CLI depuis le référentiel de CLI Snowflake.

  2. Exécutez le programme d’installation et suivez les instructions pour installer Snowflake CLI.

  3. Pour vérifier que le logiciel a été installé avec succès, ouvrez un nouveau terminal et exécutez la commande suivante :

    snow --help
    
    Copy
    Usage: snow [OPTIONS] COMMAND [ARGS]...
    
    Snowflake CLI tool for developers.
    
    ╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
    │ --version                           Shows version of the Snowflake CLI                                                                   │
    │ --info                              Shows information about the Snowflake CLI                                                            │
    │ --config-file                 FILE  Specifies Snowflake CLI configuration file that should be used [default: None]                       │
    │ --install-completion                Install completion for the current shell.                                                            │
    │ --show-completion                   Show completion for the current shell, to copy it or customize the installation.                     │
    │ --help                -h            Show this message and exit.                                                                          │
    ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
    ╭─ Commands ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
    │ app          Manages a Snowflake Native App                                                                                              │
    │ connection   Manages connections to Snowflake.                                                                                           │
    │ cortex       Provides access to Snowflake Cortex.                                                                                        │
    │ git          Manages git repositories in Snowflake.                                                                                      │
    │ notebook     Manages notebooks in Snowflake.                                                                                             │
    │ object       Manages Snowflake objects like warehouses and stages                                                                        │
    │ snowpark     Manages procedures and functions.                                                                                           │
    │ spcs         Manages Snowpark Container Services compute pools, services, image registries, and image repositories.                      │
    │ sql          Executes Snowflake query.                                                                                                   │
    │ stage        Manages stages.                                                                                                             │
    │ streamlit    Manages a Streamlit app in Snowflake.                                                                                       │
    ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
    
  4. Configurer la connexion Snowflake.

Installer avec Homebrew

Si vous utilisez un système d’exploitation Mac, vous pouvez installer Snowflake CLI avec Homebrew.

  1. Installer Homebrew, si nécessaire.

  2. Pour donner à Homebrew l’accès au référentiel Snowflake CLI, exécutez la commande suivante :

    brew tap snowflakedb/snowflake-cli
    brew update
    
    Copy
  3. Pour installer Snowflake CLI; exécutez la commande suivante :

    brew install snowflake-cli
    
    Copy
  4. Pour vérifier que le logiciel a été installé avec succès, exécutez la commande suivante :

    snow --help
    
    Copy
    Usage: snow [OPTIONS] COMMAND [ARGS]...
    
    Snowflake CLI tool for developers.
    
    ╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
    │ --version                           Shows version of the Snowflake CLI                                                                   │
    │ --info                              Shows information about the Snowflake CLI                                                            │
    │ --config-file                 FILE  Specifies Snowflake CLI configuration file that should be used [default: None]                       │
    │ --install-completion                Install completion for the current shell.                                                            │
    │ --show-completion                   Show completion for the current shell, to copy it or customize the installation.                     │
    │ --help                -h            Show this message and exit.                                                                          │
    ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
    ╭─ Commands ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
    │ app          Manages a Snowflake Native App                                                                                              │
    │ connection   Manages connections to Snowflake.                                                                                           │
    │ cortex       Provides access to Snowflake Cortex.                                                                                        │
    │ git          Manages git repositories in Snowflake.                                                                                      │
    │ notebook     Manages notebooks in Snowflake.                                                                                             │
    │ object       Manages Snowflake objects like warehouses and stages                                                                        │
    │ snowpark     Manages procedures and functions.                                                                                           │
    │ spcs         Manages Snowpark Container Services compute pools, services, image registries, and image repositories.                      │
    │ sql          Executes Snowflake query.                                                                                                   │
    │ stage        Manages stages.                                                                                                             │
    │ streamlit    Manages a Streamlit app in Snowflake.                                                                                       │
    ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
    
  5. Configurer la connexion Snowflake.

Installer avec pip (PyPi)

Note

Cette méthode modifie l’environnement Python dans lequel vous installez Snowflake CLI. Envisagez plutôt d’utiliser pipx pour éviter les conflits de dépendance.

Pour installer Snowflake CLI à l’aide de pip, vous devez avoir installé Python version 3.10 ou une version ultérieure.

  1. Exécutez la commande shell suivante :

    pip install snowflake-cli
    
    Copy
  2. Pour vérifier que le logiciel a été installé avec succès, exécutez la commande suivante :

    snow --help
    
    Copy
    Usage: snow [OPTIONS] COMMAND [ARGS]...
    
    Snowflake CLI tool for developers.
    
    ╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
    │ --version                           Shows version of the Snowflake CLI                                                                   │
    │ --info                              Shows information about the Snowflake CLI                                                            │
    │ --config-file                 FILE  Specifies Snowflake CLI configuration file that should be used [default: None]                       │
    │ --install-completion                Install completion for the current shell.                                                            │
    │ --show-completion                   Show completion for the current shell, to copy it or customize the installation.                     │
    │ --help                -h            Show this message and exit.                                                                          │
    ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
    ╭─ Commands ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
    │ app          Manages a Snowflake Native App                                                                                              │
    │ connection   Manages connections to Snowflake.                                                                                           │
    │ cortex       Provides access to Snowflake Cortex.                                                                                        │
    │ git          Manages git repositories in Snowflake.                                                                                      │
    │ notebook     Manages notebooks in Snowflake.                                                                                             │
    │ object       Manages Snowflake objects like warehouses and stages                                                                        │
    │ snowpark     Manages procedures and functions.                                                                                           │
    │ spcs         Manages Snowpark Container Services compute pools, services, image registries, and image repositories.                      │
    │ sql          Executes Snowflake query.                                                                                                   │
    │ stage        Manages stages.                                                                                                             │
    │ streamlit    Manages a Streamlit app in Snowflake.                                                                                       │
    ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
    
  3. Configurer la connexion Snowflake.

Installer avec pipx

pipx fournit une alternative à pip qui installe et exécute des paquets Python dans des environnements virtuels isolés. L’installation de Snowflake CLI avec pipx ne modifie donc pas votre environnement Python actuel.

Pour installer Snowflake CLI à l’aide de pipx, vous devez avoir installé pipx.

  1. Exécutez la commande shell suivante :

    pipx install snowflake-cli-labs
    
    Copy
  2. Pour vérifier que le logiciel a été installé avec succès, exécutez la commande suivante :

    snow --help
    
    Copy
    Usage: snow [OPTIONS] COMMAND [ARGS]...
    
    Snowflake CLI tool for developers.
    
    ╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
    │ --version                           Shows version of the Snowflake CLI                                                                   │
    │ --info                              Shows information about the Snowflake CLI                                                            │
    │ --config-file                 FILE  Specifies Snowflake CLI configuration file that should be used [default: None]                       │
    │ --install-completion                Install completion for the current shell.                                                            │
    │ --show-completion                   Show completion for the current shell, to copy it or customize the installation.                     │
    │ --help                -h            Show this message and exit.                                                                          │
    ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
    ╭─ Commands ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
    │ app          Manages a Snowflake Native App                                                                                              │
    │ connection   Manages connections to Snowflake.                                                                                           │
    │ cortex       Provides access to Snowflake Cortex.                                                                                        │
    │ git          Manages git repositories in Snowflake.                                                                                      │
    │ notebook     Manages notebooks in Snowflake.                                                                                             │
    │ object       Manages Snowflake objects like warehouses and stages                                                                        │
    │ snowpark     Manages procedures and functions.                                                                                           │
    │ spcs         Manages Snowpark Container Services compute pools, services, image registries, and image repositories.                      │
    │ sql          Executes Snowflake query.                                                                                                   │
    │ stage        Manages stages.                                                                                                             │
    │ streamlit    Manages a Streamlit app in Snowflake.                                                                                       │
    ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
    
  3. Configurer la connexion Snowflake.

Installer la fonctionnalité d’auto-remplissage des commandes

Snowflake CLI prend en charge la fonctionnalité standard d’achèvement des tabulations de l’interpréteur de commandes.

Pour installer l’auto-remplissage dans Snowflake CLI, procédez comme suit :

  1. Exécutez la commande snow --install-completion :

    snow --install-completion
    
    Copy
    zsh completion installed in <user home>/.zfunc/_snow
    Completion will take effect once you restart the terminal
    
  2. Exécutez la commande snow --show-completion pour générer les commandes que vous devez ajouter à votre profil shell (.bashrc, .bash_profile, .zshrc, et autres) :

    snow --show-completion
    
    Copy
    _snow_completion() {
       local IFS=$'
    '
       COMPREPLY=( $( env COMP_WORDS="${COMP_WORDS[*]}" \
                      COMP_CWORD=$COMP_CWORD \
                      _SNOW_COMPLETE=complete_bash $1 ) )
       return 0
    }
    
    complete -o default -F _snow_completion snow
    
  3. Sélectionnez et copiez le texte de sortie de la commande.

  4. Ouvrez votre fichier de profil shell, .bashrc dans cet exemple, et collez le texte copié :

    export SHELL=/bin/bash
    
    ...
    
    _snow_completion() {
       local IFS=$'
    '
       COMPREPLY=( $( env COMP_WORDS="${COMP_WORDS[*]}" \
                      COMP_CWORD=$COMP_CWORD \
                      _SNOW_COMPLETE=complete_bash $1 ) )
       return 0
    }
    
    complete -o default -F _snow_completion snow
    
  5. Sauvegardez le fichier.

  6. Pour activer la fonctionnalité d’achèvement des tabulations, redémarrez votre interpréteur de commande ou source votre fichier de profil de shell, par exemple :

    source ~/.bashrc
    
    Copy
  7. Pour tester la fonction, entrez une commande snow suivie d’un TAB, comme indiqué :

    snow app [TAB]
    
    Copy
    deploy    init      open      run       teardown  version