Démarrage rapide de la CLI Spanner

Preview — Spanner CLI

Cette fonctionnalité est soumise aux "Conditions des offres de pré-DG" de la section "Conditions générales du service" des Conditions spécifiques du service. Les fonctionnalités de pré-DG sont disponibles "en l'état" et peuvent avoir une prise en charge limitée. Pour en savoir plus, consultez les descriptions des étapes de lancement.

Remarque sur l'interface PostgreSQL : Pour les bases de données utilisant le dialecte PostgreSQL, vous pouvez utiliser l'outil de ligne de commande psql. Les exemples de ce document sont destinés aux bases de données GoogleSQL.

Cette page présente la CLI Spanner et explique comment l'utiliser.

L'interface de ligne de commande (CLI) Spanner vous permet de vous connecter à votre base de données Spanner et d'interagir avec elle. Elle est intégrée à la gcloud CLI pour interagir avec Spanner. Vous pouvez utiliser la CLI Spanner pour exécuter directement des instructions GoogleSQL dans votre base de données Spanner. Vos instructions peuvent être des instructions LDD (langage de définition de données), LMD (langage de manipulation de données) ou LQD (langage de requête de données). Vous pouvez utiliser la CLI Spanner pour exécuter des scripts de commandes SQL et automatiser des tâches.

Pour en savoir plus, consultez la liste de toutes les commandes gcloud alpha spanner cli compatibles.

Principaux avantages

Voici les principaux avantages de l'interface de ligne de commande Spanner :

• Exécute les commandes SQL LDD, LMD et DQL.
• Vous pouvez écrire et exécuter des instructions SQL sur plusieurs lignes.
• Il est compatible avec les métacommandes pour vous aider dans les tâches système, comme l'exécution d'une commande shell système et l'exécution de SQL à partir d'un fichier.
• Vous pouvez automatiser les exécutions SQL en écrivant une série d'instructions SQL dans un fichier de script, puis en demandant à l'interface de ligne de commande Spanner d'exécuter le script. Vous pouvez également rediriger la sortie vers un fichier de sortie.
• Vous pouvez démarrer une session interactive Spanner CLI, qui vous permet de saisir directement des instructions SQL et des métacommandes, et d'afficher les résultats dans la CLI.

Avant de commencer

La CLI Spanner est disponible dans la gcloud CLI. Lorsque vous exécutez la commande gcloud alpha spanner cli pour la première fois, gcloud CLI installe automatiquement le composant CLI Spanner.

Utiliser la CLI Spanner

1. Configurer un projet Google Cloud

2. Configurez l'authentification à l'aide de gcloud CLI.

3. Créez une instance.

4. Créez une base de données.

5. Exécutez la commande suivante pour démarrer la CLI Spanner et interagir avec votre base de données Spanner :

   gcloud alpha spanner cli DATABASE_ID --instance=INSTANCE_ID
   

   Remplacez les éléments suivants :

   • DATABASE_ID : ID de la base de données Spanner. Il s'agit du nom que vous avez utilisé à l'étape précédente "Créer une base de données". Vous pouvez utiliser la commande gcloud spanner databases list pour lister les bases de données Spanner contenues dans l'instance donnée.
   • INSTANCE_ID : ID de l'instance Spanner. Il s'agit du nom que vous avez utilisé à l'étape précédente "Créer une instance". Vous pouvez utiliser la commande gcloud spanner instances list pour lister les instances Spanner contenues dans le projet donné.

Exécuter du code SQL

Vous pouvez exécuter des instructions SQL dans la CLI Spanner à l'aide de l'option execute ou d'une méthode d'entrée et de sortie basée sur des fichiers. Vos instructions SQL peuvent être de type LDD, LMD ou DQL.

Utilisez l'option execute.

Pour utiliser l'option execute afin d'exécuter SQL, exécutez la commande gcloud alpha spanner cli suivante :

gcloud alpha spanner cli DATABASE_ID --instance INSTANCE_ID \
    --execute "SQL"

Remplacez les éléments suivants :

• DATABASE_ID : ID de la base de données Spanner à laquelle vous souhaitez vous connecter.
• INSTANCE_ID : ID de l'instance Spanner à laquelle vous souhaitez vous connecter.
• SQL : code SQL que vous souhaitez exécuter.

Par exemple, pour exécuter une instruction LDD :

gcloud alpha spanner cli test-database --instance test-instance \
    --execute "CREATE TABLE Singers ( \
        SingerId   INT64 NOT NULL, \
        FirstName  STRING(1024), \
        LastName   STRING(1024), \
        SingerInfo STRING(1024), \
        BirthDate  DATE \
      ) PRIMARY KEY(SingerId);"

Pour exécuter une instruction LMD :

gcloud alpha spanner cli test-database --instance test-instance \
    --execute "INSERT INTO Singers (SingerId, FirstName, LastName, SingerInfo) \
        VALUES(1, 'Marc', 'Richards', 'nationality: USA'), \
              (2, 'Catalina', 'Smith', 'nationality: Brazil'), \
              (3, 'Andrew', 'Duneskipper', NULL);"

