Plantilla de BigQuery a Elasticsearch

La plantilla de BigQuery a Elasticsearch es una canalización por lotes que transfiere datos de una tabla de BigQuery a Elasticsearch como documentos. La plantilla puede leer toda la tabla o registros específicos mediante una consulta proporcionada.

Requisitos de la canalización

La tabla de origen de BigQuery debe existir.
Un host de Elasticsearch en una instancia de Google Cloud o en Elastic Cloud con Elasticsearch versión 7.0 o posterior. Se debe poder acceder desde las máquinas de trabajador de Dataflow.

Parámetros de la plantilla

Parámetro	Descripción
`connectionUrl`	URL de Elasticsearch en el formato `https://hostname:[port]` o especificar el CloudID si usas Elastic Cloud.
`apiKey`	Clave de API codificada en Base64 que se usa para la autenticación.
`index`	El índice de Elasticsearch en el que se emitirá la solicitud, por ejemplo, `my-index`.
`inputTableSpec`	Tabla de BigQuery desde la que se puede leer para insertar en Elasticsearch (opcional). Se debe proporcionar la tabla o la consulta. Por ejemplo, `projectId:datasetId.tablename`.
`query`	Consulta de SQL para extraer datos de BigQuery (opcional). Se debe proporcionar la tabla o la consulta.
`useLegacySql`	Configurado como verdadero para usar SQL heredado (solo se aplica si se proporciona una consulta) (opcional). Valor predeterminado: `false`.
`batchSize`	El tamaño del lote en cantidad de documentos (opcional). Valor predeterminado: `1000`.
`batchSizeBytes`	El tamaño del lote en cantidad de bytes (opcional). Valor predeterminado: `5242880` (5 MB).
`maxRetryAttempts`	La cantidad máxima de reintentos debe ser mayor que 0 (opcional). Valor predeterminado: `no retries`.
`maxRetryDuration`	La duración máxima del reintento en milisegundos debe ser superior a 0 (opcional). Valor predeterminado: `no retries`.
`propertyAsIndex`	Opcional: Una propiedad en el documento que se indexa, cuyo valor especificará los metadatos `_index` para incluir con el documento en la solicitud masiva (tiene prioridad sobre una UDF `_index`). Valor predeterminado: none.
`propertyAsId`	Opcional: Una propiedad en el documento que se indexa, cuyo valor especificará los metadatos `_id` para incluir con el documento en la solicitud masiva (tiene prioridad sobre una UDF `_id`). Valor predeterminado: none.
`javaScriptIndexFnGcsPath`	La ruta de Cloud Storage a la fuente de UDF de JavaScript para una función que especificará los metadatos `_index` a fin de incluir el documento en la solicitud masiva (opcional). Valor predeterminado: none.
`javaScriptIndexFnName`	Opcional: El nombre de función de JavaScript de la UDF para la función que especificará los metadatos `_index` que se incluirán en el documento en la solicitud masiva. Valor predeterminado: none.
`javaScriptIdFnGcsPath`	La ruta de Cloud Storage a la fuente de UDF de JavaScript para una función que especificará los metadatos `_id` a fin de incluir el documento en la solicitud masiva (opcional). Valor predeterminado: none.
`javaScriptIdFnName`	Opcional: El nombre de función de JavaScript de la UDF para la función que especificará los metadatos `_id` que se incluirán en el documento en la solicitud masiva. Valor predeterminado: none.
`javaScriptTypeFnGcsPath`	La ruta de Cloud Storage a la fuente de UDF de JavaScript para una función que especificará los metadatos `_type` a fin de incluir el documento en la solicitud masiva (opcional). Valor predeterminado: none.
`javaScriptTypeFnName`	Opcional: El nombre de función de JavaScript de la UDF para la función que especificará los metadatos `_type` que se incluirán en el documento en la solicitud masiva. Valor predeterminado: none.
`javaScriptIsDeleteFnGcsPath`	La ruta de acceso de Cloud Storage a la fuente de UDF de JavaScript para la función que determinará si el documento se debe borrar en lugar de insertar o actualizar (opcional). La función debe mostrar el valor de string `"true"` o `"false"`. Valor predeterminado: none.
`javaScriptIsDeleteFnName`	Opcional: El nombre de función de JavaScript de la UDF para la función que determinará si el documento se debe borrar en lugar de insertarse o actualizarse. La función debe mostrar el valor de string `"true"` o `"false"`. Valor predeterminado: none.
`usePartialUpdate`	Opcional: Indica si se deben usar actualizaciones parciales (actualizar en lugar de crear o indexar), que permite documentos parciales con solicitudes de Elasticsearch. Valor predeterminado: `false`.
`bulkInsertMethod`	Opcional: Si se debe usar `INDEX` (índice, permite inserción) o `CREATE` (creación, errores en _id duplicado) con solicitudes masivas de Elasticsearch. Valor predeterminado: `CREATE`.

