Modello da Datastream a BigQuery (stream)

Il modello da Datastream a BigQuery è una pipeline in modalità flusso che legge i dati di Datastream e li replica in BigQuery. Il modello legge i dati da Cloud Storage utilizzando le notifiche Pub/Sub e li replica in una tabella temporanea BigQuery partizionata nel tempo. Dopo la replica, il modello esegue un comando MERGE in BigQuery per eseguire l'upsert di tutte le modifiche di Change Data Capture (CDC) in una replica della tabella di origine.

Il modello gestisce la creazione e l'aggiornamento delle tabelle BigQuery gestite dalla replica. Quando è richiesto un Data Definition Language (DDL), un callback a Datastream estrae lo schema della tabella di origine e lo traduce in tipi di dati BigQuery. Le operazioni supportate includono:

  • Vengono create nuove tabelle man mano che vengono inseriti i dati.
  • Alle tabelle BigQuery vengono aggiunte nuove colonne con valori iniziali nulli.
  • Le colonne eliminate vengono ignorate in BigQuery e i valori futuri sono nulli.
  • Le colonne rinominate vengono aggiunte a BigQuery come nuove colonne.
  • Le modifiche del tipo non vengono propagate in BigQuery.

Ti consigliamo di eseguire questa pipeline utilizzando la modalità flusso at-least-once, perché il modello esegue la deduplicazione quando unisce i dati di una tabella BigQuery temporanea alla tabella BigQuery principale. Questo passaggio della pipeline significa che l'utilizzo della modalità di flusso "exactly-once" non comporta alcun vantaggio aggiuntivo.

Requisiti della pipeline

  • Un flusso Datastream pronto o già in fase di replica dei dati.
  • Le notifiche Pub/Sub di Cloud Storage sono abilitate per i dati Datastream.
  • I set di dati di destinazione BigQuery vengono creati e all'account di servizio Compute Engine è stato concesso l'accesso amministrativo.
  • Per creare la tabella della replica di destinazione, è necessaria una chiave primaria nella tabella di origine.
  • Un database di origine MySQL o Oracle. I database PostgreSQL non sono supportati.

Parametri del modello

