Objectifs
Ce tutoriel vous montre comment effectuer les opérations suivantes à l'aide de la bibliothèque cliente Spanner pour Go :
- Créer une instance et une base de données Spanner
- Écrire ou lire des données dans la base de données, et exécuter des requêtes SQL sur ces données
- Mettre à jour le schéma de base de données
- Mettre à jour les données à l'aide d'une transaction en lecture/écriture
- Ajouter un index secondaire à la base de données
- Utiliser l'index pour lire et exécuter des requêtes SQL sur des données
- Récupérer des données à l'aide d'une transaction en lecture seule
Coûts
Ce tutoriel utilise Spanner, un composant facturable de Google Cloud. Pour en savoir plus sur le coût d'utilisation de Spanner, consultez Tarifs :
Avant de commencer
Pour obtenir les identifiants d'authentification permettant d'utiliser l'API Cloud Spanner, suivez les étapes décrites dans la section dédiée à la configuration qui traite des sujets suivants : création et définition d'un projet Google Cloud par défaut, activation de la facturation ainsi que de l'API Cloud Spanner, et configuration d'OAuth 2.0.
Veillez en particulier à exécuter gcloud auth
application-default login
pour configurer votre environnement de développement local avec des identifiants d'authentification.
Préparer votre environnement Go local
Si ce n'est pas déjà fait, installez Go (télécharger) sur votre ordinateur de développement.
Si ce n'est pas déjà fait, configurez la variable d'environnement
GOPATH
comme décrit dans la section Tester votre installation.Téléchargez les exemples sur votre ordinateur.
git clone https://github.com/GoogleCloudPlatform/golang-samples $GOPATH/src/github.com/GoogleCloudPlatform/golang-samples
Accédez au répertoire qui contient l'exemple de code Spanner:
cd $GOPATH/src/github.com/GoogleCloudPlatform/golang-samples/spanner/spanner_snippets
Définissez la variable d'environnement
GCLOUD_PROJECT
sur l'ID de votre projet Google Cloud :export GCLOUD_PROJECT=[MY_PROJECT_ID]
Créer une instance
Lorsque vous utilisez Spanner pour la première fois, vous devez créer une instance, c'est-à-dire un élément qui alloue les ressources utilisées par les bases de données Spanner. Lorsque vous créez une instance, vous choisissez une configuration d'instance, qui détermine l'emplacement de stockage de vos données et le nombre de nœuds à utiliser. Ce dernier paramètre définit la quantité de ressources disponibles dans votre instance pour le stockage et la diffusion.
Exécutez la commande suivante pour créer une instance Spanner dans la région us-central1
avec un nœud :
gcloud spanner instances create test-instance --config=regional-us-central1 \
--description="Test Instance" --nodes=1
Cette commande crée une instance présentant les caractéristiques suivantes :
- ID d'instance :
test-instance
- Nom à afficher :
Test Instance
- Configuration d'instance :
regional-us-central1
(Les configurations régionales stockent les données dans une région, tandis que les configurations multirégionales les distribuent dans plusieurs régions. Pour en savoir plus, consultez la page À propos des instances.) - Nombre de nœuds : 1 (
node_count
correspond à la quantité de ressources de stockage et de diffusion disponibles pour les bases de données de l'instance. Pour en savoir plus, consultez la section Nœuds et unités de traitement par défaut.)
Vous devriez obtenir le résultat suivant :
Creating instance...done.
Consulter des exemples de fichiers
Le dépôt d'exemples contient un exemple illustrant l'utilisation de Spanner avec Go.
Examinez le fichiersnippet.go
, qui montre comment utiliser
Spanner. Le code indique comment créer et utiliser une base de données. Les données utilisent l'exemple de schéma présenté sur la page Schéma et modèle de données.
Créer une base de données
Créez une base de données nommée example-db
dans l'instance test-instance
en procédant comme suit :
en exécutant la commande suivante sur la ligne de commande.
GoogleSQL
go run snippet.go createdatabase projects/$GCLOUD_PROJECT/instances/test-instance/databases/example-db
PostgreSQL
go run snippet.go pgcreatedatabase projects/$GCLOUD_PROJECT/instances/test-instance/databases/example-db
Vous devriez obtenir le résultat suivant :
Created database [example-db]
GoogleSQL
PostgreSQL
L'étape suivante consiste à écrire des données dans la base de données.
Créer un client de base de données
Pour pouvoir effectuer des opérations de lecture ou d'écriture, vous devez créer un objetClient
:
Un Client
peut être considéré comme une connexion à une base de données: toutes vos interactions
avec Spanner doivent passer par un Client
. En général, vous devez créer un objet Client
lorsque votre application démarre. Vous réutiliserez ensuite cet objet Client
pour lire, écrire et exécuter des transactions. Chaque client utilise
des ressources dans
Spanner.
Si vous créez plusieurs clients dans la même application, vous devez appeler Client.Close()
pour nettoyer les ressources du client, y compris les connexions réseau, dès que ces ressources ne sont plus nécessaires.
Pour en savoir plus, consultez la documentation de référence sur Client
.
Le code de l'exemple précédent montre également comment créer un objet DatabaseAdminClient
servant à générer une base de données.
Écrire des données avec le langage LMD
Vous pouvez insérer des données à l'aide du langage de manipulation de données (LMD) dans une transaction en lecture/écriture.
L'exécution d'une instruction LMD s'effectue via la méthode Update()
.
GoogleSQL
PostgreSQL
Exécutez l'exemple en utilisant l'argument dmlwrite
pour Google SQL et l'argument pgdmlwrite
pour PostgreSQL:
GoogleSQL
go run snippet.go dmlwrite projects/$GCLOUD_PROJECT/instances/test-instance/databases/example-db
PostgreSQL
go run snippet.go pgdmlwrite projects/$GCLOUD_PROJECT/instances/test-instance/databases/example-db
Vous devriez obtenir le résultat suivant :
4 record(s) inserted.
Écrire des données avec des mutations
Vous pouvez également insérer des données à l'aide de mutations.
Un objet Mutation
est un conteneur pour les opérations de mutation. Un Mutation
représente une séquence de
insère, met à jour et supprime des données auxquelles Spanner applique de manière atomique
différentes lignes et tables d'une base de données Spanner.
Utilisez Mutation.InsertOrUpdate()
pour créer une mutation INSERT_OR_UPDATE
, qui ajoute une ligne ou met à jour les valeurs de colonne si la ligne existe déjà. Vous pouvez également utiliser la méthode Mutation.Insert()
, qui permet aussi d'ajouter une ligne, pour créer une mutation INSERT
.
La méthode Client.Apply()
applique les mutations de manière atomique à une base de données.
Le code ci-dessous montre comment écrire les données à l'aide de mutations :
Exécutez l'exemple en utilisant l'argument write
:
go run snippet.go write projects/$GCLOUD_PROJECT/instances/test-instance/databases/example-db
Vous devriez voir la commande s'exécuter avec succès.
Interroger des données à l'aide de SQL
Spanner accepte une interface SQL pour la lecture des données. Vous pouvez accéder à cette interface via la ligne de commande à l'aide de la CLI Google Cloud ou de manière automatisée à l'aide de la bibliothèque cliente Spanner pour Go.
Sur la ligne de commande
Exécutez l'instruction SQL suivante pour lire les valeurs de toutes les colonnes de la table Albums
:
gcloud spanner databases execute-sql example-db --instance=test-instance \
--sql='SELECT SingerId, AlbumId, AlbumTitle FROM Albums'
Vous devez obtenir le résultat suivant :
SingerId AlbumId AlbumTitle
1 1 Total Junk
1 2 Go, Go, Go
2 1 Green
2 2 Forever Hold Your Peace
2 3 Terrified
Utiliser la bibliothèque cliente Spanner pour Go
Vous pouvez non seulement exécuter une instruction SQL via la ligne de commande, mais également appliquer la même instruction SQL de manière automatisée à l'aide de la bibliothèque cliente Spanner pour Go.
Les méthodes et types ci-dessous sont utilisés pour exécuter la requête SQL :Client.Single()
: utilisez cette méthode pour lire la valeur d'une ou de plusieurs colonnes dans une ou plusieurs lignes d'une table Spanner.Client.Single
renvoie unReadOnlyTransaction
, qui est utilisé pour exécuter une instruction de lecture ou une instruction SQL.ReadOnlyTransaction.Query()
: utilisez cette méthode pour exécuter une requête sur une base de données.- Type
Statement
: utilisez ce type pour créer une chaîne SQL. - Type
Row
: utilisez ce type pour accéder aux données renvoyées par une instruction SQL ou un appel de lecture.
Le code ci-dessous permet d'exécuter la requête et d'accéder aux données.
Exécutez l'exemple en utilisant l'argument query
.
go run snippet.go query projects/$GCLOUD_PROJECT/instances/test-instance/databases/example-db
Vous devriez obtenir le résultat suivant :
1 1 Total Junk
1 2 Go, Go, Go
2 1 Green
2 2 Forever Hold Your Peace
2 3 Terrified
Requête utilisant un paramètre SQL
Si votre application comporte une requête fréquemment exécutée, vous pouvez améliorer ses performances en les paramétrant. La requête paramétrique obtenue peut être mise en cache et réutilisée, ce qui réduit les coûts de compilation. Pour en savoir plus, consultez la section Utiliser des paramètres pour accélérer les requêtes fréquemment exécutées.
Voici un exemple d'utilisation d'un paramètre dans la clause WHERE
pour
enregistrements de requête contenant une valeur spécifique pour LastName
.
GoogleSQL
PostgreSQL
Exécutez l'exemple en utilisant l'argument querywithparameter
pour Google SQL et l'argument pgqueryparameter
pour PostgreSQL.
GoogleSQL
go run snippet.go querywithparameter projects/$GCLOUD_PROJECT/instances/test-instance/databases/example-db
PostgreSQL
go run snippet.go pgqueryparameter projects/$GCLOUD_PROJECT/instances/test-instance/databases/example-db
Un résultat semblable à celui-ci s'affiche :
12 Melissa Garcia
Lire des données à l'aide de l'API de lecture
En plus de son interface SQL, Spanner offre une interface de lecture.
UtilisezReadOnlyTransaction.Read()
pour lire les lignes de la base de données. Pour définir une collection de clés et de plages de clés à lire, utilisez KeySet
.
Le code ci-dessous permet de lire les données.
Exécutez l'exemple en utilisant l'argument read
.
go run snippet.go read projects/$GCLOUD_PROJECT/instances/test-instance/databases/example-db
Un résultat semblable à celui-ci s'affiche :
1 1 Total Junk
1 2 Go, Go, Go
2 1 Green
2 2 Forever Hold Your Peace
2 3 Terrified
Mettre à jour le schéma de base de données
Supposons que vous deviez ajouter la colonne MarketingBudget
à la table Albums
. L'ajout d'une colonne à une table existante nécessite une mise à jour du schéma de base de données. Spanner permet de mettre à jour le schéma d'une base de données, tandis que
continue de diffuser du trafic. Les mises à jour de schéma ne nécessitent pas
hors ligne et ne verrouillent pas
des tables ou des colonnes entières ; vous pouvez continuer
l'écriture de données dans la base de données
pendant la mise à jour du schéma. Pour en savoir plus sur les mises à jour de schéma acceptées et sur les performances liées aux modifications de schéma, consultez la page Effectuer des mises à jour de schéma.
Ajouter une colonne
Vous pouvez ajouter une colonne sur la ligne de commande à l'aide de la Google Cloud CLI ou de manière programmatique à l'aide la bibliothèque cliente Spanner pour Go.
Sur la ligne de commande
Pour ajouter la colonne à la table, utilisez la commande ALTER TABLE
suivante :
GoogleSQL
gcloud spanner databases ddl update example-db --instance=test-instance \
--ddl='ALTER TABLE Albums ADD COLUMN MarketingBudget INT64'
PostgreSQL
gcloud spanner databases ddl update example-db --instance=test-instance \
--ddl='ALTER TABLE Albums ADD COLUMN MarketingBudget BIGINT'
Vous devriez obtenir le résultat suivant :
Schema updating...done.
Utiliser la bibliothèque cliente Spanner pour Go
UtilisezDatabaseAdminClient.UpdateDatabaseDdl()
pour modifier le schéma :
GoogleSQL
PostgreSQL
Exécutez l'exemple à l'aide de l'argument addnewcolumn
pour Google SQL et de l'argument pgaddnewcolumn
pour PostgreSQL.
GoogleSQL
go run snippet.go addnewcolumn projects/$GCLOUD_PROJECT/instances/test-instance/databases/example-db
PostgreSQL
go run snippet.go pgaddnewcolumn projects/$GCLOUD_PROJECT/instances/test-instance/databases/example-db
Vous devriez obtenir le résultat suivant :
Added MarketingBudget column.
Écrire des données dans la nouvelle colonne
Le code ci-dessous permet d'écrire des données dans la nouvelle colonne. Il définit MarketingBudget
sur 100000
pour la ligne correspondant à la clé Albums(1, 1)
et sur 500000
pour la ligne correspondant à la clé Albums(2, 2)
.
Exécutez l'exemple en utilisant l'argument update
.
go run snippet.go update projects/$GCLOUD_PROJECT/instances/test-instance/databases/example-db
Vous pouvez également exécuter une requête SQL ou un appel de lecture pour récupérer les valeurs que vous venez d'écrire.
Le code permettant d'exécuter la requête est présenté ci-dessous.
GoogleSQL
PostgreSQL
Pour exécuter cette requête, exécutez l'exemple en spécifiant l'argument querynewcolumn
pour Google SQL et l'argument pgquerynewcolumn
pour PostgreSQL.
GoogleSQL
go run snippet.go querynewcolumn projects/$GCLOUD_PROJECT/instances/test-instance/databases/example-db
PostgreSQL
go run snippet.go pgquerynewcolumn projects/$GCLOUD_PROJECT/instances/test-instance/databases/example-db
Vous devriez obtenir le résultat suivant :
1 1 100000
1 2 NULL
2 1 NULL
2 2 500000
2 3 NULL
Mettre à jour des données
Vous pouvez mettre à jour des données à l'aide du langage LMD dans une transaction en lecture/écriture.
L'exécution d'une instruction LMD s'effectue via la méthode Update()
.
GoogleSQL
PostgreSQL
Exécutez l'exemple en utilisant l'argument dmlwritetxn
.
go run snippet.go dmlwritetxn projects/$GCLOUD_PROJECT/instances/test-instance/databases/example-db
Vous devriez obtenir le résultat suivant :
Moved 200000 from Album2's MarketingBudget to Album1's.
Utiliser un index secondaire
Supposons que vous vouliez récupérer toutes les lignes de la table Albums
dont les valeurs AlbumTitle
sont comprises dans une certaine plage. Vous pouvez lire toutes les valeurs de la colonne AlbumTitle
à l'aide d'une instruction SQL ou d'un appel de lecture, puis supprimer les lignes qui ne correspondent pas aux critères. Toutefois, cette analyse complète de la table est coûteuse, en particulier si celle-ci comporte beaucoup de lignes. Vous pouvez accélérer la récupération des lignes lors des recherches effectuées en fonction des colonnes de clé non primaire en créant un index secondaire pour la table.
L'ajout d'un index secondaire à une table existante nécessite une mise à jour du schéma. Comme pour les autres mises à jour de schéma, Spanner permet d'ajouter un index alors que la base de données continue de diffuser du trafic. Spanner remplit automatiquement l'index à l'aide de vos données existantes. Les remplissages peuvent prendre quelques minutes. Toutefois, ce processus ne requiert pas la mise hors connexion de la base de données et ne vous empêche pas d'écrire dans la table indexée. Pour en savoir plus, consultez la section Ajouter un index secondaire.
Une fois que vous avez ajouté un index secondaire, Spanner l'utilise automatiquement pour Requêtes SQL susceptibles de s'exécuter plus rapidement avec l'index. Si vous utilisez l'interface de lecture, vous devez spécifier l'index que vous souhaitez utiliser.
Ajouter un index secondaire
Vous pouvez ajouter un index à la ligne de commande à l'aide de la CLI gcloud ou de manière automatisée à l'aide de la bibliothèque cliente Spanner pour Go.
Sur la ligne de commande
Exécutez la commande CREATE INDEX
suivante pour ajouter un index à la base de données :
gcloud spanner databases ddl update example-db --instance=test-instance \
--ddl='CREATE INDEX AlbumsByAlbumTitle ON Albums(AlbumTitle)'
Vous devriez obtenir le résultat suivant :
Schema updating...done.
Utiliser la bibliothèque cliente Spanner pour Go
UtilisezUpdateDatabaseDdl()
pour ajouter un index :
L'ajout d'un index peut prendre quelques minutes. Une fois l'index ajouté, vous devriez obtenir le résultat suivant :
Added index
Lire des données avec l'index
Pour les requêtes SQL, Spanner utilise automatiquement un index approprié. Dans l'interface de lecture, vous devez spécifier l'index dans votre requête.
Pour utiliser l'index dans l'interface de lecture, appelez la méthode ReadOnlyTransaction.ReadUsingIndex()
, qui lit un nombre quelconque de lignes (zéro ou plus) dans une base de données à l'aide d'un index.
Le code ci-dessous permet de récupérer toutes les colonnes AlbumId
et AlbumTitle
à partir de l'index AlbumsByAlbumTitle
.
Exécutez l'exemple en utilisant l'argument readindex
.
go run snippet.go readindex projects/$GCLOUD_PROJECT/instances/test-instance/databases/example-db
Vous devriez obtenir le résultat suivant :
2 Forever Hold Your Peace
2 Go, Go, Go
1 Green
3 Terrified
1 Total Junk
Ajouter un index pour les lectures d'index uniquement
Vous avez peut-être remarqué que l'exemple de lecture précédent n'incluait pas la lecture de la colonne MarketingBudget
. En effet, l'interface de lecture de Spanner ne permet pas de joindre un index à une table de données pour rechercher des valeurs qui ne sont pas stockées dans l'index.
Créez une autre définition de l'index AlbumsByAlbumTitle
qui stocke dans l'index une copie de MarketingBudget
.
Sur la ligne de commande
GoogleSQL
gcloud spanner databases ddl update example-db --instance=test-instance \
--ddl='CREATE INDEX AlbumsByAlbumTitle2 ON Albums(AlbumTitle) STORING (MarketingBudget)
PostgreSQL
gcloud spanner databases ddl update example-db --instance=test-instance \
--ddl='CREATE INDEX AlbumsByAlbumTitle2 ON Albums(AlbumTitle) INCLUDE (MarketingBudget)
L'ajout d'un index peut prendre quelques minutes. Une fois l'index ajouté, vous devriez obtenir le résultat suivant :
Schema updating...done.
Utiliser la bibliothèque cliente Spanner pour Go
UtilisezUpdateDatabaseDdl()
pour ajouter un indice avec une clause STORING
pour GoogleSQL et une clause INCLUDE
pour PostgreSQL :
GoogleSQL
PostgreSQL
Exécutez l'exemple en utilisant l'argument addstoringindex
.
GoogleSQL
go run snippet.go addstoringindex projects/$GCLOUD_PROJECT/instances/test-instance/databases/example-db
PostgreSQL
go run snippet.go pgaddstoringindex projects/$GCLOUD_PROJECT/instances/test-instance/databases/example-db
L'ajout d'un index peut prendre quelques minutes. Une fois l'index ajouté, vous devriez obtenir le résultat suivant :
Added storing index
Vous pouvez maintenant exécuter une opération de lecture permettant de récupérer toutes les colonnes AlbumId
, AlbumTitle
et MarketingBudget
à partir de l'index AlbumsByAlbumTitle2
:
Exécutez l'exemple en utilisant l'argument readstoringindex
.
go run snippet.go readstoringindex projects/$GCLOUD_PROJECT/instances/test-instance/databases/example-db
Un résultat semblable à celui-ci s'affiche :
2 Forever Hold Your Peace 300000
2 Go, Go, Go NULL
1 Green NULL
3 Terrified NULL
1 Total Junk 300000
Récupérer des données à l'aide de transactions en lecture seule
Supposons que vous souhaitiez exécuter plusieurs opérations de lecture avec le même horodatage. Les transactions en lecture seule tiennent compte d'un préfixe cohérent de l'historique de commit des transactions, de sorte que votre application obtienne toujours des données cohérentes.
Pour exécuter des transactions en lecture seule, utilisez le type ReadOnlyTransaction
. Pour obtenir une transaction en lecture seule (ReadOnlyTransaction
), utilisez Client.ReadOnlyTransaction()
:
L'exemple ci-dessous montre comment exécuter une requête et effectuer une lecture dans la même transaction en lecture seule.
Exécutez l'exemple en utilisant l'argument readonlytransaction
.
go run snippet.go readonlytransaction projects/$GCLOUD_PROJECT/instances/test-instance/databases/example-db
Un résultat semblable à celui-ci s'affiche :
2 2 Forever Hold Your Peace
1 2 Go, Go, Go
2 1 Green
2 3 Terrified
1 1 Total Junk
1 1 Total Junk
1 2 Go, Go, Go
2 1 Green
2 2 Forever Hold Your Peace
2 3 Terrified
Nettoyage
Pour éviter que des frais supplémentaires ne soient facturés sur votre compte Cloud Billing pour les ressources utilisées dans ce tutoriel, supprimez la base de données et l'instance que vous avez créées.
Supprimer la base de données
Si vous supprimez une instance, toutes les bases de données qu'elle contient sont automatiquement supprimées. Cette étape montre comment supprimer une base de données sans supprimer l'instance. Des frais continueront à vous être facturés pour cette dernière.
Sur la ligne de commande
gcloud spanner databases delete example-db --instance=test-instance
Utiliser la console Google Cloud
Accédez à la page Instances Spanner dans la console Google Cloud.
Cliquez sur l'instance.
Cliquez sur la base de données que vous souhaitez supprimer.
Sur la page Détails de la base de données, cliquez sur Supprimer.
Confirmez que vous souhaitez supprimer la base de données, puis cliquez sur Supprimer.
Supprimer l'instance
La suppression d'une instance supprime automatiquement toutes les bases de données créées dans cette instance.
Sur la ligne de commande
gcloud spanner instances delete test-instance
Utiliser la console Google Cloud
Accédez à la page Instances de Spanner dans la console Google Cloud.
Cliquez sur votre instance.
Cliquez sur Supprimer.
Confirmez que vous souhaitez supprimer l'instance, puis cliquez sur Supprimer.
Étape suivante
Découvrez comment accéder à Spanner avec une instance de machine virtuelle.
Pour en savoir plus sur les identifiants d'autorisation et d'authentification, consultez la page S'authentifier auprès de services cloud à l'aide de bibliothèques clientes.
Découvrez les bonnes pratiques de conception de schémas dans Spanner.