Funciones definidas por el usuario

Esta plantilla admite funciones definidas por el usuario (UDF) en varios puntos de la canalización, que se describen a continuación. Para obtener más información, consulta Crea funciones definidas por el usuario para plantillas de Dataflow.

Función de índice

Muestra el índice al que pertenece el documento.

Parámetros de la plantilla:

javaScriptIndexFnGcsPath: Es el URI de Cloud Storage del archivo JavaScript.
javaScriptIndexFnName: Es el nombre de la función de JavaScript.

Especificación de la función:

Entrada: el documento de Elasticsearch, serializado como una string JSON.
Resultado: El valor del campo de metadatos _index del documento.

Función de ID de documento

Muestra el ID del documento.

Parámetros de la plantilla:

javaScriptIdFnGcsPath: Es el URI de Cloud Storage del archivo JavaScript.
javaScriptIdFnName: Es el nombre de la función de JavaScript.

Especificación de la función:

Entrada: el documento de Elasticsearch, serializado como una cadena JSON.
Resultado: El valor del campo de metadatos _id del documento.

Función de eliminación de documentos

Especifica si se debe borrar un documento. Para usar esta función, establece el modo de inserción masiva en INDEX y proporciona una función de ID de documento.

Parámetros de la plantilla:

javaScriptIsDeleteFnGcsPath: Es el URI de Cloud Storage del archivo JavaScript.
javaScriptIsDeleteFnName: Es el nombre de la función de JavaScript.

Especificación de la función:

Entrada: el documento de Elasticsearch, serializado como una cadena JSON.
Resultado: Muestra la cadena "true" para borrar el documento o "false" a fin de actualizar el documento.

Función de tipo de asignación

Muestra el tipo de asignación del documento.

Parámetros de la plantilla:

javaScriptTypeFnGcsPath: Es el URI de Cloud Storage del archivo JavaScript.
javaScriptTypeFnName: Es el nombre de la función de JavaScript.

Especificación de la función:

Entrada: el documento de Elasticsearch, serializado como una cadena JSON.
Resultado: El valor del campo de metadatos _type del documento.

Ejecuta la plantilla

Consola

Ve a la página Crear un trabajo a partir de una plantilla de Dataflow.

Ir a Crear un trabajo a partir de una plantilla

En el campo Nombre del trabajo, ingresa un nombre de trabajo único.
Opcional: Para Extremo regional, selecciona un valor del menú desplegable. La región predeterminada es us-central1.
Para obtener una lista de regiones en las que puedes ejecutar un trabajo de Dataflow, consulta Ubicaciones de Dataflow.
En el menú desplegable Plantilla de Dataflow, selecciona the BigQuery to Elasticsearch template.
En los campos de parámetros proporcionados, ingresa los valores de tus parámetros.
Haga clic en Ejecutar trabajo.

gcloud

En tu shell o terminal, ejecuta la plantilla:

gcloud dataflow flex-template run JOB_NAME \
    --project=PROJECT_ID \
    --region=REGION_NAME \
    --template-file-gcs-location=gs://dataflow-templates-REGION_NAME/VERSION/flex/BigQuery_to_Elasticsearch \
    --parameters \
inputTableSpec=INPUT_TABLE_SPEC,\
connectionUrl=CONNECTION_URL,\
apiKey=APIKEY,\
index=INDEX