Parametro Descrizione
inputFilePattern La posizione dei file Datastream in Cloud Storage da replicare. Questa posizione del file è in genere il percorso principale del flusso.
gcsPubSubSubscription La sottoscrizione Pub/Sub con notifiche sui file Datastream. Ad esempio, projects/my-project-id/subscriptions/my-subscription-id.
inputFileFormat Il formato del file di output prodotto da Datastream. Ad esempio avro,json. Valore predefinito: avro.
outputStagingDatasetTemplate Il nome di un set di dati esistente che conterrà le tabelle di gestione temporanea. Puoi includere il modello {_metadata_dataset} come segnaposto che viene sostituito con il nome del set di dati/schema di origine (ad es. {_metadata_dataset}_log).
outputDatasetTemplate Il nome di un set di dati esistente che conterrà le tabelle di replica. Puoi includere il modello {_metadata_dataset} come segnaposto che viene sostituito con il nome del set di dati/schema di origine (ad es. {_metadata_dataset}).
deadLetterQueueDirectory Il percorso del file per l'archiviazione dei messaggi non elaborati con il motivo per cui l'elaborazione non è riuscita. Il valore predefinito è una directory sotto la località temporanea del job Dataflow. Il valore predefinito è sufficiente nella maggior parte delle condizioni.
outputStagingTableNameTemplate (Facoltativo) Il modello per il nome delle tabelle temporanee. Il valore predefinito è {_metadata_table}_log. Se stai replicando più schemi, il suggerimento è {_metadata_schema}_{_metadata_table}_log.
outputTableNameTemplate (Facoltativo) Il modello per il nome delle tabelle di replica. Valore predefinito: {_metadata_table}. Se stai replicando più schemi, il suggerimento è {_metadata_schema}_{_metadata_table}.
outputProjectId Facoltativo: progetto per set di dati BigQuery in cui eseguire l'output dei dati. Il valore predefinito di questo parametro è il progetto in cui è in esecuzione la pipeline Dataflow.
streamName (Facoltativo) Nome o modello del flusso di cui eseguire il polling delle informazioni sullo schema. Valore predefinito: {_metadata_stream}.
mergeFrequencyMinutes (Facoltativo) Il numero di minuti tra un'unione e una determinata tabella. Valore predefinito, 5.
dlqRetryMinutes (Facoltativo) Il numero di minuti tra i nuovi tentativi in coda dei messaggi non recapitabili (DLQ). Valore predefinito, 10.
javascriptTextTransformGcsPath Facoltativo: L'URI Cloud Storage del file .js che definisce la funzione JavaScript definita dall'utente che vuoi utilizzare. Ad esempio: gs://my-bucket/my-udfs/my_file.js.
javascriptTextTransformFunctionName (Facoltativo) Il nome della funzione definita dall'utente di JavaScript che vuoi utilizzare. Ad esempio, se il codice della funzione JavaScript è myTransform(inJson) { /*...do stuff...*/ }, il nome della funzione è myTransform. Per esempi di funzioni JavaScript definite, consulta gli esempi di funzioni definite dall'utente.
useStorageWriteApi (Facoltativo) Se true, la pipeline utilizza l' API BigQuery Storage Write. Il valore predefinito è false. Per ulteriori informazioni, consulta la pagina relativa all' utilizzo dell'API Storage Write.
useStorageWriteApiAtLeastOnce (Facoltativo) Quando si utilizza l'API Storage Write, specifica la semantica di scrittura. Per utilizzare la semantica at-least-once, imposta questo parametro su true. Per usare la semantica "exactly-once", imposta il parametro su false. Questo parametro si applica solo quando useStorageWriteApi è true. Il valore predefinito è false.
numStorageWriteApiStreams (Facoltativo) Quando si utilizza l'API Storage Write, specifica il numero di flussi di scrittura. Se useStorageWriteApi è true e useStorageWriteApiAtLeastOnce è false, devi impostare questo parametro.
storageWriteApiTriggeringFrequencySec Facoltativo: quando utilizzi l'API Storage Write, specifica la frequenza di attivazione in secondi. Se useStorageWriteApi è true e useStorageWriteApiAtLeastOnce è false, devi impostare questo parametro.
applyMerge (Facoltativo) Specifica se il modello esegue un'istruzione MERGE in BigQuery dopo aver replicato i dati nella tabella temporanea. Valore predefinito: true.
fileReadConcurrency (Facoltativo) Il numero di file Datastream da leggere contemporaneamente. Valore predefinito: 10.
mergeConcurrency (Facoltativo) Il numero di istruzioni BigQuery MERGE simultanee. Valore predefinito: 30.
partitionRetentionDays (Facoltativo) Il numero di giorni da utilizzare per la conservazione della partizione quando si eseguono istruzioni MERGE di BigQuery. Valore predefinito: 1.
rfcStartDateTime (Facoltativo) L'ora di inizio della lettura dei file da Cloud Storage, sotto forma di valore di data e ora RFC 3339. Valore predefinito: 1970-01-01T00:00:00.00Z.

Funzione definita dall'utente

Facoltativamente, puoi estendere questo modello scrivendo una funzione definita dall'utente (UDF). Il modello chiama la funzione definita dall'utente per ogni elemento di input. I payload degli elementi sono serializzati come stringhe JSON. Per ulteriori informazioni, consulta Creare funzioni definite dall'utente per i modelli Dataflow.

Specifica della funzione

