Ce document 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 d'administration 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 respecter les conditions suivantes :
- Un déploiement Spanner Omni est configuré et en cours d'exécution.
- 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
Téléchargez la CLI Spanner Omni à partir du bucket Cloud Storage
spanner-omni.Extrayez le fichier tar.
tar -xvf CLI_TAR_FILECela installe le binaire de la CLI Spanner Omni, appelé
spanner, dans legoogle/spanner/binrépertoire.Pour exécuter la commande
spanner, ajoutez le répertoiregoogle/spanner/binà votrePATHvariable d'environnement, 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 répertorie 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 les 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 options globales 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
Répertorier toutes les bases de données
Pour répertorier 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 de shell SQL interactif
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'option --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.