Reemplaza lo siguiente:

PROJECT_ID: El ID del proyecto de Google Cloud en el que deseas ejecutar el trabajo de Dataflow.
JOB_NAME: Es el nombre del trabajo que elijas
REGION_NAME: La región en la que deseas implementar tu trabajo de Dataflow, por ejemplo, us-central1
VERSION: Es la versión de la plantilla que deseas usar.
Puedes usar los siguientes valores:
- latest para usar la última versión de la plantilla, que está disponible en la carpeta superior non-dated en el bucket gs://dataflow-templates-REGION_NAME/latest/
- el nombre de la versión, como 2023-09-12-00_RC00, para usar una versión específica de la plantilla, que se puede encontrar anidada en la carpeta superior con fecha correspondiente en el bucket gs://dataflow-templates-REGION_NAME/
Precaución: La versión más reciente de las plantillas podría actualizarse con cambios rotundos. Los entornos de producción deben usar plantillas que se conserven en la carpeta superior con la fecha más reciente para evitar que estos cambios rotundos afecten los flujos de trabajo de producción.
INPUT_TABLE_SPEC: Es el nombre de la tabla de BigQuery.
CONNECTION_URL: Es tu URL de Elasticsearch
APIKEY: Es tu clave de API codificada en Base64 para la autenticación
INDEX: Es el índice de Elasticsearch.

API

Para ejecutar la plantilla con la API de REST, envía una solicitud HTTP POST. Para obtener más información de la API y sus permisos de autorización, consulta projects.templates.launch.

POST https://dataflow.googleapis.com/v1b3/projects/PROJECT_ID/locations/LOCATION/flexTemplates:launch
{
   "launch_parameter": {
      "jobName": "JOB_NAME",
      "parameters": {
          "inputTableSpec": "INPUT_TABLE_SPEC",
          "connectionUrl": "CONNECTION_URL",
          "apiKey": "APIKEY",
          "index": "INDEX"
      },
      "containerSpecGcsPath": "gs://dataflow-templates-LOCATION/VERSION/flex/BigQuery_to_Elasticsearch",
   }
}

Reemplaza lo siguiente:

PROJECT_ID: El ID del proyecto de Google Cloud en el que deseas ejecutar el trabajo de Dataflow.
JOB_NAME: Es el nombre del trabajo que elijas
LOCATION: La región en la que deseas implementar tu trabajo de Dataflow, por ejemplo, us-central1
VERSION: Es la versión de la plantilla que deseas usar.
Puedes usar los siguientes valores:
- latest para usar la última versión de la plantilla, que está disponible en la carpeta superior non-dated en el bucket gs://dataflow-templates-REGION_NAME/latest/
- el nombre de la versión, como 2023-09-12-00_RC00, para usar una versión específica de la plantilla, que se puede encontrar anidada en la carpeta superior con fecha correspondiente en el bucket gs://dataflow-templates-REGION_NAME/
Precaución: La versión más reciente de las plantillas podría actualizarse con cambios rotundos. Los entornos de producción deben usar plantillas que se conserven en la carpeta superior con la fecha más reciente para evitar que estos cambios rotundos afecten los flujos de trabajo de producción.
INPUT_TABLE_SPEC: Es el nombre de la tabla de BigQuery.
CONNECTION_URL: Es tu URL de Elasticsearch
APIKEY: Es tu clave de API codificada en Base64 para la autenticación
INDEX: Es el índice de Elasticsearch.

Código fuente de la plantilla

Java

