Exporter des bases de données de Spanner vers Avro

Cette page explique comment exporter des bases de données Spanner avec console Google Cloud.

Exporter une base de données Spanner à l'aide de l'API REST ou la Google Cloud CLI, suivez la procédure décrite dans Avant de commencer de cette page, puis consultez les consultez les instructions détaillées de Spanner vers Cloud Storage Avro dans le Documentation Dataflow. Le processus d'exportation utilise Dataflow et écrit les données dans un dossier d'un bucket Cloud Storage. Le dossier obtenu contient un ensemble Fichiers Avro et fichiers manifestes JSON.

Avant de commencer

Pour exporter une base de données Spanner, vous devez d'abord activer les API Spanner, Cloud Storage, Compute Engine et Dataflow :

Enable the APIs

Vous devez également disposer d'un quota suffisant, ainsi que des autorisations IAM requises.

Exigences en matière de quota

Voici les conditions de quota requises pour les jobs d'exportation:

• Spanner: aucune la capacité de calcul requise pour exporter une base de données, d'ajouter de la capacité de calcul afin que votre job se termine dans une quantité raisonnable de temps. Pour en savoir plus, consultez la section Optimiser les tâches.
• Cloud Storage: Pour procéder à l'exportation, vous devez créer un bucket pour vos fichiers exportés si : vous n'en avez pas encore. Vous pouvez créer un bucket dans la console Google Cloud, soit sur la page Cloud Storage, soit lors de la création de votre exportation sur la page Spanner. Il n'est pas nécessaire de spécifier une taille pour ce bucket.
• Dataflow : les tâches d'exportation sont soumises aux mêmes exigences que les autres tâches Dataflow en ce qui concerne les quotas Compute Engine, aussi bien pour l'utilisation de processeurs et d'espace disque que pour le nombre d'adresses IP.

• Compute Engine : avant d'exécuter une tâche d'exportation, vous devez définir les quotas initiaux Compute Engine utilisés par Dataflow. Ces quotas représentent le nombre maximal de ressources que vous permettez à Dataflow d'utiliser pour votre tâche. Les valeurs de départ recommandées sont les suivantes :

  • Processeurs : 200
  • Adresses IP en cours d'utilisation : 200
  • Disque persistant standard : 50 To

  En règle générale, vous n'avez pas d'autres réglages à effectuer. Dataflow gère l'autoscaling de sorte que vous n'ayez à payer que pour les ressources effectivement utilisées lors de l'exportation. S'il apparaît que votre tâche pourrait utiliser davantage de ressources, l'interface utilisateur de Dataflow affiche une icône d'avertissement, mais cela n'empêche normalement pas la tâche d'aboutir.

Rôles requis

Pour obtenir les autorisations nécessaires pour exporter une base de données, demandez à votre administrateur de vous accorder les rôles IAM suivants sur le compte de service de l'agent Dataflow :

• Lecteur Cloud Spanner (roles/spanner.viewer)
• Nœud de calcul Dataflow (roles/dataflow.worker)
• Administrateur de l'espace de stockage (roles/storage.admin)
• Lecteur de bases de données Spanner (roles/spanner.databaseReader)
• Administrateur de bases de données (roles/spanner.databaseAdmin)

Remarque :Le rôle d'administrateur de bases de données Spanner n'est requis que pour les jobs d'importation.

Pour utiliser les ressources de calcul indépendantes de Spanner Data Boost lors d'une exportation, vous avez également besoin de l'autorisation IAM spanner.databases.useDataBoost. Pour en savoir plus, consultez la page Présentation de Data Boost.

Exporter une base de données

Une fois que vous avez satisfait aux exigences de quota et IAM décrites précédemment, vous pouvez exporter une base de données Spanner existante.

Remarque : Il est possible d'exporter sans risque une base de données en cours d'utilisation. Toutefois, aucune modification apportée après la création d'une transaction Spanner par Dataflow n'est capturée par l'exportation. En effet, toutes les données exportées proviennent du même instantané de base de données.

Exporter votre base de données Spanner vers Cloud Storage procédez comme suit:

1. Accédez à la page Instances de Spanner.

   Accéder à la page "Instances"

2. Cliquez sur le nom de l'instance contenant votre base de données.

3. Cliquez sur l'élément de menu Import/Export (Importer/Exporter) dans le volet de gauche, puis cliquez sur le bouton Bouton Export (Exporter)

4. Sous Sélectionner l'emplacement de stockage de votre exportation, cliquez sur Parcourir.

