Guide de démarrage rapide avec la CLI Spanner Omni

Ce document vous explique comment utiliser l'interface de ligne de commande (CLI) Spanner Omni pour interagir avec un déploiement Spanner Omni et le gérer. La CLI Spanner Omni fournit des commandes pour les tâches administratives courantes et inclut un shell SQL interactif pour interroger votre base de données.

Avant de commencer

Avant de pouvoir utiliser la CLI Spanner Omni, assurez-vous de remplir les conditions suivantes :

  1. Un déploiement Spanner Omni est configuré et en cours d'exécution.
  2. La machine exécutant la CLI Spanner Omni dispose d'un accès réseau à l'équilibreur de charge du déploiement Spanner Omni ou à au moins l'un des serveurs du déploiement.

Étape 1 : Téléchargez et installez la CLI Spanner Omni

  1. Téléchargez la CLI Spanner Omni depuis le bucket Cloud Storage spanner-omni.

    Accéder au bucket Spanner Omni

  2. Extrayez le fichier tar.

    tar -xvf CLI_TAR_FILE

    Cela installe le binaire Spanner Omni CLI, appelé spanner, dans le répertoire google/spanner/bin.

    Pour exécuter la commande spanner, ajoutez le répertoire google/spanner/bin à votre variable d'environnement PATH ou utilisez le chemin d'accès complet au binaire dans les étapes suivantes.

Étape 2 : Connectez-vous à votre déploiement

Par défaut, la CLI Spanner Omni tente de se connecter à localhost:15000. Pour vous connecter à votre déploiement spécifique, utilisez l'option --deployment-endpoint.

Par exemple, la commande suivante liste les zones de votre déploiement :

spanner deployment zones list \
    --deployment-endpoint=LOAD_BALANCER_IP_OR_SERVER_IP:PORT

Étape 3 : Exécutez des commandes courantes

Voici quelques commandes d'administration courantes que vous pouvez exécuter avec la CLI Spanner Omni.

Obtenir de l'aide

Pour afficher la liste des commandes et des indicateurs globaux disponibles, exécutez la commande suivante :

spanner --help

Créer une base de données

Pour créer une base de données dans votre déploiement, exécutez la commande suivante :

spanner databases create DATABASE_NAME \
    --deployment-endpoint=LOAD_BALANCER_IP_OR_SERVER_IP:PORT

Lister toutes les bases de données

Pour lister toutes les bases de données de votre déploiement, exécutez la commande suivante :

spanner databases list \
    --deployment-endpoint=LOAD_BALANCER_IP_OR_SERVER_IP:PORT

Étape 4 : Démarrer une session shell SQL interactive

La CLI Spanner Omni inclut un shell SQL interactif pour exécuter des requêtes. En démarrant le shell pour une base de données spécifique avec l'indicateur --database, vous pouvez exécuter des commandes SQL sans avoir à spécifier la base de données ni le point de terminaison pour chaque requête.

Pour démarrer le shell SQL, exécutez la commande suivante :

spanner sql --database=DATABASE_NAME \
    --deployment-endpoint=LOAD_BALANCER_IP_OR_SERVER_IP:PORT

Une fois le shell démarré, l'invite sql> s'affiche :

spanner-cli>

Pour quitter le shell, saisissez exit.