Le modifiche in tempo reale di Spanner verso il modello Pub/Sub sono una pipeline di inserimento flussi che trasmette in streaming i record delle modifiche dei dati di Spanner e li scrive in argomenti Pub/Sub utilizzando Dataflow Runner V2.
Per generare i dati in un nuovo argomento Pub/Sub, devi prima creare l'argomento. Dopo la creazione, Pub/Sub genera e collega automaticamente una sottoscrizione al nuovo argomento. Se provi a inviare i dati in un argomento Pub/Sub che non esiste, la pipeline di Dataflow genera un'eccezione e si blocca durante i tentativi continui di stabilire una connessione.
Se l'argomento Pub/Sub necessario esiste già, puoi eseguire l'output dei dati in quell'argomento.
Per maggiori informazioni, consulta Informazioni sui flussi di modifiche, Creare connessioni di modifiche in tempo reale con Dataflow e Best practice per i flussi di modifiche.
Requisiti della pipeline
- L'istanza Spanner deve esistere prima di eseguire la pipeline.
- Il database Spanner deve esistere prima dell'esecuzione della pipeline.
- L'istanza di metadati Spanner deve esistere prima dell'esecuzione della pipeline.
- Il database di metadati Spanner deve esistere prima dell'esecuzione della pipeline.
- Il flusso di modifiche di Spanner deve esistere prima dell'esecuzione della pipeline.
- L'argomento Pub/Sub deve esistere prima dell'esecuzione della pipeline.
Parametri del modello
Parametri obbligatori
- spannerInstanceId : l'istanza Spanner da cui leggere modifiche in tempo reale.
- spannerDatabase : il database Spanner da cui leggere modifiche in tempo reale.
- spannerMetadataInstanceId : l'istanza Spanner da utilizzare per la tabella dei metadati del connettore delle modifiche in tempo reale.
- spannerMetadataDatabase : il database Spanner da utilizzare per la tabella dei metadati del connettore modifiche in tempo reale.
- spannerChangeStreamName : il nome del flusso di modifiche di Spanner da cui leggere.
- pubsubTopic : l'argomento Pub/Sub per l'output delle modifiche in tempo reale.
Parametri facoltativi
- spannerProjectId : il progetto da cui leggere le modifiche in tempo reale. In questo progetto viene anche creata la tabella dei metadati del connettore di modifiche in tempo reale. Il valore predefinito di questo parametro è il progetto in cui è in esecuzione la pipeline Dataflow.
- spannerDatabaseRole : il ruolo del database Spanner da utilizzare durante l'esecuzione del modello. Questo parametro è obbligatorio solo se l'entità IAM che esegue il modello è un utente con controllo dell'accesso dell'accesso granulare. Il ruolo del database deve disporre del privilegio
SELECT
per il flusso di modifiche e del privilegioEXECUTE
per la funzione di lettura del flusso di modifiche. Per ulteriori informazioni, vedi Controllo dell'accesso granulare per le modifiche in tempo reale (https://cloud.google.com/spanner/docs/fgac-change-streams). - spannerMetadataTableName : il nome della tabella dei metadati del connettore dei modifiche in tempo reale di Spanner da utilizzare. Se non fornito, Spanner crea automaticamente la tabella dei metadati del connettore di stream durante la modifica del flusso della pipeline. Devi fornire questo parametro durante l'aggiornamento di una pipeline esistente. Non utilizzare questo parametro per altri casi.
- startTimestamp : la data/ora iniziale (https://tools.ietf.org/html/rfc3339), inclusa, da utilizzare per la lettura dei modifiche in tempo reale. Ad esempio, ad esempio 2021-10-12T07:20:50.52Z. Il valore predefinito è il timestamp di inizio della pipeline, ovvero l'ora attuale.
- endTimestamp : il timestamp finale (https://tools.ietf.org/html/rfc3339), incluso, da utilizzare per leggere le modifiche in tempo reale. Ad esempio, ad esempio 2021-10-12T07:20:50.52Z. Il valore predefinito è un tempo infinito nel futuro.
- spannerHost : l'endpoint Cloud Spanner da chiamare nel modello. Utilizzato solo per i test. (Esempio: https://spanner.googleapis.com). Il valore predefinito è https://spanner.googleapis.com.
- outputDataFormat : il formato dell'output. L'output viene aggregato in molti Pub/SubMessage e inviato a un argomento Pub/Sub. I formati consentiti sono JSON e AVRO. Il valore predefinito è JSON.
- pubsubAPI : l'API Pub/Sub utilizzata per implementare la pipeline. Le API consentite sono
pubsubio
enative_client
. Per un numero limitato di query al secondo (QPS),native_client
ha una latenza minore. Per un numero elevato di QPS,pubsubio
offre prestazioni migliori e più stabili. Il valore predefinito èpubsubio
. - pubsubProjectId : progetto dell'argomento Pub/Sub. Il valore predefinito di questo parametro è il progetto in cui è in esecuzione la pipeline Dataflow.
- rpcPriority : la priorità della richiesta per le chiamate Spanner. I valori consentiti sono HIGH, MEDIUM e LOW. Il valore predefinito è HIGH).
Esegui il modello
Console
- Vai alla pagina Crea job da modello di Dataflow. Vai a Crea job da modello
- Nel campo Nome job, inserisci un nome univoco per il job.
- (Facoltativo) Per Endpoint a livello di regione, seleziona un valore dal menu a discesa. La regione predefinita è
us-central1
.Per un elenco delle regioni in cui puoi eseguire un job Dataflow, vedi Località Dataflow.
- Nel menu a discesa Modello Dataflow, seleziona the Cloud Spanner change streams to Pub/Sub template.
- Nei campi dei parametri forniti, inserisci i valori dei parametri.
- Fai clic su Esegui job.
gcloud
Nella shell o nel terminale, esegui il modello:
gcloud dataflow flex-template run JOB_NAME \ --template-file-gcs-location=gs://dataflow-templates-REGION_NAME/VERSION/flex/Spanner_Change_Streams_to_PubSub \ --region REGION_NAME \ --parameters \ spannerInstanceId=SPANNER_INSTANCE_ID,\ spannerDatabase=SPANNER_DATABASE,\ spannerMetadataInstanceId=SPANNER_METADATA_INSTANCE_ID,\ spannerMetadataDatabase=SPANNER_METADATA_DATABASE,\ spannerChangeStreamName=SPANNER_CHANGE_STREAM,\ pubsubTopic=PUBSUB_TOPIC
Sostituisci quanto segue:
JOB_NAME
: un nome job univoco a tua sceltaVERSION
: la versione del modello che vuoi utilizzarePuoi utilizzare i seguenti valori:
latest
per utilizzare la versione più recente del modello, disponibile nella cartella padre senza data del bucket: gs://dataflow-templates-REGION_NAME/latest/- il nome della versione, come
2023-09-12-00_RC00
, per utilizzare una versione specifica del modello, che si trova nidificata nella rispettiva cartella padre con data all'interno del bucket: gs://dataflow-templates-REGION_NAME/
REGION_NAME
: la regione in cui vuoi eseguire il deployment del job Dataflow, ad esempious-central1
SPANNER_INSTANCE_ID
: ID istanza SpannerSPANNER_DATABASE
: database SpannerSPANNER_METADATA_INSTANCE_ID
: ID istanza di metadati SpannerSPANNER_METADATA_DATABASE
: database di metadati SpannerSPANNER_CHANGE_STREAM
: flusso di modifiche di SpannerPUBSUB_TOPIC
: l'argomento Pub/Sub per l'output dei modifiche in tempo reale
API
Per eseguire il modello utilizzando l'API REST, invia una richiesta POST HTTP. Per maggiori informazioni sull'API e sui relativi ambiti di autorizzazione, consulta projects.templates.launch
.
POST https://dataflow.googleapis.com/v1b3/projects/PROJECT_ID/locations/LOCATION/flexTemplates:launch { "launch_parameter": { "jobName": "JOB_NAME", "parameters": { "spannerInstanceId": "SPANNER_INSTANCE_ID", "spannerDatabase": "SPANNER_DATABASE", "spannerMetadataInstanceId": "SPANNER_METADATA_INSTANCE_ID", "spannerMetadataDatabase": "SPANNER_METADATA_DATABASE", "spannerChangeStreamName": "SPANNER_CHANGE_STREAM", "pubsubTopic": "PUBSUB_TOPIC" }, "containerSpecGcsPath": "gs://dataflow-templates-LOCATION/VERSION/flex/Spanner_Change_Streams_to_PubSub", } }
Sostituisci quanto segue:
PROJECT_ID
: l'ID del progetto Google Cloud in cui vuoi eseguire il job DataflowJOB_NAME
: un nome job univoco a tua sceltaVERSION
: la versione del modello che vuoi utilizzarePuoi utilizzare i seguenti valori:
latest
per utilizzare la versione più recente del modello, disponibile nella cartella padre senza data del bucket: gs://dataflow-templates-REGION_NAME/latest/- il nome della versione, come
2023-09-12-00_RC00
, per utilizzare una versione specifica del modello, che si trova nidificata nella rispettiva cartella padre con data all'interno del bucket: gs://dataflow-templates-REGION_NAME/
LOCATION
: la regione in cui vuoi eseguire il deployment del job Dataflow, ad esempious-central1
SPANNER_INSTANCE_ID
: ID istanza SpannerSPANNER_DATABASE
: database SpannerSPANNER_METADATA_INSTANCE_ID
: ID istanza di metadati SpannerSPANNER_METADATA_DATABASE
: database di metadati SpannerSPANNER_CHANGE_STREAM
: flusso di modifiche di SpannerPUBSUB_TOPIC
: l'argomento Pub/Sub per l'output dei modifiche in tempo reale
Passaggi successivi
- Scopri di più sui modelli Dataflow.
- Consulta l'elenco dei modelli forniti da Google.