5. Si vous ne possédez pas déjà un bucket Cloud Storage pour votre exportation :

   1. Cliquez sur Nouveau bucket .
   2. Saisissez un nom pour ce bucket. Les noms de buckets doivent être uniques dans Cloud Storage.
   3. Sélectionnez une classe de stockage et un emplacement par défaut, puis cliquez sur Créer.
   4. Cliquez sur le bucket pour le sélectionner.

   Si vous disposez déjà d'un bucket, sélectionnez-le dans la liste initiale ou cliquez sur Rechercher pour filtrer la liste, puis cliquez sur votre bucket pour le sélectionner.

6. Cliquez sur Sélectionner.

7. Sélectionnez la base de données à exporter dans le menu déroulant Sélectionner une base de données à exporter.

8. Facultatif : Pour exporter votre base de données à un moment antérieur, cochez la case correspondante, puis saisissez un horodatage.

9. Sélectionnez une région dans le menu déroulant Choisir une région pour la tâche d'exportation.

   Remarque :Pour éviter des frais de transfert de données, choisissez une région qui chevauche avec la configuration de votre instance. Pour en savoir plus, consultez Sélectionnez une région.

10. Facultatif : Pour chiffrer l'état du pipeline Dataflow avec une clé de chiffrement gérée par le client :

    1. Cliquez sur Afficher les options de chiffrement.
    2. Sélectionnez Utiliser une clé de chiffrement gérée par le client (CMEK).
    3. Sélectionnez votre clé dans la liste déroulante.

    Cette option n'affecte pas le chiffrement au niveau du bucket Cloud Storage de destination. Pour activer les CMEK pour votre bucket Cloud Storage, consultez Utilisez des CMEK avec Cloud Storage.

11. Facultatif: Pour exporter des données à l'aide de Spanner Data Boost, sélectionnez le paramètre Case à cocher Utiliser Spanner Data Boost. Pour en savoir plus, consultez Présentation de Data Boost

12. Cochez la case sous Confirmer les débits pour confirmer en plus de ceux associés à votre instance Spanner existante.

13. Cliquez sur Exporter.

    La console Google Cloud ouvre la page Importation/Exportation de base de données, qui affiche désormais une ligne de votre tâche d'exportation dans la liste des tâches d'importation/exportation, y compris le temps écoulé :

    

Lorsque le job se termine ou qu'il est arrêté, l'état est mis à jour dans la section liste. Si la tâche a abouti, l'état Réussie s'affiche :

Si la tâche a échoué, l'état Échec s'affiche :

Pour afficher les détails de l'opération Dataflow de votre job, cliquez sur le nom du job dans la colonne Nom du job Dataflow.

En cas d'échec, consultez les journaux Dataflow de cette tâche pour connaître les détails de l'erreur.

Afin d'éviter une facturation Cloud Storage pour les fichiers créés par une tâche d'exportation ayant échoué, supprimez le dossier et ses fichiers. Pour en savoir plus, consultez l'article Consulter vos exporter pour savoir comment trouver le dossier.

Remarque sur l'exportation des colonnes générées et des flux de modifications

Les valeurs d'une colonne générée stockée ne sont pas exportées. La définition de colonne est exportée vers le schéma Avro en tant que champ d'enregistrement de type null, la définition de colonne comme propriétés personnalisées du champ. Jusqu'à la fin de l'opération de remplissage d'une colonne générée, la colonne générée est ignorée comme si elle n'existait pas dans le schéma.

Les flux de modifications exportés sous forme de fichiers Avro ne contiennent que le schéma du des flux de modifications, et non des enregistrements de modifications de données.

Remarque sur l'exportation de séquences

Les séquences (GoogleSQL, PostgreSQL) sont des objets de schéma que vous utilisez pour générer des valeurs entières uniques. Spanner exporte chacun des objets de schéma vers le schéma Avro en tant que "record" (enregistrement) avec son genre de séquence, la plage ignorée et le compteur en tant que propriétés du domaine. Notez que pour éviter qu'une séquence soit réinitialisée et générée des valeurs en double après l'importation, lors de l'exportation du schéma, GET_INTERNAL_SEQUENCE_STATE() (GoogleSQL, PostgreSQL) capture le compteur de séquence. Spanner ajoute un tampon de 1 000 au compteur et écrit la nouvelle valeur de compteur dans le champ d'enregistrement. Cette approche évite les erreurs de valeurs en double qui peuvent se produire après l'importation. Si davantage d'écritures sont effectuées dans la base de données source lors de l'exportation des données, vous devez ajuster le compteur de séquence réel à l'aide de l'instruction ALTER SEQUENCE (Google SQL, PostgreSQL).

