Crear canalizaciones
Puedes crear canalizaciones en BigQuery, que te permiten organizar y automatizar flujos de trabajo, como programar consultas en SQL, notebooks y tareas de preparación de datos para que se ejecuten en secuencia.
Antes de comenzar
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
Roles required to select or create a project
- Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
-
Create a project: To create a project, you need the Project Creator role
(
roles/resourcemanager.projectCreator), which contains theresourcemanager.projects.createpermission. Learn how to grant roles.
-
Verify that billing is enabled for your Google Cloud project.
Enable the BigQuery, Dataform, and Vertex AI APIs, if any are not already enabled.
Roles required to enable APIs
To enable APIs, you need the
serviceusage.services.enablepermission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). Learn how to grant roles.
Requisitos de los Controles del servicio de VPC
Si usas los Controles del servicio de VPC para proteger tus canalizaciones, debes tener en cuenta que Dataform potencia las ejecuciones de canalizaciones. Cuando configures los Controles del servicio de VPC para las ejecuciones programadas, asegúrate de que se cumplan los siguientes requisitos:
- Debes configurar el
servicio de políticas de la organización de
dataform.restrictGitRemotes. - Dataform y BigQuery deben estar restringidos por el mismo perímetro de servicio de los Controles del servicio de VPC.
- Para permitir que los usuarios se autentiquen con las credenciales de usuario de su Cuenta de Google cuando programen o activen ejecuciones de forma manual, debes agregar sus identidades de usuario a tus reglas de entrada. Para obtener más información, consulta Actualiza las políticas de entrada y salida de un perímetro de servicio y Referencia de las reglas de entrada.
Para conocer los pasos de configuración detallados y las consideraciones de seguridad, consulta Configura los Controles del servicio de VPC para Dataform.
Roles requeridos para las canalizaciones
Para obtener los permisos que necesitas para crear canalizaciones, pídele a tu administrador que te otorgue los siguientes roles de IAM:
-
Para crear canalizaciones:
Creador de código (
roles/dataform.codeCreator) en el proyecto -
Para editar y ejecutar canalizaciones:
Editor de Dataform (
roles/dataform.editor) en el proyecto -
Para crear canalizaciones en las carpetas de los usuarios, haz lo siguiente:
- Creador de código (
roles/dataform.codeCreator) en el proyecto - Propietario del código (
roles/dataform.codeOwner) en la carpeta - Editor de código (
roles/dataform.codeEditor) en la carpeta
- Creador de código (
-
Para crear canalizaciones en carpetas de equipo, sigue estos pasos:
- Colaborador de carpetas de equipo (
roles/dataform.teamFolderContributor) en la carpeta de equipo - Propietario de la carpeta de equipo (
roles/dataform.teamFolderOwner) en la carpeta de equipo
- Colaborador de carpetas de equipo (
-
Para conectar un repositorio de Git para carpetas de Git:
Usuario de OAuth de Developer Connect (
roles/developerconnect.oauthUser) en el proyecto
Para obtener más información sobre cómo otorgar roles, consulta Administra el acceso a proyectos, carpetas y organizaciones.
También puedes obtener los permisos necesarios a través de roles personalizados o cualquier otro rol predefinido.
Para obtener más información sobre la IAM de Dataform, consulta Controla el acceso con la IAM.
Para obtener más información sobre los roles de las carpetas, consulta Crea y administra carpetas.
Para obtener más información sobre los roles de los repositorios de Git, consulta Administra código con repositorios de Git de BigQuery Studio.
Roles obligatorios para las opciones de notebooks
Para obtener los permisos que
necesitas para seleccionar una plantilla de entorno de ejecución en las opciones del notebook,
pídele a tu administrador que te otorgue el
rol de IAM de usuario del entorno de ejecución de notebooks (roles/aiplatform.notebookRuntimeUser) en el proyecto.
Para obtener más información sobre cómo otorgar roles, consulta Administra el acceso a proyectos, carpetas y organizaciones.
También puedes obtener los permisos necesarios a través de roles personalizados o cualquier otro rol predefinido.
Si no tienes este rol, puedes seleccionar la especificación del entorno de ejecución del notebook predeterminado.
Consideraciones de seguridad para las canalizaciones
Debido a que los recursos de código en BigQuery se basan en Dataform, debes tener en cuenta las siguientes implicaciones de seguridad para los usuarios con acceso a estos recursos:
- La visibilidad de los recursos de código se rige por los permisos de Dataform a nivel del proyecto. Los usuarios con el permiso
dataform.repositories.list, que se incluye en los roles estándar de BigQuery, como Usuario de trabajos de BigQuery, Usuario de BigQuery Studio y Usuario de BigQuery, pueden ver todos los recursos de código en el panel Explorador del proyecto de Google Cloud , independientemente de si crearon estos recursos o si se compartieron con ellos. Para restringir la visibilidad, puedes crear roles personalizados que excluyan el permisodataform.repositories.list. - Los usuarios que pueden editar estos recursos pueden acceder a cualquier secreto compartido con el agente de servicio de Dataform. Para proteger tus credenciales, restringe el acceso de creación y edición a los usuarios de confianza, y limita los secretos a los que puede acceder el agente de servicio de Dataform. Para obtener más información, consulta Acceso a secretos durante la instalación de paquetes.
Si deseas obtener más información, consulta Consideraciones de seguridad para los permisos de Dataform.
Configura la región predeterminada para los elementos de código
Todos los elementos de código nuevos de tu proyecto de Google Cloud usan una región predeterminada. Después de crear el recurso, no puedes cambiar su región.
Para establecer la región predeterminada de los recursos de código nuevos, haz lo siguiente:
Ve a la página de BigQuery.
En el panel izquierdo, haz clic en Archivos para abrir el navegador de archivos:
Junto al nombre del proyecto, haz clic en Ver acciones del panel de archivos > Cambiar región de código.
Selecciona la región de código que quieres usar como predeterminada.
Haz clic en Guardar.
Para obtener una lista de las regiones admitidas, consulta Ubicaciones de BigQuery Studio.
Crea una canalización
Puedes crear y almacenar canalizaciones de las siguientes maneras:
- En carpetas: Organiza las canalizaciones en carpetas personales o de equipo en el panel Archivos de BigQuery Studio.
- En las carpetas de Git de BigQuery Studio (versión preliminar): aloja, control de versión y administra varias canalizaciones independientes o de nivel raíz dentro de una carpeta con un repositorio de Git conectado con Developer Connect.
- Desde la barra de pestañas del editor: Crea una canalización desde el menú + en el editor de consultas.
- Desde la página Canalizaciones y conexiones (versión preliminar): Crea una canalización con un flujo de trabajo optimizado y específico de BigQuery.
Crea una canalización en una carpeta
Puedes crear y organizar canalizaciones directamente en tus carpetas de usuario personales o en las carpetas de equipo compartidas en BigQuery Studio. Para obtener más información sobre las carpetas, consulta Organiza los recursos de código con carpetas.
Para crear una canalización en una carpeta, sigue estos pasos:
En la consola de Google Cloud , ve a la página BigQuery.
En el panel izquierdo, haz clic en Archivos para abrir el navegador de archivos.
Si no ves el panel izquierdo, haz clic en Expandir panel izquierdo para abrirlo.
Realiza una de las siguientes acciones para crear una canalización:
- Selecciona la carpeta de usuario o de equipo en la que deseas colocar la canalización, haz clic en el botón + (Crear) de la barra de herramientas y selecciona Canalización.
- En el árbol de archivos, haz clic en Ver acciones junto al nombre de una carpeta y selecciona Crear > Canalización.
- Abre una carpeta para ver su contenido en el panel principal y haz clic en Crear canalización.
En el cuadro de diálogo de creación, ingresa un nombre para la canalización.
Haz clic en Crear. Aparecerá una nueva carpeta de canalización en el árbol de archivos con el ícono de canalización.
Haz clic en la carpeta de la canalización para abrir el Visualizador de canalizaciones y, luego, configura los parámetros de configuración de la canalización.
Crea una canalización en un repositorio de Git
Puedes crear y administrar canalizaciones directamente en las carpetas integradas en Git en BigQuery Studio. Una carpeta de Git representa un repositorio remoto de GitHub o GitLab conectado a BigQuery Studio con Developer Connect. Puedes alojar y organizar varias canalizaciones independientes en un solo repositorio de Git. Las canalizaciones de repositorios de Git admiten implementaciones de Dataform para la programación, las configuraciones de versiones y la organización de varios entornos.
Para crear una canalización en una carpeta de Git, sigue estos pasos:
En la consola de Google Cloud , ve a la página BigQuery.
Si aún no conectaste tu repositorio de Git, crea y conecta un repositorio de Git de BigQuery Studio.
En el panel izquierdo, haz clic en Archivos para abrir el navegador de archivos.
En el árbol de archivos, busca la carpeta del repositorio de Git conectado o un directorio anidado dentro de ella.
Haz clic en Ver acciones junto al nombre de la carpeta y selecciona Crear > Canalización.
En el cuadro de diálogo, ingresa el nombre de la canalización y haz clic en Guardar.
Se creará un directorio de canalización nuevo, inicializado con los archivos predeterminados:
workflow_settings.yaml: Es la configuración de la canalización.definitions/actions.yaml: Definiciones de tareas vacías.
Haz clic en el directorio de la canalización en el navegador de archivos para abrir el Visualizador de canalizaciones.
Cómo crear una canalización desde la barra de pestañas del editor
Para crear una canalización desde la barra de pestañas del editor, sigue estos pasos:
En la consola de Google Cloud , ve a la página BigQuery.
En la barra de pestañas del panel del editor, haz clic en la flecha junto al signo + y, luego, haz clic en Canalización.
Opcional: Para cambiar el nombre de la canalización, haz clic en el nombre de la canalización y, luego, escribe un nombre nuevo.
Establece la configuración de la canalización.
Crea una canalización desde la página Canalizaciones y conexiones
Puedes usar la página Canalizaciones y conexiones de BigQuery en la consola de Google Cloud para crear una canalización de Dataform que use un flujo de trabajo optimizado y específico de BigQuery. Esta función está en vista previa.
Para obtener instrucciones sobre cómo crear una canalización desde la página Canalizaciones y conexiones de BigQuery, consulta Crea un recurso de integración de datos.
Establece la configuración de la canalización
Para establecer la configuración de tu canalización, ábrela en el Visualizador de canalizaciones, haz clic en la pestaña Configuración y establece los siguientes parámetros:
En la sección Autenticación, elige autorizar la canalización con las credenciales de usuario de tu Cuenta de Google o una cuenta de servicio.
Para usar las credenciales de usuario de tu Cuenta de Google, selecciona Ejecutar con mis credenciales de usuario.
Opcional: En la sección Opciones de acceso extendido, selecciona los servicios adicionales que requiere tu canalización:
- Knowledge Catalog: Permite actualizaciones de metadatos de Google Cloud Knowledge Catalog.
- Google Drive: Permite el acceso de solo lectura a los archivos de Google Drive.
Bigtable: Permite el acceso de solo lectura a los datos de Google Bigtable.
Para usar una cuenta de servicio, selecciona Ejecutar con la cuenta de servicio seleccionada y, luego, selecciona una cuenta de servicio. Si necesitas crear una cuenta de servicio, haz clic en Nueva cuenta de servicio.
En la sección Ubicación de procesamiento, selecciona una ubicación de procesamiento para la canalización.
Para habilitar la selección automática de una ubicación, elige Selección automática de ubicación. Esta opción selecciona una ubicación en función de los conjuntos de datos a los que se hace referencia en la solicitud. El proceso de selección es el siguiente:
- Si tu consulta hace referencia a conjuntos de datos de la misma ubicación, BigQuery usa esa ubicación.
- Si tu consulta hace referencia a conjuntos de datos de dos o más ubicaciones diferentes, se produce un error. Para obtener detalles sobre esta limitación, consulta Replicación de conjuntos de datos entre regiones.
- Si tu consulta no hace referencia a ningún conjunto de datos, BigQuery
establece de forma predeterminada la multirregión
US.
Para elegir una región específica, selecciona Región y, luego, elige una región en el menú Región. Como alternativa, puedes usar la variable del sistema
@@locationen tu consulta. Para obtener más información, consulta Especifica ubicaciones.Para elegir una multirregión, selecciona Multirregión y, luego, elige una multirregión en el menú Multirregión.
No es necesario que la ubicación de procesamiento de la canalización coincida con la ubicación de almacenamiento predeterminada para los recursos de código.
Opciones de SQLX
Para establecer la configuración de SQLX de tu canalización, haz lo siguiente en la sección Opciones de SQLX:
En el campo Proyecto predeterminado, ingresa el nombre de un proyecto de Google Cloud existente. Este valor se usa para
defaultProjecten el archivoworkflow_settings.yamly paradefaultDatabaseen el archivodataform.json. Las tareas de canalización usan el proyecto predeterminado durante su ejecución.Opcional: En el campo Conjunto de datos predeterminado, busca y selecciona un conjunto de datos existente. La lista de conjuntos de datos disponibles se filtra según el proyecto y la ubicación de procesamiento seleccionados. Este valor se usa para
defaultDataseten el archivoworkflow_settings.yaml. Las tareas de la canalización usan el conjunto de datos predeterminado durante su ejecución.
Opciones de notebook
Para agregar un notebook a tu canalización, haz lo siguiente en la sección Opciones de notebook:
En el campo Plantilla de entorno de ejecución, acepta el entorno de ejecución predeterminado del notebook o busca y selecciona un entorno de ejecución existente.
- Para ver las especificaciones del entorno de ejecución predeterminado, haz clic en la flecha adyacente.
- Para crear un entorno de ejecución nuevo, consulta Crea una plantilla de entorno de ejecución.
En el campo Bucket de Cloud Storage, haz clic en Explorar y selecciona o crea un bucket de Cloud Storage para almacenar el resultado de los notebooks en tu canalización.
Sigue los pasos que se indican en Agrega una principal a una política a nivel de bucket para agregar tu cuenta de servicio personalizada de Dataform como principal al bucket de Cloud Storage que planeas usar para almacenar el resultado de las ejecuciones programadas de la canalización y otorgar el rol de administrador de almacenamiento (
roles/storage.admin) a esta principal.A la cuenta de servicio personalizada de Dataform seleccionada se le debe otorgar el rol de IAM de administrador de Storage en el bucket seleccionado.
Agrega una tarea de canalización
Puedes agregar varias tareas a una canalización que ejecute recursos de código en una secuencia específica.
Entre los recursos de código admitidos dentro de las canalizaciones, se incluyen los siguientes:
- Consultas en SQL
- Notebooks
- Preparaciones de datos
- Tablas y vistas (tareas de SQLX)
Convenciones de nombres de tareas
Cuando asignes un nombre a una tarea de canalización, sigue estas convenciones de nomenclatura:
- Los nombres de las tareas solo pueden contener letras (a-z, A-Z), números (0-9), guiones bajos
(
_) y guiones (-). - Los nombres de las tareas deben comenzar con una letra, un número o un guion bajo.
- No se permiten puntos (
.) en los nombres de las tareas. Cuando asignes o cambies el nombre de una tarea, no incluyas extensiones de archivo, como.sqlo.py. Si el nombre de una tarea contiene un punto, se desactiva el botón Run. - Los nombres de las tareas pueden contener caracteres con un total de hasta 1,024 bytes UTF-8.
- Los nombres de las tareas deben ser únicos dentro del contenedor de la canalización.
- Los nombres de las tareas distinguen mayúsculas de minúsculas.
Agregar una tarea
Para agregar una tarea a una canalización, sigue estos pasos:
En la consola de Google Cloud , ve a la página BigQuery.
En el panel de la izquierda, haz clic en Explorar:

Si no ves el panel izquierdo, haz clic en Expandir panel izquierdo para abrirlo.
En el panel Explorador, expande tu proyecto, haz clic en Canalizaciones y, luego, selecciona una canalización.
Para agregar un recurso de código, selecciona una de las siguientes opciones:
Consulta en SQL
Puedes crear una consulta nueva o importar una existente.
Realiza una de las siguientes acciones:
Haz clic en Agregar tarea y, luego, selecciona Consulta. Puedes crear una consulta nueva o importar una existente.
Cuando trabajes con canalizaciones en carpetas o carpetas de Git, haz clic con el botón derecho en la carpeta de la canalización en el panel Archivos y selecciona Crear consulta.
Cuando trabajes con canalizaciones en carpetas o carpetas de Git, haz clic en el botón Agregar tarea en el Visualizador de canalizaciones.
Opcional: En el panel Detalles de la tarea de consulta, en el menú Ejecutar después de, selecciona una tarea que preceda a tu consulta.
Crea una consulta nueva
Haz clic en el menú de flecha junto a Editar consulta y selecciona En contexto o En una pestaña nueva.
Busca una consulta existente.
Selecciona un nombre de consulta y, luego, presiona Intro.
Haz clic en Guardar.
Opcional: Para cambiar el nombre de la consulta, haz clic en el nombre de la consulta en el panel de canalización, haz clic en Editar consulta, haz clic en el nombre de la consulta existente en la parte superior de la pantalla y, luego, escribe un nombre nuevo.
Importa una consulta existente
Haz clic en el menú de flecha junto a Editar consulta y, luego, en Importar una copia.
Busca una consulta existente para importar o selecciona una consulta existente en el panel de búsqueda. Cuando importas una consulta, el original no se modifica, ya que el archivo de origen de la consulta se copia en la canalización.
Haz clic en Editar para abrir la consulta importada.
Haz clic en Guardar.
Notebook
Puedes crear un cuaderno nuevo o importar uno existente. Para cambiar la configuración de las plantillas de entorno de ejecución de notebooks, consulta Opciones de notebooks.
Realiza una de las siguientes acciones:
Haz clic en Agregar tarea y, luego, selecciona Notebook.
Cuando trabajes con canalizaciones en carpetas o carpetas de Git, haz clic con el botón derecho en la carpeta de la canalización en el panel Archivos y selecciona Crear notebook.
Cuando trabajes con canalizaciones en carpetas o carpetas de Git, haz clic en el botón Agregar tarea en el Visualizador de canalizaciones.
- Opcional: En el panel Detalles de la tarea del notebook, en el menú Ejecutar después de, selecciona una tarea que preceda a tu notebook.
Crea un cuaderno nuevo
Haz clic en el menú de flecha junto a Editar notebook y selecciona En contexto o En una pestaña nueva.
Busca un cuaderno existente.
Selecciona un nombre para el notebook y, luego, presiona Intro.
Haz clic en Guardar.
Opcional: Para cambiar el nombre del notebook, haz clic en el nombre del notebook en el panel de la canalización, haz clic en Editar notebook, haz clic en el nombre del notebook existente en la parte superior de la pantalla y, luego, escribe un nombre nuevo.
Importa un notebook existente
Haz clic en el menú de flecha junto a Editar notebook y, luego, en Importar una copia.
Busca un notebook existente para importarlo o selecciona un notebook existente en el panel de búsqueda. Cuando importas un notebook, el original permanece sin cambios porque el archivo fuente del notebook se copia en la canalización.
Para abrir el notebook importado, haz clic en Editar.
Haz clic en Guardar.
Preparación de datos
Puedes crear una preparación de datos nueva o importar una existente.
Realiza una de las siguientes acciones:
Haz clic en Agregar tarea y, luego, selecciona Preparación de datos.
Cuando trabajes con canalizaciones en carpetas o carpetas de Git, haz clic con el botón derecho en la carpeta de la canalización en el panel Archivos y selecciona Crear preparación de datos.
Cuando trabajes con canalizaciones en carpetas o carpetas de Git, haz clic en el botón Agregar tarea en el Visualizador de canalizaciones.
Opcional: En el panel Detalles de la tarea de preparación de datos, en el menú Ejecutar después de, selecciona una tarea que preceda a la preparación de datos.
Crea una nueva preparación de datos
Haz clic en el menú de flecha junto a Editar preparación de datos y selecciona En contexto o En una pestaña nueva.
Busca una preparación de datos existente.
Selecciona un nombre para la preparación de datos y presiona Intro.
Haz clic en Guardar.
Opcional: Para cambiar el nombre de la preparación de datos, haz clic en el nombre de la preparación de datos en el panel de canalización, haz clic en Editar preparación de datos, haz clic en el nombre en la parte superior de la pantalla y, luego, ingresa un nombre nuevo.
Importa una preparación de datos existente
Haz clic en el menú desplegable de flecha junto a Editar preparación de datos y, luego, en Importar una copia.
Busca una preparación de datos existente para importar o selecciona una preparación de datos existente en el panel de búsqueda. Cuando importas una preparación de datos, el original no se modifica porque el archivo fuente de la preparación de datos se copia en la canalización.
Para abrir la preparación de datos importados, haz clic en Editar.
Haz clic en Guardar.
Tabla
- Realiza una de las siguientes acciones:
Haz clic en Agregar tarea y, luego, selecciona Tabla.
Cuando trabajes con canalizaciones en carpetas o carpetas de Git, haz clic con el botón derecho en la carpeta de la canalización en el panel Archivos y selecciona Crear tabla.
Cuando trabajes con canalizaciones en carpetas o carpetas de Git, haz clic en el botón Agregar tarea en el Visualizador de canalizaciones.
En el panel Crear nueva, selecciona Tabla o Tabla incremental.
Verifica el proyecto predeterminado de la tabla o selecciona uno nuevo.
Verifica el conjunto de datos predeterminado para la tabla o selecciona uno nuevo.
Ingresa un nombre para la tabla.
En el panel de detalles de la tarea de la tabla, haz clic en Abrir para abrir la tarea.
Configura la tarea con los parámetros de configuración en Detalles > Configuración o en el bloque
configdel editor de código de la tabla.
Para realizar cambios en los metadatos, usa la pestaña Configuración. Esta pestaña te permite editar un valor específico en el bloque config desde el editor de código, como una cadena o un array, que tiene el formato de un objeto de JavaScript. Esta pestaña te ayuda a evitar errores de sintaxis y verificar que
tu configuración sea correcta.
Opcional: En el menú Ejecutar después de, selecciona una tarea que preceda a tu tabla.
También puedes definir los metadatos de la tarea de canalización en el
bloque config del editor. Para obtener más información, consulta
Crea tablas.
El editor valida tu código y muestra el estado de la validación.
- Usa la clave
metadatapara especificar información de Knowledge Catalog. Este proceso de enriquecimiento admite las siguientes construcciones de metadatos:
- Descripción general: documentación y texto de resumen de la entrada.
- Aspectos genéricos: detalles semánticos, como la información del sistema y del tipo de tabla.
En el siguiente ejemplo de configuración, se muestra cómo agregar una descripción general y aspectos de metadatos genéricos a una configuración de tabla para Knowledge Catalog:
```javascript
config {
type: "table",
metadata: {
overview: "This table provides standardized trip data.",
extraProperties: {
generic: {
system: "BigQuery",
type: "fact table"
}
}
}
}
```
En Detalles > Consultas compiladas, consulta el SQL compilado desde el código SQLX.
Haz clic en Ejecutar para ejecutar el SQL en tu canalización.
En Resultados de la consulta, inspecciona la vista previa de los datos.
Ver
Realiza una de las siguientes acciones:
Haz clic en Agregar tarea y, luego, selecciona Ver.
Cuando trabajes con canalizaciones en carpetas o carpetas de Git, haz clic con el botón derecho en la carpeta de la canalización en el panel Archivos y selecciona Crear vista.
Cuando trabajes con canalizaciones en carpetas o carpetas de Git, haz clic en el botón Agregar tarea en el Visualizador de canalizaciones.
En el panel Crear nueva, selecciona Vista o Vista materializada.
Verifica el proyecto predeterminado para la vista o selecciona uno nuevo.
Verifica el conjunto de datos predeterminado para la vista o selecciona uno nuevo.
Ingresa un nombre para la vista.
En el panel de detalles de la tarea, haz clic en Abrir para abrir la tarea.
Configura la tarea con los parámetros de configuración en Detalles > Configuración o en el bloque
configdel editor de código de la vista.
Para realizar cambios en los metadatos, usa la pestaña Configuración. Esta pestaña te permite editar un valor específico en el bloque config desde el editor de código, como una cadena o un array, que tiene el formato de un objeto de JavaScript. Esta pestaña te ayuda a evitar errores de sintaxis y verificar que
tu configuración sea correcta.
Opcional: En el menú Ejecutar después de, selecciona una tarea que preceda a tu vista.
También puedes definir los metadatos de la tarea de canalización en el
bloque config del editor. Para obtener más información, consulta
Crea una vista con Dataform Core.
El editor valida tu código y muestra el estado de la validación.
- Usa la clave
metadatapara especificar información de Knowledge Catalog. Este proceso de enriquecimiento admite las siguientes construcciones de metadatos:
- Descripción general: documentación y texto de resumen de la entrada.
- Aspectos genéricos: detalles semánticos, como la información del sistema y del tipo de tabla.
En el siguiente ejemplo de configuración, se muestra cómo agregar una descripción general y aspectos de metadatos genéricos a una configuración de tabla para Knowledge Catalog:
```javascript
config {
type: "view",
metadata: {
overview: "This view provides standardized trip data.",
extraProperties: {
generic: {
system: "BigQuery",
type: "view"
}
}
}
}
```
En Detalles > Consultas compiladas, consulta el SQL compilado desde el código SQLX.
Haz clic en Ejecutar para ejecutar el SQL en tu canalización.
En Resultados de la consulta, inspecciona la vista previa de los datos.
Declarar fuente
Haz clic en Agregar tarea y, luego, selecciona Declarar fuente.
En el panel Declarar fuente, verifica el proyecto predeterminado para la fuente de datos o selecciona un proyecto nuevo.
Verifica el conjunto de datos predeterminado para la fuente de datos o selecciona un conjunto de datos nuevo.
En el campo Tabla/vista, selecciona la tabla o vista que deseas usar como fuente de datos.
Haz clic en Crear.
En el panel de detalles de la tarea de declaración de fuente, haz clic en Abrir para abrir la tarea.
Configura la fuente de datos con los parámetros de Detalles > Configuración o en el bloque
configdel editor de código.Para obtener más información sobre cómo configurar una fuente de datos, consulta Cómo declarar una fuente de datos.
El editor valida tu código y muestra el estado de la validación.
Prueba de datos de aserción
Haz clic en Agregar tarea y, luego, selecciona Prueba de calidad de los datos.
En el panel Crear nuevo, verifica el proyecto predeterminado para la prueba de calidad de los datos o selecciona un proyecto nuevo.
Verifica el conjunto de datos predeterminado para la prueba de calidad de los datos o selecciona un conjunto de datos nuevo.
En el campo Tabla, ingresa un nombre para la prueba de calidad de los datos.
Haz clic en Crear.
En el panel de detalles de la tarea de prueba de calidad de los datos, haz clic en Abrir para abrir la tarea.
Configura aserciones para la prueba con los parámetros de configuración en Detalles > Configuración o en el bloque
configdel editor de código.Para obtener más información sobre cómo configurar aserciones, consulta Prueba la calidad de los datos.
Opcional: En el menú Ejecutar después de, selecciona una tarea que preceda a tu prueba de calidad de los datos en la secuencia de la canalización.
El editor valida tu código y muestra el estado de la validación.
Haz clic en Ejecutar para ejecutar la prueba de calidad de los datos como parte de la secuencia de la canalización.
Prueba de unidades
Haz clic en Agregar tarea y, luego, selecciona Prueba de unidades.
En el campo Acción para probar, selecciona la tabla o vista que deseas probar.
En el campo Prueba de unidades de BigQuery, ingresa un nombre para la prueba de unidades.
Haz clic en Crear.
En el panel de detalles de la tarea, haz clic en Abrir para abrir la prueba de unidades.
Configura las entradas y las filas de salida esperadas para la prueba de unidades.
Para obtener más información sobre cómo configurar las pruebas de unidades, consulta Prueba la calidad de los datos.
Opcional: Para asegurarte de que las entradas y salidas sean las que esperas, haz clic en Ejecutar tarea y selecciona las declaraciones esperadas o reales.
Haz clic en Ejecutar para ejecutar la prueba de calidad de los datos como parte de la secuencia de la canalización.
Edita una tarea de canalización
Para editar una tarea de canalización, sigue estos pasos:
En la consola de Google Cloud , ve a la página BigQuery.
En el panel de la izquierda, haz clic en Explorar:

Si no ves el panel izquierdo, haz clic en Expandir panel izquierdo para abrirlo.
En el panel Explorador, expande tu proyecto, haz clic en Canalizaciones y, luego, selecciona una canalización.
Haz clic en la tarea seleccionada.
Para cambiar la tarea anterior, en el menú Ejecutar después de, selecciona una tarea que preceda a tu tarea.
Para editar el contenido de la tarea seleccionada, haz clic en Editar.
En la pestaña nueva que se abre, edita el contenido de la tarea y, luego, guarda los cambios.
Borra una tarea de canalización
Para borrar una tarea de una canalización, sigue estos pasos:
En la consola de Google Cloud , ve a la página BigQuery.
En el panel de la izquierda, haz clic en Explorar:

Si no ves el panel izquierdo, haz clic en Expandir panel izquierdo para abrirlo.
En el panel Explorador, expande tu proyecto, haz clic en Canalizaciones y, luego, selecciona una canalización.
Haz clic en la tarea seleccionada.
En el panel Detalles de la tarea, haz clic en Borrar Borrar.
Comparte una canalización
Para compartir una canalización, sigue estos pasos:
En la consola de Google Cloud , ve a la página BigQuery.
En el panel de la izquierda, haz clic en Explorar:

Si no ves el panel izquierdo, haz clic en Expandir panel izquierdo para abrirlo.
En el panel Explorador, expande tu proyecto, haz clic en Canalizaciones y, luego, selecciona una canalización.
Haz clic en Compartir y, luego, selecciona Administrar permisos.
Haz clic en Agregar usuario o grupo.
En el campo Principales nuevas, ingresa el nombre de, al menos, un usuario o grupo.
En Asignar roles, selecciona un rol.
Haz clic en Guardar.
Cómo compartir un vínculo a una canalización
En la consola de Google Cloud , ve a la página BigQuery.
En el panel de la izquierda, haz clic en Explorar:

Si no ves el panel izquierdo, haz clic en Expandir panel izquierdo para abrirlo.
En el panel Explorador, expande tu proyecto, haz clic en Canalizaciones y, luego, selecciona una canalización.
Haz clic en Compartir y, luego, selecciona Compartir vínculo. La URL de tu canalización se copia en el portapapeles de tu computadora.
Ejecutar una canalización
Cuando ejecutas una canalización, puedes elegir ejecutar todas las tareas de la canalización, seleccionar manualmente tareas específicas para ejecutar, ejecutar tareas con etiquetas seleccionadas o ejecutar pruebas de unidades.
Ejecuta todas las tareas de una canalización
Para ejecutar de forma manual la versión actual de una canalización, selecciona una de las siguientes opciones:
Console
Para ejecutar todas las tareas de una canalización, haz lo siguiente:
En la consola de Google Cloud , ve a la página BigQuery.
En el panel de la izquierda, haz clic en Explorar:

Si no ves el panel izquierdo, haz clic en Expandir panel izquierdo para abrirlo.
En el panel Explorador, expande tu proyecto, haz clic en Canalizaciones y, luego, selecciona una canalización.
Haz clic en Run > Run all tasks. Si seleccionaste Ejecutar con mis credenciales de usuario para tu autenticación, debes autorizar tu Cuenta de Google.
Opcional: Para inspeccionar la ejecución, consulta las ejecuciones manuales anteriores.
API
Para ejecutar una canalización de forma manual, compila el espacio de trabajo predeterminado y usa el resultado de la compilación para crear una invocación de flujo de trabajo.
Para crear un resultado de compilación para el espacio de trabajo predeterminado, usa el método
projects.locations.repositories.compilationResults.create.Ejecuta la solicitud a la API con la siguiente información:
curl -X POST \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json" \ -d '{ "workspace": "projects/PROJECT_ID/locations/LOCATION/repositories/REPOSITORY_ID/workspaces/default" }' \ "https://dataform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/repositories/REPOSITORY_ID/compilationResults"Reemplaza lo siguiente:
LOCATION: Es la región de Google Cloud para tu repositorio, por ejemplo,us-central1. Puedes encontrar la ubicación del repositorio en la consola de Google Cloud navegando al panel Explorador, seleccionando la canalización, abriendo la pestaña Configuración y haciendo clic en Abrir canalización en Dataform. La ubicación se encuentra en la URL con el formato/locations/LOCATION/.PROJECT_ID: Es el identificador único de tu proyecto de Google Cloud .REPOSITORY_ID: Es el identificador único de tu repositorio de Dataform, por ejemplo,my-secure-repo. Puedes encontrar el ID del repositorio en la consola de Google Cloud navegando al panel Explorador, seleccionando la canalización, abriendo la pestaña Configuración y viendo el campo ID del repositorio de Dataform.
En el cuerpo de la respuesta, busca el campo
namey copia su valor, por ejemplo,projects/my-project/locations/us-central1/repositories/my-repo/compilationResults/12345-67890.Activa la ejecución de la canalización con el método
projects.locations.repositories.workflowInvocations.create.Ejecuta la solicitud a la API con la siguiente información:
curl -X POST \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json" \ -d '{ "compilationResult": "COMPILATION_RESULT" }' \ "https://dataform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/repositories/REPOSITORY_ID/workflowInvocations"Reemplaza lo siguiente:
COMPILATION_RESULT: Es el nombre completo del recurso del resultado de la compilación que copiaste en el paso anterior.LOCATION: Es la región de Google Cloud para tu repositorio, por ejemplo,us-central1.PROJECT_ID: Es el identificador único de tu proyecto de Google Cloud .REPOSITORY_ID: Es el identificador único de tu repositorio de Dataform, por ejemplo,my-secure-repo.
Ejecuta tareas seleccionadas en una canalización
Para ejecutar las tareas seleccionadas en una canalización, haz lo siguiente:
En la consola de Google Cloud , ve a la página BigQuery.
En el panel de la izquierda, haz clic en Explorar:

Si no ves el panel izquierdo, haz clic en Expandir panel izquierdo para abrirlo.
En el panel Explorador, expande tu proyecto, haz clic en Canalizaciones y, luego, selecciona una canalización.
Haz clic en Run > Select tasks to run.
En el panel Ejecutar, en la sección Autenticación, autoriza la ejecución con las credenciales de usuario de tu Cuenta de Google o una cuenta de servicio.
Para usar las credenciales de usuario de tu Cuenta de Google, selecciona Ejecutar con credenciales de usuario.
Optional: In the **Extended access options** section, select the additional services that your pipeline requires: - **Knowledge Catalog**: Allows Google Cloud Knowledge Catalog metadata updates. - **Google Drive**: Allows read-only access to Google Drive files. - **Bigtable**: Allows read-only access to Google Bigtable data.Para usar una cuenta de servicio personalizada, selecciona Ejecutar con la cuenta de servicio seleccionada y, luego, selecciona una cuenta de servicio personalizada.
Si necesitas crear una cuenta de servicio, haz clic en Nueva cuenta de servicio.
Asegúrate de que esté seleccionada la opción Selección de tareas.
En el menú Selecciona las tareas que quieres ejecutar, busca tareas específicas y selecciona las que quieras ejecutar.
En la tabla Tareas, se enumeran las tareas que seleccionaste. Haz clic en el nombre de una tarea para abrirla directamente en el editor de SQL.
Opcional: Configura las siguientes opciones de ejecución:
- Incluir dependencias: Selecciona esta opción para ejecutar las tareas seleccionadas y sus dependencias.
- Incluir dependientes: Selecciona esta opción para ejecutar las tareas seleccionadas y sus dependientes downstream transitivos.
- Ejecutar con actualización completa: Selecciona esta opción para volver a compilar todas las tablas desde cero.
- Ejecutar como trabajo interactivo con alta prioridad (predeterminada): Selecciona esta opción para establecer la prioridad del trabajo de consulta de BigQuery. De forma predeterminada, BigQuery ejecuta las consultas como trabajos de consulta interactivos, que están diseñados para comenzar a ejecutarse lo antes posible. Si desmarcas esta opción, las consultas se ejecutarán como trabajos de consulta por lotes, que tienen una prioridad más baja.
Haz clic en Ejecutar. Si seleccionaste Ejecutar con credenciales de usuario como método de autenticación, debes autorizar tu Cuenta de Google (versión preliminar).
Opcional: Para inspeccionar la ejecución, consulta las ejecuciones manuales anteriores.
Ejecuta tareas con etiquetas seleccionadas en una canalización
Para ejecutar tareas con etiquetas seleccionadas en una canalización, haz lo siguiente:
En la consola de Google Cloud , ve a la página BigQuery.
En el panel de la izquierda, haz clic en Explorar:

Si no ves el panel izquierdo, haz clic en Expandir panel izquierdo para abrirlo.
En el panel Explorador, expande tu proyecto, haz clic en Canalizaciones y, luego, selecciona una canalización.
Haz clic en Ejecutar > Ejecutar por etiqueta y, luego, realiza una de las siguientes acciones:
- Haz clic en la etiqueta que quieras ejecutar.
- Haz clic en Seleccionar etiquetas para ejecutar.
En el panel Ejecutar, en la sección Autenticación, autoriza la ejecución con las credenciales de usuario de tu Cuenta de Google o una cuenta de servicio.
Para usar las credenciales de usuario de tu Cuenta de Google, selecciona Ejecutar con credenciales de usuario.
Optional: In the **Extended access options** section, select the additional services that your pipeline requires: - **Knowledge Catalog**: Allows Google Cloud Knowledge Catalog metadata updates. - **Google Drive**: Allows read-only access to Google Drive files. - **Bigtable**: Allows read-only access to Google Bigtable data.Para usar una cuenta de servicio personalizada, selecciona Ejecutar con la cuenta de servicio seleccionada y, luego, selecciona una cuenta de servicio personalizada.
Si necesitas crear una cuenta de servicio, haz clic en Nueva cuenta de servicio.
Asegúrate de que esté seleccionada la opción Selección de etiquetas.
En el menú Selecciona las etiquetas que deseas ejecutar, busca etiquetas específicas y selecciona las que deseas ejecutar.
En la tabla Tareas, se enumeran las tareas que seleccionaste. Haz clic en el nombre de una tarea para abrirla directamente en el editor de SQL.
Opcional: Configura las siguientes opciones de ejecución:
- Incluir dependencias: Selecciona esta opción para ejecutar las tareas seleccionadas y sus dependencias.
- Incluir dependientes: Selecciona esta opción para ejecutar las tareas seleccionadas y sus dependientes downstream transitivos.
- Ejecutar con actualización completa: Selecciona esta opción para volver a compilar todas las tablas desde cero.
- Ejecutar como trabajo interactivo con alta prioridad (predeterminada): Selecciona esta opción para establecer la prioridad del trabajo de consulta de BigQuery. De forma predeterminada, BigQuery ejecuta las consultas como trabajos de consulta interactivos, que están diseñados para comenzar a ejecutarse lo antes posible. Si desmarcas esta opción, las consultas se ejecutarán como trabajos de consulta por lotes, que tienen una prioridad más baja.
Haz clic en Ejecutar. Si seleccionaste Ejecutar con credenciales de usuario como método de autenticación, debes autorizar tu Cuenta de Google (versión preliminar).
Opcional: Para inspeccionar la ejecución, consulta las ejecuciones manuales anteriores.
Ejecuta pruebas de unidades en una canalización
Defines pruebas de unidades en Dataform
creando archivos de prueba .sqlx en el directorio definitions/ de tu
repositorio. Después de crear pruebas de unidades en Dataform, puedes ejecutarlas
directamente en tu canalización de BigQuery para validar tu lógica de transformación de SQL
en conjuntos de datos simulados.
Para ejecutar pruebas de unidades en una canalización, haz lo siguiente:
En la consola de Google Cloud , ve a la página BigQuery.
En el panel de la izquierda, haz clic en Explorar:

Si no ves el panel izquierdo, haz clic en Expandir panel izquierdo para abrirlo.
En el panel Explorador, expande tu proyecto, haz clic en Canalizaciones y, luego, selecciona una canalización.
Haz clic en Ejecutar.
En el panel Ejecutar, en la sección Autenticación, autoriza la ejecución con las credenciales de usuario de tu Cuenta de Google o una cuenta de servicio:
Para usar las credenciales de usuario de tu Cuenta de Google (versión preliminar), selecciona Ejecutar con credenciales de usuario.
Optional: In the **Extended access options** section, select the additional services that your pipeline requires: - **Knowledge Catalog**: Allows Google Cloud Knowledge Catalog metadata updates. - **Google Drive**: Allows read-only access to Google Drive files. - **Bigtable**: Allows read-only access to Google Bigtable data.Para usar una cuenta de servicio personalizada, selecciona Ejecutar con la cuenta de servicio seleccionada y, luego, selecciona una cuenta de servicio personalizada.
Para ver las cuentas de servicio en el menú, debes tener el permiso
iam.serviceAccounts.lista nivel del proyecto, que está disponible en el rol de visualizador de cuentas de servicio (roles/iam.serviceAccountViewer). Si no tienes este permiso, puedes seleccionar la cuenta de servicio haciendo clic en Ingresar manualmente y escribiendo el ID de cuenta de servicio.Si necesitas crear una cuenta de servicio, haz clic en Nueva cuenta de servicio.
En la sección Execution mode, selecciona Unit tests.
Selecciona una de las siguientes opciones de alcance de ejecución:
- Seleccionar pruebas de unidades: Busca y selecciona pruebas de unidades específicas de tu canalización.
- Seleccionar etiquetas de pruebas de unidades: Filtra y ejecuta pruebas de unidades a las que se les asignaron etiquetas específicas.
- Todas las pruebas de unidades: Ejecuta todas las pruebas de unidades definidas en la canalización.
Opcional: En las secciones Opciones de ejecución, selecciona la casilla de verificación Ejecutar como trabajo interactivo con alta prioridad para ejecutar pruebas de unidades de inmediato y priorizar la velocidad de ejecución.
Si no seleccionas la casilla de verificación Ejecutar como trabajo interactivo con alta prioridad, Dataform ejecuta pruebas de unidades con recursos por lotes de forma predeterminada, lo que prioriza el ahorro de costos de procesamiento.
Haz clic en Ejecutar. Si seleccionaste Ejecutar con credenciales de usuario como método de autenticación, debes autorizar tu Cuenta de Google (versión preliminar).
Opcional: Para inspeccionar la ejecución, consulta las ejecuciones manuales anteriores.
Autoriza tu Cuenta de Google
Para autenticar el recurso con las credenciales de usuario de tu Cuenta de Google, debes otorgar permiso de forma manual a las canalizaciones de BigQuery para que obtengan el token de acceso de tu Cuenta de Google y accedan a los datos de origen en tu nombre. Puedes otorgar la aprobación manual con la interfaz del diálogo de OAuth. Si seleccionas alguna de las opciones de acceso extendido, debes otorgar acceso a esos servicios, por ejemplo, Google Drive o Knowledge Catalog.
Solo debes otorgar permiso a las canalizaciones de BigQuery una vez.
Para revocar el permiso que otorgaste, sigue estos pasos:
- Ve a la página de la Cuenta de Google.
- Haz clic en Canalizaciones de BigQuery.
- Haga clic en Quitar acceso.
Si tu canalización contiene un notebook, también debes otorgar permiso de forma manual para que Colab Enterprise obtenga el token de acceso de tu Cuenta de Google y acceda a los datos de origen en tu nombre. Solo debes otorgar el permiso una vez. Puedes revocar este permiso en la página de la Cuenta de Google.
¿Qué sigue?
- Obtén más información sobre las canalizaciones de BigQuery.
- Obtén más información para administrar canalizaciones.
- Obtén información para programar canalizaciones.
- Aprende a administrar código con repositorios de Git de BigQuery Studio.
- Obtén más información para organizar los recursos de código con carpetas.
- Obtén información para probar la calidad de los datos con pruebas de unidades.