Utiliser une entrée et une sortie basées sur des fichiers

Si vous utilisez la méthode d'entrée et de sortie basée sur des fichiers, Spanner lit son entrée à partir d'un fichier et écrit sa sortie dans un autre fichier. Pour exécuter le code SQL à l'aide de la méthode d'entrée et de sortie basée sur des fichiers, exécutez la commande suivante :

gcloud alpha spanner cli DATABASE_ID --instance INSTANCE_ID \
    --source INPUT_FILE_PATH --tee OUTPUT_FILE_PATH

Vous pouvez également utiliser la méthode d'entrée et de sortie de redirection basée sur des fichiers :

gcloud alpha spanner cli DATABASE_ID --instance INSTANCE_ID \
    < INPUT_FILE_PATH > OUTPUT_FILE_PATH

Remplacez les éléments suivants :

• DATABASE_ID : ID de la base de données Spanner à laquelle vous souhaitez vous connecter.
• INSTANCE_ID : ID de l'instance Spanner à laquelle vous souhaitez vous connecter.
• SOURCE_FILE_PATH : fichier contenant le code SQL que vous souhaitez exécuter.
• OUTPUT_FILE_PATH : nom du fichier auquel ajouter une copie du résultat SQL.

Démarrer une session interactive

Vous pouvez démarrer une session interactive Spanner CLI, qui vous permet de saisir directement des instructions SQL et des méta-commandes, et d'afficher les résultats dans la CLI. Pour ce faire, exécutez la commande suivante :

gcloud alpha spanner cli DATABASE_ID --instance=INSTANCE_ID

Une fois la connexion établie entre la CLI et votre base de données, une invite (par exemple, spanner-cli>) s'affiche. Vous pouvez alors effectuer les opérations suivantes :

• Saisissez directement des instructions GoogleSQL :
  • Documentation de référence sur le LDD GoogleSQL
  • Documentation de référence sur le LMD GoogleSQL
  • Syntaxe des requêtes GoogleSQL
• Exécuter des transactions
• Utiliser les méta-commandes compatibles

Après avoir appuyé sur la touche ENTER, l'instruction ou la commande est envoyée à la base de données Spanner appropriée. Spanner exécute ensuite l'instruction ou la commande.

Dans l'exemple suivant, vous démarrez une session interactive dans test-database, puis exécutez SELECT 1; :

gcloud alpha spanner cli test-database --instance test-instance

Welcome to Spanner-Cli Client.
Type 'help;' or '\h' for help.
Type 'exit;' or 'quit;' or '\q' to exit.

spanner-cli> SELECT 1;
+---+
|   |
+---+
| 1 |
+---+

1 rows in set (1.11 msecs)

Exécuter une instruction LDD

Pour exécuter une instruction LDD, vous pouvez exécuter la commande suivante :

spanner-cli> CREATE TABLE Singers (
          ->         SingerId   INT64 NOT NULL,
          ->         FirstName  STRING(1024),
          ->         LastName   STRING(1024),
          ->         SingerInfo STRING(1024),
          ->         BirthDate  DATE
          -> ) PRIMARY KEY(SingerId);

Query OK, 0 rows affected (17.08 sec)

Exécuter une instruction LMD

Pour exécuter une instruction LMD, vous pouvez exécuter la commande suivante :

spanner-cli> INSERT INTO Singers (SingerId, FirstName, LastName, SingerInfo)
          -> VALUES(1, 'Marc', 'Richards', 'nationality: USA'),
          -> (2, 'Catalina', 'Smith', 'nationality: Brazil'),
          -> (3, 'Andrew', 'Duneskipper', NULL);

Query OK, 3 rows affected (0.32 sec)

Métacommandes acceptées

La CLI Spanner accepte les méta-commandes utilitaires, qui sont des commandes fonctionnant sur le client, en l'occurrence la CLI Spanner. Les méta-commandes suivantes sont acceptées dans la CLI Spanner :

Commande	Syntaxe	Description
?	\?	Affiche des informations d'aide. Identique à \h.
Délimiteur	\d	Définit le délimiteur d'instruction. Le délimiteur par défaut est un point-virgule.
Quitter	\q	Quitte la CLI Spanner. Identique à "Quitter".
Go	\g	Envoie et exécute une instruction SQL dans Spanner.
Aide	\h	Affiche des informations d'aide. Identique à \?.
Notee	\t	Désactive l'écriture dans le fichier de sortie défini par \T.
Requête	\R	Transforme votre requête en chaîne de requête utilisateur.
Quitter	\q	Quitte la CLI Spanner. Identique à la sortie.
Source	\.	Exécute le code SQL à partir d'un fichier d'entrée. Prend [filename] comme argument.
Système	\!	Exécute une commande shell système.
Tee	\T	Ajoute le résultat de la commande à un [nom de fichier] spécifié, ainsi qu'à la sortie standard.
Utiliser	\u	Se connecte à une autre base de données. Prend le nouveau nom de la base de données comme argument.

Étapes suivantes

• Consultez la liste de toutes les commandes gcloud alpha spanner cli compatibles.