Lors de l'importation, la séquence commence à partir de ce nouveau compteur au lieu du compteur trouvé dans le schéma. Vous pouvez également utiliser ALTER SEQUENCE (GoogleSQL, PostgreSQL) pour mettre à jour la séquence avec un nouveau compteur.

Afficher votre exportation dans Cloud Storage

Pour afficher le dossier contenant votre base de données exportée dans le fichier dans la console Google Cloud, accédez au navigateur Cloud Storage, choisissez le bucket que vous avez sélectionné précédemment:

Accéder à la page Navigateur de stockage

Le bucket contient maintenant un dossier dans lequel se trouve la base de données exportée. Le nom du dossier commence par l'ID de votre instance, le nom de la base de données et l'horodatage de la tâche d'exportation. Le dossier contient :

• Un fichier spanner-export.json.
• Un fichier TableName-manifest.json pour chaque table de la base de données que vous avez exportée.

• Un ou plusieurs fichiers TableName.avro-#####-of-#####. Le premier nombre figurant dans l'extension .avro-#####-of-##### représente l'index du fichier Avro compté à partir de zéro, tandis que le second correspond au nombre de fichiers Avro générés pour chaque table.

  Par exemple, Songs.avro-00001-of-00002 est le deuxième des deux fichiers contenant les données de la table Songs.

• Un fichier ChangeStreamName-manifest.json pour chaque flux de modifications dans la base de données que vous exportées.

• Un fichier ChangeStreamName.avro-00000-of-00001 pour chaque flux de modifications. Ce fichier contient des données vides avec uniquement le schéma Avro du flux de modifications.

Choisissez une région pour votre job d'importation

Vous pouvez être amené à choisir une région différente selon l'emplacement de votre bucket Cloud Storage. Pour éviter les frais de transfert de données sortants, choisissez une région correspondant à l'emplacement de votre bucket Cloud Storage.

• Si l'emplacement de votre bucket Cloud Storage est une région, vous peuvent profiter de l'utilisation gratuite du réseau en choisissant la même région pour votre job d'importation, en supposant que cette région est disponible.

• Si l'emplacement de votre bucket Cloud Storage est birégional, vous pouvez profiter de l'utilisation gratuite du réseau en choisissant l'une des deux régions qui composent l'emplacement birégional de votre job d'importation, en supposant que l'une des régions est disponible.

• Si une région colocalisée n'est pas disponible pour votre tâche d'importation ou si l'emplacement de votre bucket Cloud Storage est une région multirégionale, des frais de transfert de données sortants s'appliquent. Consultez les tarifs de transfert de données Cloud Storage pour choisir la région qui génère les frais de transfert de données les plus bas.

Exporter un sous-ensemble de tables

Si vous ne souhaitez exporter que les données de certaines tables et non l'ensemble de la base de données, vous pouvez spécifier ces tables lors de l'exportation. Dans ce cas, Spanner exporte l'intégralité du schéma de la base de données, y compris les données des tables que vous spécifiez, et laisse toutes les autres tables présentes, mais vides, dans le fichier exporté.

Vous pouvez spécifier un sous-ensemble de tables à exporter à l'aide de la page Dataflow dans la console Google Cloud ou de la CLI gcloud. (Cette action ne figure pas sur la page Spanner.)

Si vous exportez les données d'une table qui est l'enfant d'une autre table, vous doit exporter son fichier parent les données de la table. Si les parents ne sont pas exportés, la tâche d'exportation échoue.

Pour exporter un sous-ensemble de tables, démarrez l'exportation à l'aide de la Dataflow Modèle Spanner vers Cloud Storage Avro spécifier les tables à l'aide de la page Dataflow la console Google Cloud ou à l'aide de gcloud CLI, comme décrit ci-dessous:

Console

Si vous utilisez la page Dataflow dans la console Google Cloud, Le paramètre Nom(s) des tables Cloud Spanner se trouve dans la section Section Paramètres facultatifs de la page Créer une tâche à partir d'un modèle. Vous pouvez spécifier plusieurs tableaux dans un format d'éléments séparés par une virgule.

Accéder à Dataflow

gcloud

Exécutez la gcloud dataflow jobs run. et spécifiez l'argument tableNames. Exemple :

gcloud dataflow jobs run my-export-job \
--gcs-location='gs://dataflow-templates/latest/Cloud_Spanner_to_GCS_Avro' \
--region=us-central1 \
--parameters='instanceId=test-instance,databaseId=example-db,tableNames=table1,outputDir=gs://my-gcs-bucket' \
--max-workers=10 \
--network=network-123

La spécification de plusieurs tables dans gcloud nécessite Échappement d'argument de type dictionnaire. L'exemple suivant utilise '|' comme caractère d'échappement :

 gcloud dataflow jobs run my-export-job \
