Le modèle Spanner vers BigQuery est un pipeline par lots qui lit les données d'une table Spanner et les écrit dans BigQuery.
Conditions requises pour ce pipeline
- La table source Spanner doit exister avant l'exécution du pipeline.
- L'ensemble de données BigQuery doit exister avant l'exécution du pipeline.
- Créez un fichier JSON décrivant votre schéma BigQuery.
Le fichier doit contenir un tableau JSON de niveau supérieur intitulé
fields
. Le contenu du tableaufields
doit respecter le format suivant :{"name": "COLUMN_NAME", "type": "DATA_TYPE"}
.Le code JSON suivant décrit un exemple de schéma BigQuery :
{ "fields": [ { "name": "location", "type": "STRING" }, { "name": "name", "type": "STRING" }, { "name": "age", "type": "STRING" }, { "name": "color", "type": "STRING" }, { "name": "coffee", "type": "STRING" } ] }
Le modèle par lots Spanner vers BigQuery n'est pas compatible avec l'importation de données dans les champs
STRUCT
(Enregistrement) de la table BigQuery cible.
Paramètres de modèle
Paramètres obligatoires
- spannerInstanceId : instance Spanner à lire.
- spannerDatabaseId : base de données Spanner à lire.
- spannerTableId : Table Spanner à lire.
- sqlQuery : requête utilisée pour lire la table Spanner.
- outputTableSpec : Emplacement de la table BigQuery dans lequel écrire la sortie. Le nom doit être au format
<project>:<dataset>.<table_name>
. Le schéma de la table doit correspondre aux objets d'entrée.
Paramètres facultatifs
- spannerProjectId : projet dans lequel se trouve l'instance Spanner à lire. La valeur par défaut de ce paramètre correspond au projet dans lequel le pipeline Dataflow est exécuté.
- spannerRpcPriority : priorité de la tâche Spanner. La valeur doit être l'une des suivantes : [HIGH, MEDIUM, LOW]. La valeur par défaut est HIGH.
- bigQuerySchemaPath : chemin d'accès Cloud Storage pour le schéma JSON BigQuery. Si
createDisposition
n'est pas défini ou s'il est défini sur CREATE_IF_NEEDED, ce paramètre doit être spécifié. (Exemple : gs://your-bucket/your-schema.json). - writeDisposition : BigQuery WriteDisposition. Par exemple, WRITE_APPEND, WRITE_EMPTY ou WRITE_TRUNCATE. La valeur par défaut est WRITE_APPEND.
- createDisposition : BigQuery CreateDisposition. Par exemple, CREATE_IF_NEEDED, CREATE_NEVER. La valeur par défaut est CREATE_IF_NEEDED.
- useStorageWriteApi : si cette option est activée (définie sur "true"), le pipeline utilise l'API Storage Write lors de l'écriture des données dans BigQuery (voir https://cloud.google.com/blog/products/data-analytics/streaming-data-into-bigquery-using-storage-write-api). La valeur par défaut est "false".
- useStorageWriteApiAtLeastOnce : ce paramètre ne prend effet que si l'option "Utiliser l'API BigQuery Storage Write" est activée. Si cette option est activée, la sémantique de type "au moins une fois" est utilisée pour l'API Storage Write. Sinon, la sémantique de type "exactement une fois" est utilisée. La valeur par défaut est "false".
Exécuter le modèle
Console
- Accédez à la page Dataflow Créer un job à partir d'un modèle. Accéder à la page Créer un job à partir d'un modèle
- Dans le champ Nom du job, saisissez un nom de job unique.
- Facultatif : pour Point de terminaison régional, sélectionnez une valeur dans le menu déroulant. La région par défaut est
us-central1
.Pour obtenir la liste des régions dans lesquelles vous pouvez exécuter un job Dataflow, consultez la page Emplacements Dataflow.
- Dans le menu déroulant Modèle Dataflow, sélectionnez the Spanner to BigQuery template.
- Dans les champs fournis, saisissez vos valeurs de paramètres.
- Cliquez sur Run Job (Exécuter la tâche).
gcloud
Dans le shell ou le terminal, exécutez le modèle :
gcloud dataflow flex-template run JOB_NAME \ --template-file-gcs-location=gs://dataflow-templates-REGION_NAME/VERSION/flex/Cloud_Spanner_to_BigQuery_Flex \ --project=PROJECT_ID \ --region=REGION_NAME \ --parameters \ spannerInstanceId=SPANNER_INSTANCE_ID,\ spannerDatabaseId=SPANNER_DATABASE_ID,\ spannerTableId=SPANNER_TABLE_ID,\ sqlQuery=SQL_QUERY,\ outputTableSpec=OUTPUT_TABLE_SPEC,\
Remplacez les éléments suivants :
JOB_NAME
: nom de job unique de votre choixVERSION
: version du modèle que vous souhaitez utiliserVous pouvez utiliser les valeurs suivantes :
latest
pour utiliser la dernière version du modèle, disponible dans le dossier parent non daté du bucket gs://dataflow-templates-REGION_NAME/latest/- Le nom de la version, par exemple
2023-09-12-00_RC00
, pour utiliser une version spécifique du modèle, qui est imbriqué dans le dossier parent daté respectif dans le bucket : gs://dataflow-templates-REGION_NAME/
REGION_NAME
: région dans laquelle vous souhaitez déployer votre job Dataflow, par exempleus-central1
SPANNER_INSTANCE_ID
: ID d'instance SpannerSPANNER_DATABASE_ID
: ID de la base de données SpannerSPANNER_TABLE_ID
: nom de la table SpannerSQL_QUERY
: requête SQLOUTPUT_TABLE_SPEC
: emplacement de la table BigQuery
API
Pour exécuter le modèle à l'aide de l'API REST, envoyez une requête HTTP POST. Pour en savoir plus sur l'API, ses autorisations et leurs champs d'application, consultez la section projects.templates.launch
.
POST https://dataflow.googleapis.com/v1b3/projects/PROJECT_ID/locations/LOCATION/flexTemplates:launch { "launchParameter": { "jobName": "JOB_NAME", "parameters": { "spannerInstanceId": "SPANNER_INSTANCE_ID", "spannerDatabaseId": "SPANNER_DATABASE_ID", "spannerTableId": "SPANNER_TABLE_ID", "sqlQuery": "SQL_QUERY", "outputTableSpec": "OUTPUT_TABLE_SPEC", }, "containerSpecGcsPath": "gs://dataflow-templates-LOCATION/VERSION/flex/Cloud_Spanner_to_BigQuery_Flex", "environment": { "maxWorkers": "10" } } }
Remplacez les éléments suivants :
PROJECT_ID
: ID du projet Google Cloud dans lequel vous souhaitez exécuter le job DataflowJOB_NAME
: nom de job unique de votre choixVERSION
: version du modèle que vous souhaitez utiliserVous pouvez utiliser les valeurs suivantes :
latest
pour utiliser la dernière version du modèle, disponible dans le dossier parent non daté du bucket gs://dataflow-templates-REGION_NAME/latest/- Le nom de la version, par exemple
2023-09-12-00_RC00
, pour utiliser une version spécifique du modèle, qui est imbriqué dans le dossier parent daté respectif dans le bucket : gs://dataflow-templates-REGION_NAME/
LOCATION
: région dans laquelle vous souhaitez déployer votre job Dataflow, par exempleus-central1
SPANNER_INSTANCE_ID
: ID d'instance SpannerSPANNER_DATABASE_ID
: ID de la base de données SpannerSPANNER_TABLE_ID
: nom de la table SpannerSQL_QUERY
: requête SQLOUTPUT_TABLE_SPEC
: emplacement de la table BigQuery
Étapes suivantes
- Apprenez-en plus sur les modèles Dataflow.
- Consultez la liste des modèles fournis par Google.