/*
 * Copyright (C) 2021 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
package com.google.cloud.teleport.v2.elasticsearch.templates;

import com.google.cloud.teleport.metadata.Template;
import com.google.cloud.teleport.metadata.TemplateCategory;
import com.google.cloud.teleport.v2.common.UncaughtExceptionLogger;
import com.google.cloud.teleport.v2.elasticsearch.options.BigQueryToElasticsearchOptions;
import com.google.cloud.teleport.v2.elasticsearch.transforms.WriteToElasticsearch;
import com.google.cloud.teleport.v2.transforms.BigQueryConverters.ReadBigQueryTableRows;
import com.google.cloud.teleport.v2.transforms.BigQueryConverters.TableRowToJsonFn;
import com.google.cloud.teleport.v2.transforms.JavascriptTextTransformer.TransformTextViaJavascript;
import org.apache.beam.sdk.Pipeline;
import org.apache.beam.sdk.PipelineResult;
import org.apache.beam.sdk.options.PipelineOptionsFactory;
import org.apache.beam.sdk.transforms.ParDo;

/**
 * The {@link BigQueryToElasticsearch} pipeline exports data from a BigQuery table to Elasticsearch.
 *
 * <p>Check out <a
 * href="https://github.com/GoogleCloudPlatform/DataflowTemplates/blob/main/v2/googlecloud-to-elasticsearch/README_BigQuery_to_Elasticsearch.md">README</a>
 * for instructions on how to use or modify this template.
 */
@Template(
    name = "BigQuery_to_Elasticsearch",
    category = TemplateCategory.BATCH,
    displayName = "BigQuery to Elasticsearch",
    description =
        "The BigQuery to Elasticsearch template is a batch pipeline that ingests data from a BigQuery table into Elasticsearch as documents. "
            + "The template can either read the entire table or read specific records using a supplied query.",
    optionsClass = BigQueryToElasticsearchOptions.class,
    skipOptions = {"javascriptTextTransformReloadIntervalMinutes"},
    flexContainerName = "bigquery-to-elasticsearch",
    documentation =
        "https://cloud.google.com/dataflow/docs/guides/templates/provided/bigquery-to-elasticsearch",
    contactInformation = "https://cloud.google.com/support",
    preview = true,
    requirements = {
      "The source BigQuery table must exist.",
      "A Elasticsearch host on a Google Cloud instance or on Elastic Cloud with Elasticsearch version 7.0 or above and should be accessible from the Dataflow worker machines.",
    })
public class BigQueryToElasticsearch {
  /**
   * Main entry point for pipeline execution.
   *
   * @param args Command line arguments to the pipeline.
   */
  public static void main(String[] args) {
    UncaughtExceptionLogger.register();

    BigQueryToElasticsearchOptions options =
        PipelineOptionsFactory.fromArgs(args)
            .withValidation()
            .as(BigQueryToElasticsearchOptions.class);

    run(options);
  }

  /**
   * Runs the pipeline with the supplied options.
   *
   * @param options The execution parameters to the pipeline.
   * @return The result of the pipeline execution.
   */
  private static PipelineResult run(BigQueryToElasticsearchOptions options) {

    // Create the pipeline.
    Pipeline pipeline = Pipeline.create(options);
    /*
     * Steps: 1) Read records from BigQuery via BigQueryIO.
     *        2) Create json string from Table Row.
     *        3) Write records to Elasticsearch.
     *
     *
     * Step #1: Read from BigQuery. If a query is provided then it is used to get the TableRows.
     */
    pipeline
        .apply(
            "ReadFromBigQuery",
            ReadBigQueryTableRows.newBuilder()
                .setOptions(options.as(BigQueryToElasticsearchOptions.class))
                .build())

        /*
         * Step #2: Convert table rows to JSON documents.
         */
        .apply("TableRowsToJsonDocument", ParDo.of(new TableRowToJsonFn()))

        /*
         * Step #3: Apply UDF functions (if specified)
         */
        .apply(
            TransformTextViaJavascript.newBuilder()
                .setFileSystemPath(options.getJavascriptTextTransformGcsPath())
                .setFunctionName(options.getJavascriptTextTransformFunctionName())
                .build())

        /*
         * Step #4: Write converted records to Elasticsearch
         */
        .apply(
            "WriteToElasticsearch",
            WriteToElasticsearch.newBuilder()
                .setUserAgent("dataflow-bigquery-to-elasticsearch-template/v2")
                .setOptions(options.as(BigQueryToElasticsearchOptions.class))
                .build());

    return pipeline.run();
  }
}

¿Qué sigue?

Obtén información sobre las plantillas de Dataflow.
Consulta la lista de plantillas que proporciona Google.