La funzione definita dall'utente ha le seguenti specifiche:

  • Input: i dati CDC, serializzati come stringa JSON.
  • Output: una stringa JSON corrispondente allo schema della tabella di destinazione BigQuery.
  • Esegui il modello

    Console

    1. Vai alla pagina Crea job da modello di Dataflow.
    2. Vai a Crea job da modello
    3. Nel campo Nome job, inserisci un nome univoco per il job.
    4. (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.

    5. Nel menu a discesa Modello Dataflow, seleziona the Datastream to BigQuery template.
    6. Nei campi dei parametri forniti, inserisci i valori dei parametri.
    7. (Facoltativo) Per passare dall'elaborazione "exactly-once" alla modalità di streaming "at-least-once", seleziona Almeno una volta.
    8. Fai clic su Esegui job.

    gcloud

    Nella shell o nel terminale, esegui il modello:

    gcloud dataflow flex-template run JOB_NAME \
        --project=PROJECT_ID \
        --region=REGION_NAME \
        --enable-streaming-engine \
        --template-file-gcs-location=gs://dataflow-templates-REGION_NAME/VERSION/flex/Cloud_Datastream_to_BigQuery \
        --parameters \
    inputFilePattern=GCS_FILE_PATH,\
    gcsPubSubSubscription=GCS_SUBSCRIPTION_NAME,\
    outputStagingDatasetTemplate=BIGQUERY_DATASET,\
    outputDatasetTemplate=BIGQUERY_DATASET,\
    outputStagingTableNameTemplate=BIGQUERY_TABLE,\
    outputTableNameTemplate=BIGQUERY_TABLE_log
      

    Sostituisci quanto segue:

    • PROJECT_ID: l'ID del progetto Google Cloud in cui vuoi eseguire il job Dataflow
    • JOB_NAME: un nome job univoco a tua scelta
    • REGION_NAME: la regione in cui vuoi eseguire il deployment del job Dataflow, ad esempio us-central1
    • VERSION: the version of the template that you want to use

      You can use the following values:

    • GCS_FILE_PATH: percorso Cloud Storage ai dati di Datastream. Ad esempio: gs://bucket/path/to/data/
    • GCS_SUBSCRIPTION_NAME: la sottoscrizione Pub/Sub da cui leggere i file modificati. Ad esempio: projects/my-project-id/subscriptions/my-subscription-id.
    • BIGQUERY_DATASET: nome del tuo set di dati BigQuery.
    • BIGQUERY_TABLE: il tuo modello di tabella BigQuery. Ad esempio, {_metadata_schema}_{_metadata_table}_log

    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": {
    
              "inputFilePattern": "GCS_FILE_PATH",
              "gcsPubSubSubscription": "GCS_SUBSCRIPTION_NAME",
              "outputStagingDatasetTemplate": "BIGQUERY_DATASET",
              "outputDatasetTemplate": "BIGQUERY_DATASET",
              "outputStagingTableNameTemplate": "BIGQUERY_TABLE",
              "outputTableNameTemplate": "BIGQUERY_TABLE_log"
          },
          "containerSpecGcsPath": "gs://dataflow-templates-LOCATION/VERSION/flex/Cloud_Datastream_to_BigQuery",
       }
    }
      

    Sostituisci quanto segue:

    • PROJECT_ID: l'ID del progetto Google Cloud in cui vuoi eseguire il job Dataflow
    • JOB_NAME: un nome job univoco a tua scelta
    • LOCATION: la regione in cui vuoi eseguire il deployment del job Dataflow, ad esempio us-central1
    • VERSION: the version of the template that you want to use

      You can use the following values:

    • GCS_FILE_PATH: percorso Cloud Storage ai dati di Datastream. Ad esempio: gs://bucket/path/to/data/
    • GCS_SUBSCRIPTION_NAME: la sottoscrizione Pub/Sub da cui leggere i file modificati. Ad esempio: projects/my-project-id/subscriptions/my-subscription-id.
    • BIGQUERY_DATASET: nome del tuo set di dati BigQuery.
    • BIGQUERY_TABLE: il tuo modello di tabella BigQuery. Ad esempio, {_metadata_schema}_{_metadata_table}_log

    Passaggi successivi