--gcs-location='gs://dataflow-templates/latest/Cloud_Spanner_to_GCS_Avro' \
--region=us-central1 \
--parameters='^|^instanceId=test-instance|databaseId=example-db|tableNames=table1,table2|outputDir=gs://my-gcs-bucket' \
--max-workers=10 \
--network=network-123

Le paramètre shouldExportRelatedTables est une option pratique pour exporter automatiquement toutes les tables parentes ; des tables choisies. Par exemple, dans cette hiérarchie de schéma avec les tableaux Singers, Albums et Songs, il vous suffit de spécifier Songs L'option shouldExportRelatedTables permet d'exporter Singers et Albums, car Songs est un descendant des deux.

gcloud dataflow jobs run my-export-job \
--gcs-location='gs://dataflow-templates/latest/Cloud_Spanner_to_GCS_Avro' \
--region=us-central1 \
--parameters='instanceId=test-instance,databaseId=example-db,tableNames=Songs,shouldExportRelatedTables=true,outputDir=gs://my-gcs-bucket' \
--max-workers=10 \
--network=network-123

Afficher ou dépanner des tâches dans l'interface utilisateur de Dataflow

Après avoir démarré une tâche d'exportation, vous pouvez en afficher les détails, y compris les journaux, dans la section Dataflow de la console Google Cloud.

Afficher les détails d'une tâche Dataflow

Pour afficher les détails des tâches d'importation ou d'exportation que vous avez exécutées au cours de la dernière semaine, y compris les tâches en cours d'exécution :

1. Accédez à la page Présentation de la base de données correspondant à la base de données.
2. Cliquez sur l'élément de menu du volet Importations/Exportations à gauche. La page Importations/Exportations de la base de données affiche la liste des tâches récentes.

3. Sur la page Importations/Exportations de la base de données, cliquez sur le nom de la tâche dans la colonne Nom de la tâche Dataflow :

   

   La console Google Cloud affiche les détails de la tâche Dataflow.

Pour afficher une tâche que vous avez exécutée il y a plus d'une semaine :

1. Accédez à la page des tâches Dataflow dans la console Google Cloud.

   Accéder aux tâches

2. Recherchez votre tâche dans la liste, puis cliquez sur son nom.

   La console Google Cloud affiche les détails de Dataflow tâche.

Remarque : Les tâches de même type relatives à une même base de données portent toutes le même nom. Vous pouvez les distinguer les unes des autres d'après les valeurs spécifiées dans les colonnes Heure de début ou Heure de fin.

Afficher les journaux Dataflow associés à votre job

Pour afficher les journaux d'une tâche Dataflow, accédez aux détails de cette tâche puis cliquez sur Journaux à droite du nom de la tâche.

Si une tâche échoue, recherchez les erreurs dans les journaux. Si des erreurs ont été enregistrées, leur nombre s'affiche à côté du bouton Logs (Journaux) :

Pour afficher les erreurs relatives à une tâche :

1. Cliquez sur le nombre d'erreurs affiché à côté de Logs (Journaux).

   La console Google Cloud affiche les journaux du job. Vous devrez éventuellement faire défiler l'affichage pour voir les erreurs.

2. Repérez les entrées signalées par l'icône d'erreur .

3. Cliquez sur une entrée de journal pour développer son contenu.

Pour en savoir plus sur la résolution des problèmes liés aux jobs Dataflow, consultez la page Résolvez les problèmes liés à votre pipeline.

Résoudre les problèmes liés aux tâches d'exportation ayant échoué

Si les erreurs suivantes s'affichent dans les journaux de vos tâches :

com.google.cloud.spanner.SpannerException: NOT_FOUND: Session not found

--or--

com.google.cloud.spanner.SpannerException: DEADLINE_EXCEEDED: Deadline expired before operation could complete.

Vérifiez la latence de lecture de 99% dans la l'onglet Surveillance de votre base de données Spanner dans console Google Cloud. Si elle affiche des valeurs élevées (plusieurs secondes), cela signifie que l'instance est surchargée, ce qui entraîne l'expiration et l'échec de la lecture.

Cette latence élevée peut s'expliquer notamment par le fait que la tâche Dataflow s'exécute à l'aide d'un trop grand nombre de nœuds de calcul, ce qui surcharge l'instance Spanner.

Pour spécifier une limite de nœuds de calcul Dataflow, au lieu d'utiliser l'onglet "Import/Export" (Importer/Exporter) sur la page d'informations sur l'instance de votre base de données Spanner dans la console Google Cloud, vous devez démarrer l'exportation à l'aide du modèle Spanner vers Cloud Storage Avro Dataflow et spécifier le nombre maximal de nœuds de calcul, comme décrit ci-dessous :

