Modello da testo a BigQuery (stream) di Cloud Storage

La pipeline da testo a BigQuery da Cloud Storage è una pipeline di inserimento flussi che trasmette in flussi di file di testo archiviati in Cloud Storage, li trasforma utilizzando una funzione JavaScript definita dall'utente (UDF) da te fornita e aggiunge il risultato a BigQuery.

La pipeline è in esecuzione a tempo indeterminato e deve essere terminata manualmente tramite cancel e non svuotamento, a causa dell'utilizzo della trasformazione Watch, che è una dimensione DoFn con possibilità di suddivisione che non supporta lo svuotamento.

Requisiti della pipeline

  • Crea un file JSON che descriva lo schema della tabella di output in BigQuery.

    Assicurati che esista un array JSON di primo livello denominato fields e che i suoi contenuti seguano il pattern {"name": "COLUMN_NAME", "type": "DATA_TYPE"}. Ad esempio: 

    {
  "fields": [
    {
      "name": "name",
      "type": "STRING"
    },
    {
      "name": "age",
      "type": "INTEGER"
    }
  ]
}
  • Crea un file JavaScript (.js) con la tua funzione UDF che fornisce la logica per trasformare le righe di testo. La funzione deve restituire una stringa JSON.

    L'esempio seguente divide ogni riga di un file CSV, crea un oggetto JSON con i valori e restituisce una stringa JSON:

    function process(inJson) {
  val = inJson.split(",");

  const obj = {
    "name": val[0],
    "age": parseInt(val[1])
  };
  return JSON.stringify(obj);
}

Parametri del modello

Parametri obbligatori

  • inputFilePattern : il percorso gs:// del testo in Cloud Storage che vuoi elaborare. (Esempio: gs://your-bucket/your-file.txt).
  • JSONPath : il percorso gs:// del file JSON che definisce lo schema BigQuery, archiviato in Cloud Storage. (Esempio: gs://your-bucket/your-schema.json).
  • outputTable : la posizione della tabella BigQuery da utilizzare per archiviare i dati elaborati. Se riutilizzi una tabella esistente, questa viene sovrascritta. Esempio: <PROJECT_ID>:<DATASET_NAME>.<TABLE_NAME>.
  • javascriptTextTransformGcsPath : l'URI Cloud Storage del file .js che definisce la funzione definita dall'utente dall'utente JavaScript che vuoi utilizzare. (Esempio: gs://your-bucket/your-transforms/*.js).
  • javascriptTextTransformFunctionName : il nome della funzione definita dall'utente 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 definite dall'utente JavaScript, consulta gli esempi di funzione definita dall'utente (https://github.com/GoogleCloudPlatform/DataflowTemplates#udf-examples) (ad esempio: transform_udf1).
  • bigQueryLoadingTemporaryDirectory : directory temporanea per il processo di caricamento di BigQuery. Esempio: gs://your-bucket/your-files/temp-dir.

Parametri facoltativi

  • outputDeadletterTable : tabella per i messaggi che non sono riusciti a raggiungere la tabella di output. Se non esiste una tabella, viene creata durante l'esecuzione della pipeline. Se non specificato, viene utilizzato <outputTableSpec>_error_records. Esempio: <PROJECT_ID>:<DATASET_NAME>.<TABLE_NAME>.
  • useStorageWriteApiAtLeastOnce : questo parametro diventa effettivo solo se è abilitata l'opzione "Utilizza l'API BigQuery Storage Write". Se abilitata, verrà usata la semantica "at-least-once" per l'API Storage Write, altrimenti verrà usata la semantica "exactly-once". Il valore predefinito è: false.
  • useStorageWriteApi : se true, la pipeline utilizza l'API BigQuery Storage Write (https://cloud.google.com/bigquery/docs/write-api). Il valore predefinito è false. Per saperne di più, consulta la pagina relativa all'utilizzo dell'API Storage Write (https://beam.apache.org/documentation/io/built-in/google-bigquery/#storage-write-api).
  • numStorageWriteApiStreams : quando si utilizza l'API Storage Write, specifica il numero di flussi di scrittura. Se useStorageWriteApi è true e useStorageWriteApiAtLeastOnce è false, devi impostare questo parametro. Il valore predefinito è 0.
  • storageWriteApiTriggeringFrequencySec : quando utilizzi l'API Storage Write, specifica la frequenza di attivazione in secondi. Se useStorageWriteApi è true e useStorageWriteApiAtLeastOnce è false, devi impostare questo parametro.
  • pythonExternalTextTransformGcsPath : il pattern di percorso di Cloud Storage per il codice Python contenente le funzioni definite dall'utente. (Esempio: gs://your-bucket/your-function.py.
  • javascriptTextTransformReloadIntervalMinutes : specifica la frequenza con cui ricaricare la funzione definita dall'utente, in minuti. Se il valore è maggiore di 0, Dataflow controlla periodicamente il file della funzione definita dall'utente in Cloud Storage e, se il file viene modificato, la ricarica. Questo parametro consente di aggiornare la funzione definita dall'utente mentre la pipeline è in esecuzione, senza dover riavviare il job. Se il valore è 0, il ricaricamento delle funzioni definite dall'utente è disabilitato. Il valore predefinito è 0.

