Dataplex admite la programación de la ejecución de código personalizado, ya sea como una ejecución única, de forma periódica o a pedido. A pedido se encuentra en Vista previa y solo está disponible a través de la API. Puedes programar transformaciones de datos del cliente mediante Spark (Java), PySpark (limitado a la versión 3.2 de Spark) o Spark SQL. Dataplex ejecuta el código con el procesamiento de Spark sin servidores y un programador sin servidores integrado.
Terminología
- Tarea
- Una tarea de Dataplex representa el trabajo que quieres que Dataplex realice en un horario. Encapsula tu código, tus parámetros y el programa.
- Trabajo
Un trabajo representa una sola ejecución de una tarea de Dataplex. Por ejemplo, si una tarea está programada para ejecutarse a diario, Dataplex creará un trabajo todos los días.
Para los trabajos creados a partir del 10 de mayo de 2023, el campo Activador muestra el tipo de activador de ejecución del trabajo.
Los siguientes son los tipos de activadores de ejecución de trabajos:
RUN_REQUEST: indica que el trabajo se ejecutó debido a que se llamó a la API de
RunTask.TASK_CONFIG: Indica que el trabajo se ejecutó debido a la configuración
TriggerSpecde la tarea.
Modos de programación
Dataplex admite los siguientes modos de programación:
- Ejecutar una vez
- Usa este modo para ejecutar tu tarea solo una vez. Puedes ejecutarlo de inmediato o en un momento establecido en el futuro. Si ejecutas la tarea de inmediato, aún puede tardar hasta dos minutos en comenzar la ejecución.
- Ejecutar según una programación
- Usa este modo para ejecutar la tarea con una frecuencia repetida. Las repeticiones admitidas son diarias, semanales, mensuales o personalizadas.
- Ejecutar a pedido
Usa este modo para ejecutar a pedido una tarea creada anteriormente. El modo de ejecución a pedido solo es compatible con la API de
RunTask. Cuando tu trabajo se ejecuta a pedido, Dataplex usa los parámetros existentes para crearlo. Puedes especificar los argumentosExecutionSpecy las etiquetas para ejecutar el trabajo.
Antes de comenzar
Habilita la API de Dataproc
Habilita el Acceso privado a Google para tu red y subred. Habilita el Acceso privado a Google en la red que usas con las tareas de Dataplex. Si no especificas una red o una subred cuando creas la tarea de Dataplex, Dataplex usa la subred predeterminada y debes habilitar el Acceso privado a Google para la subred predeterminada.
Crea una cuenta de servicio. Se requiere una cuenta de servicio para programar cualquier tarea de Dataplex. La cuenta de servicio debe pertenecer al proyecto en el que ejecutas las tareas. La cuenta de servicio debe tener los siguientes permisos:
Acceso a los datos de BigQuery y Cloud Storage que se están procesando.
el permiso de función de trabajador de Dataproc en el proyecto en el que ejecutas la tarea.
Si la tarea necesita leer o actualizar la instancia de Dataproc Metastore adjunta al lake, la cuenta de servicio necesita la función de visualizador o editor de Dataproc Metastore. Este rol se debe otorgar en el proyecto en el que está configurado el lago de Dataplex.
Si la tarea es un trabajo de Spark SQL, debes otorgar la función de desarrollador de Dataplex a la cuenta de servicio. Este rol se debe otorgar en el proyecto en el que está configurado el lake de Dataplex.
Si la tarea es un trabajo de Spark SQL, necesitas permisos de administrador de Cloud Storage en el bucket en el que se escriben los resultados.
Para programar y ejecutar tareas de Spark SQL y de Spark personalizadas, debes tener los roles de IAM de IAM del lector de metadatos de Dataplex (
roles/dataplex.metadataReader), Visualizador de Dataplex (roles/dataplex.viewer) y Usuario de metadatos de Dataproc Metastore (roles/metastore.metadataUser) en tu cuenta de servicio.
Otorga al usuario que envía el trabajo la función de usuario de cuenta de servicio (
roles/iam.serviceAccountUser) en la cuenta de servicio. Para obtener instrucciones, consulta Administra el acceso a las cuentas de servicio.Otorga permisos a la cuenta de servicio del lake de Dataplex para usar la cuenta de servicio. Puedes encontrar la cuenta de servicio del lake de Dataplex en la página Detalles del lago de la consola de Google Cloud.
Si el proyecto que contiene el lake de Dataplex es diferente del proyecto en el que se ejecutará la tarea, otorga a la cuenta de servicio del lake de Dataplex la función de editor de Dataproc en el proyecto en el que ejecutas la tarea.
Coloca los artefactos de código requeridos (archivos de secuencia de comandos de SQL, Python o JAR) o archivos archivados (
.jar,.tar,.tar.gz,.tgz,.zip) en una ruta de acceso de Cloud Storage.Asegúrate de que la cuenta de servicio tenga el permiso
storage.objects.getrequerido para el bucket de Cloud Storage que almacena estos artefactos de código.
Programa una tarea de Spark (Java o Python)
Console
En la consola de Google Cloud, ve a la página de Dataplex:
Navega a la vista Process.
Haz clic en Crear tarea.
En Crear tarea de Spark personalizada, haz clic en Crear tarea.
Elige un lake de Dataplex.
Proporciona un nombre de tarea.
Crea un ID para tu tarea.
En la sección Configuración de la tarea, en Tipo, selecciona Spark o PySpark.
Ingresa los argumentos relevantes.
En el campo Cuenta de servicio, ingresa una cuenta de servicio de usuario con la que se pueda ejecutar tu tarea de Spark personalizada.
Haz clic en Continuar.
Para establecer programa, selecciona Ejecutar una vez o Repetir (opcional). Completa los campos obligatorios.
Haz clic en Continuar.
Opcional: Personaliza los recursos y Agrega parámetros de configuración adicionales.
Haz clic en Crear.
gcloud
Puedes programar una tarea de Spark (Java / Python) con el comando de gcloud CLI. En la siguiente tabla, se enumeran los parámetros obligatorios y opcionales que puedes usar:
| Parámetro | Descripción |
|---|---|
--lake |
El ID del lake del recurso de lake del servicio de Dataplex. |
--location |
La ubicación del servicio de Dataplex. |
--spark-main-class |
Corresponde a la clase principal del conductor. El archivo jar que contiene la clase debe estar en el CLASSPATH predeterminado.
|
--spark-main-jar-file-uri |
El URI de Cloud Storage del archivo jar que contiene la clase principal.
|
--spark-archive-uris |
Opcional: Los URI de Cloud Storage de los archivos que se extraerán en el directorio de trabajo de cada ejecutor. Tipos de archivo admitidos: .jar, .tar, .tar.gz, .tgz y .zip.
|
--spark-file-uris |
Opcional: Los URI de Cloud Storage de los archivos que se colocarán en el directorio de trabajo de cada ejecutor. |
--batch-executors-count |
Opcional: La cantidad total de ejecutores de trabajos. El valor predeterminado es 2. |
--batch-max-executors-count |
Opcional: La cantidad máxima de ejecutores configurables. El valor predeterminado es 1,000. Si batch-max-executors-count es mayor que
batch-executors-count, Dataplex habilita el
ajuste de escala automático.
|
--container-image-java-jars |
Una lista de JARS de Java para agregar a la ruta de clase (opcional). Las entradas válidas incluyen los URI de Cloud Storage para los objetos binarios de Jar. Por ejemplo, gs://bucket-name/my/path/to/file.jar.
|
--container-image-properties |
Opcional: Claves de propiedad, especificadas en un formato
prefix:property.Por ejemplo, core:hadoop.tmp.dir.Para obtener más información, consulta Propiedades del clúster. |
--vpc-network-tags |
Una lista de etiquetas de red para aplicar al trabajo (opcional). |
--vpc-network-name |
La red de nube privada virtual en la que se ejecuta el trabajo (opcional). De
forma predeterminada, Dataplex usa la red de VPC
llamada Default dentro del proyecto. Debes usar solo una de las siguientes opciones: --vpc-network-name o --vpc-sub-network-name.
|
--vpc-sub-network-name |
La subred de VPC en la que se ejecuta el trabajo (opcional).
Debes usar solo una de las opciones --vpc-sub-network-name o --vpc-network-name.
|
--trigger-type |
Tipo de activador de la tarea especificada por el usuario. Los valores deben ser uno de los siguientes:ON_DEMAND: La tarea se ejecuta una vez poco después de que se crea.RECURRING: La tarea se ejecuta periódicamente según un programa.
|
--trigger-start-time |
Opcional: Es la hora de la primera ejecución de la tarea. El formato es `{year}-{month}-{day}T{hour}:{min}:{sec}Z`, en el que la zona horaria es UTC. Por ejemplo, “2017-01-15T01:30:00Z” codifica la hora 01:30 UTC del 15 de enero de 2017. Si no se especifica este valor, la tarea se ejecutará después del envío si el tipo de activador es ON_DEMAND o en el programa especificado si el tipo de activador es RECURRING.
|
--trigger-disabled |
Opcional: Impide que se ejecute la tarea. Este parámetro no cancela las tareas que ya se están ejecutando, sino que inhabilita temporalmente las tareas RECURRING.
|
--trigger-max-retires |
Opcional: La cantidad de reintentos antes de anular. Establece el valor en cero para que no se intente nunca reintentar una tarea con errores. |
--trigger-schedule |
Programación cron para ejecutar tareas de manera periódica. |
--description |
Opcional: descripción de la tarea. |
--display-name |
Opcional: Nombre visible de la tarea. |
--labels |
Opcional: Lista de pares de etiquetas KEY=VALUE para agregar. |
--execution-args |
Los argumentos que se pasarán a la tarea (opcional). Los argumentos pueden ser una combinación de pares clave-valor. Puedes pasar una lista separada por comas de pares clave-valor como argumentos de ejecución. Para pasar argumentos posicionales, configura la clave en TASK_ARGS y el valor en una string separada por comas de todos los argumentos posicionales. Para usar un delimitador que no sea una coma, consulta escapado.Si se pasan key-value y los argumentos posicionales juntos, se pasará TASK_ARGS como último argumento.
|
--execution-service-account |
La cuenta de servicio que se usará para ejecutar una tarea. |
--max-job-execution-lifetime |
Opcional: La duración máxima antes de que venza la ejecución del trabajo. |
--container-image |
Opcional: Imagen de contenedor personalizada para el entorno de ejecución del trabajo. Si no se especifica, se usará una imagen de contenedor predeterminada. |
--kms-key |
Opcional: La clave de Cloud KMS que se usará para la encriptación, en el formato:projects/{project_number}/locations/{location_id}/keyRings/{key-ring-name}/cryptoKeys/{key-name}
|
Ejemplo de Java:
glcoud dataplex tasks create --project=<project-name> --location=<location> --lake=<lake-id> --trigger-type=ON_DEMAND –spark-main-jar-file-uri=<gcs location to java file> --execution-service-account=<service-account-email> --trigger-start-time=<timestamp after which job starts ex. 2099-01-01T00:00:00Z> --labels=key1=value1,key2=value3,key3=value3 --execution-args=arg1=value1,arg2=value3,arg3=value3 <task-id>
Ejemplo de PySpark:
gcloud dataplex tasks create --project=<project-name> --location=<location> --lake=<lake-id> --trigger-type=RECURRING --trigger-schedule=<Cron schedule https://en.wikipedia.org/wiki/Cron> --spark-python-script-file=<gcs location to python script> --execution-service-account=<service-account-email> --execution-args=^::^arg1=value1::arg2=value2::TASK_ARGS="pos-arg1, pos-arg2" <task-id>
REST
Para crear una tarea, usa el Explorador de API.
Programa una tarea de Spark SQL
gcloud
Para programar una tarea de Spark SQL, ejecuta el mismo comando de gcloud CLI que se encuentra en Programa una tarea de Spark (Java o Python), con los siguientes parámetros adicionales:
| Parámetro | Descripción |
|---|---|
--spark-sql-script |
El texto de la consulta en SQL. Se requiere spark-sql-script o spark-sql-script-file. |
--spark-sql-script-file |
Es una referencia a un archivo de consulta. Este valor puede ser el URI de Cloud Storage del archivo de consulta o la ruta de acceso al contenido de la secuencia de comandos de SQL.
Se requiere spark-sql-script o spark-sql-script-file. |
--execution-args |
Para las tareas de Spark SQL, los siguientes argumentos son obligatorios y se deben pasar como argumentos posicionales:--output_location, <GCS uri of the output directory>--output_format, <output file format>.Los formatos admitidos son archivos CSV, JSON, parquet y orc. |
gcloud dataplex tasks create --project=<project-name> --location=<location> --lake=<lake-id> --execution-service-account=<service-account-email> --trigger-type=ON_DEMAND --spark-sql-script=<sql-script> --execution-args=^::^TASK_ARGS="--output_location, <gcs folder location>, --output_format, json" <sql-task-id>
REST
Para crear una tarea, usa el Explorador de API.
Supervisa tu tarea
Console
En la consola de Google Cloud, ve a la página de Dataplex:
Navega a la vista Process.
En la pestaña Tareas, hay una lista de tareas, filtradas por los tipos de plantillas de tareas.
En la columna Nombre, haz clic en la tarea que deseas ver.
Haz clic en el ID del trabajo de la tarea que deseas ver.
La página de Dataproc se abrirá en la consola de Google Cloud, que te permite ver los detalles de supervisión y salida.
gcloud
En la siguiente tabla, se enumeran los comandos de gcloud CLI para supervisar tus tareas.
| Acción | Comando de gcloud CLI |
|---|---|
| Cómo hacer una lista de tareas | gcloud dataplex tasks list --project=<project-name> --location=<location> --lake=<lake-id> |
| Visualiza los detalles de la tarea | gcloud dataplex tasks describe --project=<project-name> --location=<location> --lake=<lake-id> <task-id> |
| Muestra una lista de los trabajos de una tarea | gcloud dataplex tasks jobs list --project=<project-name> --location=<location> --lake=<lake-id> --task=<task-id> |
| Visualiza los detalles del trabajo | gcloud dataplex tasks jobs describe --project=<project-name> --location=<location> --lake=<lake-id> --task=<task-id> <job-id> |
Dataplex ejecuta trabajos en Dataproc sin servidores (lotes). Para ver los registros de ejecución de un trabajo de Dataplex, sigue estos pasos:
Obtén el ID de trabajo de Dataproc Serverless (Batches). Ejecuta el siguiente comando:
gcloud dataplex tasks jobs describe --project=<project-name> --location=<location> --lake=<lake-id> --task=<task-id> <job-id>Visualizar los registros Ejecuta el siguiente comando con el ID de trabajo que obtuviste cuando ejecutaste el comando anterior:
gcloud beta dataproc batches wait --project=<project-name> --region=<location> <job-id>
REST
Para aplicar get o list una tarea o un trabajo, usa el Explorador de API.
Administrar el cronograma
En la consola de Google Cloud, dentro de Dataplex, puedes editar la programación de una tarea, borrar una tarea o cancelar un trabajo en curso. En la siguiente tabla, se enumeran los comandos de gcloud CLI para estas acciones.
| Acción | Comando de gcloud CLI |
|---|---|
| Editar programación de tareas | gcloud dataplex tasks update --project=<project-name> --location=<location> --lake=<lake-id> --trigger-schedule=<updated-schedule> <task-id> |
| Borrar una tarea | gcloud dataplex tasks delete --project=<project-name> --location=<location> --lake=<lake-id> <task-id> |
| Cancelar un trabajo | gcloud dataplex tasks jobs cancel --project=<project-name> --location=<location> --lake=<lake-id> --task=<task-id> <job-id> |
¿Qué sigue?
- Consulta Plantillas de Dataproc.
- Prueba una plantilla ya compilada para mover datos de forma incremental desde los recursos de Cloud Storage de Dataplex a BigQuery.
- Consulta Configura alertas y notificaciones para tareas de Dataplex.