Console

Si vous utilisez la console Dataflow, la colonne Nombre maximal de nœuds de calcul se trouve dans la section Paramètres facultatifs de la Créer un job à partir d'un modèle.

Accéder à Dataflow

gcloud

Exécutez la commande gcloud dataflow jobs run et spécifiez l'argument max-workers. Exemple :

  gcloud dataflow jobs run my-export-job \
    --gcs-location='gs://dataflow-templates/latest/Cloud_Spanner_to_GCS_Avro' \
    --region=us-central1 \
    --parameters='instanceId=test-instance,databaseId=example-db,outputDir=gs://my-gcs-bucket' \
    --max-workers=10 \
    --network=network-123

Résoudre une erreur réseau

L'erreur suivante peut se produire lorsque vous exportez vos bases de données Spanner :

Workflow failed. Causes: Error: Message: Invalid value for field
'resource.properties.networkInterfaces[0].subnetwork': ''. Network interface
must specify a subnet if the network resource is in custom subnet mode.
HTTP Code: 400

Cette erreur se produit, car Spanner suppose que vous avez l'intention d'utiliser un réseau VPC en mode automatique nommé default dans le même projet que Job Dataflow. Si vous ne disposez pas d'un réseau VPC par défaut projet ou si votre réseau VPC se trouve dans un réseau VPC en mode personnalisé, vous devez créer un job Dataflow et spécifiez un autre réseau ou sous-réseau.

Optimiser les tâches d'exportation lentes

Si vous avez adopté les paramètres initiaux suggérés plus haut, vous n'avez en principe aucun autre réglage à effectuer. Voici toutefois quelques possibilités d'optimisation supplémentaires à envisager si l'exécution de votre tâche est lente :

• Optimisez l'emplacement de la tâche et des données : exécutez votre tâche Dataflow dans la même région que celle où se trouvent votre instance Spanner et votre bucket Cloud Storage.

• Veillez à ce que les ressources Dataflow soient suffisantes : si les ressources de votre tâche Dataflow sont limitées par certains quotas Compute Engine correspondants, la page Dataflow associée à cette tâche dans la console Google Cloud affiche une icône d'avertissement  ainsi qu'un message de journalisation :

  

  Dans ce cas, l'augmentation des quotas en termes de processeurs, d'adresses IP en cours d'utilisation et de disques persistants standards peut accélérer l'exécution de votre tâche, mais également augmenter les frais facturés pour Compute Engine.

• Vérifiez l'utilisation du processeur Spanner: si vous constatez que le processeur de l'instance est supérieure à 65%, vous pouvez augmentez la capacité de calcul de cette instance. La capacité ajoute davantage de ressources Spanner et la tâche devrait accélérer, mais vous devrez payer plus de frais pour Spanner.

Facteurs qui influent sur les performances des tâches d'exportation

Plusieurs facteurs influent sur le temps nécessaire pour mener à bien une tâche d'exportation.

• Taille de la base de données Spanner : le temps de traitement et les ressources requises augmentent avec la quantité de données à traiter.

• Schéma de la base de données Spanner, y compris :

  • Le nombre de tables
  • Taille des lignes
  • Nombre d'index secondaires
  • Le nombre de clés étrangères
  • Nombre de flux de modifications

• Emplacement des données: les données sont transférées entre Spanner et Cloud Storage avec Dataflow. Dans l'idéal, ces trois composants doivent se trouver dans la même région. Dans le cas contraire, le déplacement des données entre les régions ralentit l'exécution de la tâche.

• Nombre de nœuds de calcul Dataflow : les nœuds de calcul Dataflow optimaux sont nécessaires pour de bonnes performances. En utilisant l'autoscaling, Dataflow choisit le nombre de nœuds de calcul pour la tâche en fonction de la quantité de travail à effectuer. Le nombre de nœuds de calcul sera toutefois limité par les quotas en matière de processeurs, d'adresses IP en cours d'utilisation et de disques persistants standards. L'interface utilisateur de Dataflow affiche une icône d'avertissement lorsque des limites de quota sont atteintes. Dans ce cas, la progression est ralentie, mais la tâche doit néanmoins aboutir.

• Charge existante sur Spanner: Une tâche d'exportation ajoute généralement une légère charge sur une instance Spanner Compute Engine. Si cette instance présentait déjà une charge importante, l'exécution de la tâche est ralentie.

• Quantité de capacité de calcul Spanner: si l'utilisation du processeur pour l'instance est supérieure à 65%, le job s'exécute plus lentement.