Funzione definita dall'utente

Questo modello richiede una funzione definita dall'utente che analizza i file di input, come descritto nei requisiti della pipeline. Il modello chiama la funzione definita dall'utente per ogni riga di testo in ogni file di input. Per ulteriori informazioni sulla creazione di funzioni definite dall'utente, consulta Creare funzioni definite dall'utente per i modelli Dataflow.

Specifica della funzione

La funzione definita dall'utente ha le seguenti specifiche:

  • Input: una singola riga di testo di un file di input.
  • 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
  2. Nel campo Nome job, inserisci un nome univoco per il job.
  3. (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.

  4. Nel menu a discesa Modello Dataflow, seleziona the Cloud Storage Text to BigQuery (Stream) template.
  5. Nei campi dei parametri forniti, inserisci i valori dei parametri.
  6. 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/Stream_GCS_Text_to_BigQuery_Flex \
    --region REGION_NAME \
    --staging-location STAGING_LOCATION \
    --parameters \
javascriptTextTransformGcsPath=PATH_TO_JAVASCRIPT_UDF_FILE,\
javascriptTextTransformFunctionName=JAVASCRIPT_FUNCTION,\
JSONPath=PATH_TO_BIGQUERY_SCHEMA_JSON,\
inputFilePattern=PATH_TO_TEXT_DATA,\
outputTable=BIGQUERY_TABLE,\
outputDeadletterTable=BIGQUERY_UNPROCESSED_TABLE,\
bigQueryLoadingTemporaryDirectory=PATH_TO_TEMP_DIR_ON_GCS

Sostituisci quanto segue:

  • 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: la versione del modello che vuoi utilizzare

    Puoi utilizzare i seguenti valori:

  • STAGING_LOCATION: la posizione per la gestione temporanea dei file locali (ad esempio, gs://your-bucket/staging)
  • JAVASCRIPT_FUNCTION: il nome della funzione definita dall'utente dall'utente 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.

  • PATH_TO_BIGQUERY_SCHEMA_JSON: il percorso Cloud Storage del file JSON contenente la definizione dello schema
  • PATH_TO_JAVASCRIPT_UDF_FILE: 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
  • PATH_TO_TEXT_DATA: il percorso Cloud Storage del set di dati di testo
  • BIGQUERY_TABLE: nome della tua tabella BigQuery
  • BIGQUERY_UNPROCESSED_TABLE: il nome della tabella BigQuery per i messaggi non elaborati
  • PATH_TO_TEMP_DIR_ON_GCS: percorso Cloud Storage della directory temporanea

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": {
       "javascriptTextTransformFunctionName": "JAVASCRIPT_FUNCTION",
       "JSONPath": "PATH_TO_BIGQUERY_SCHEMA_JSON",
       "javascriptTextTransformGcsPath": "PATH_TO_JAVASCRIPT_UDF_FILE",
       "inputFilePattern":"PATH_TO_TEXT_DATA",
       "outputTable":"BIGQUERY_TABLE",
       "outputDeadletterTable":"BIGQUERY_UNPROCESSED_TABLE",
       "bigQueryLoadingTemporaryDirectory": "PATH_TO_TEMP_DIR_ON_GCS"
      },
      "containerSpecGcsPath": "gs://dataflow-templates-LOCATION/VERSION/flex/Stream_GCS_Text_to_BigQuery_Flex",
   }
}

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: la versione del modello che vuoi utilizzare

    Puoi utilizzare i seguenti valori:

  • STAGING_LOCATION: la posizione per la gestione temporanea dei file locali (ad esempio, gs://your-bucket/staging)
  • JAVASCRIPT_FUNCTION: il nome della funzione definita dall'utente dall'utente 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.

  • PATH_TO_BIGQUERY_SCHEMA_JSON: il percorso Cloud Storage del file JSON contenente la definizione dello schema
  • PATH_TO_JAVASCRIPT_UDF_FILE: 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
  • PATH_TO_TEXT_DATA: il percorso Cloud Storage del set di dati di testo
  • BIGQUERY_TABLE: nome della tua tabella BigQuery
  • BIGQUERY_UNPROCESSED_TABLE: il nome della tabella BigQuery per i messaggi non elaborati
  • PATH_TO_TEMP_DIR_ON_GCS: percorso Cloud Storage della directory temporanea

Passaggi successivi