Usa la CLI de código abierto de Dataform

En este documento, se muestra cómo usar Dataform de código abierto interfaz de línea de comandos (CLI) para desarrollar flujos de trabajo de SQL de forma local con la terminal.

Con la CLI de código abierto de Dataform, puedes inicializar, compilar, probar, y ejecutar Dataform Core de forma local fuera de Google Cloud.

La CLI de Dataform admite las credenciales predeterminadas de la aplicación (ADC). Con ADC, las credenciales están disponibles para tu aplicación en una variedad de entornos, como el desarrollo o la producción locales, sin necesidad de modificar el código de la aplicación. Para usar ADC, primero debes hacer lo siguiente: proporciona tus credenciales a ADC.

Antes de comenzar

Antes de instalar la CLI de Dataform, instala NPM

Instala la CLI de Dataform

  • Para instalar la CLI de Dataform, ejecuta el siguiente comando:

    npm i -g @dataform/cli@^3.0.0-beta

Inicializa un proyecto de Dataform

  • Para inicializar un nuevo proyecto de Dataform, Ejecuta el siguiente comando dentro del directorio de tu proyecto:

    dataform init . PROJECT_NAME DEFAULT_LOCATION

    Reemplaza lo siguiente:

    • PROJECT_NAME: nombre del proyecto.
    • DEFAULT_LOCATION: Es la región en la que deseas. Dataform para escribir datos de BigQuery. Más información sobre las regiones de BigQuery, consulta Ubicaciones de BigQuery.

Actualizar Dataform

  • Para actualizar el framework de Dataform, actualiza el archivo dataformCoreVersion. en el archivo workflow_settings.yaml, vuelve a ejecutar la instalación de NPM:

    npm i

Actualiza la CLI de Dataform

  • Para actualizar la herramienta de la CLI de Dataform, ejecuta el siguiente comando:

    npm i -g @dataform/cli@^3.0.0-beta.2

Crea un archivo de credenciales

Dataform requiere un archivo de credenciales para conectarse a servicios remotos. y crea el archivo .df-credentials.json en tu disco.

Para crear el archivo de credenciales, sigue estos pasos:

  1. Ejecuta el siguiente comando:

    dataform init-creds

  2. Sigue el asistente de init-creds que te guiará en la creación del archivo de credenciales.

Crea un proyecto

Un proyecto de Dataform vacío en el núcleo de Dataform 3.0.0-beta.0 o versiones posteriores tienen la siguiente estructura:

   project-dir
   ├── definitions
   ├── includes
   └── workflow_settings.yaml

  • Sigue estos pasos para crear un proyecto de Dataform para implementar recursos en BigQuery: Ejecuta el siguiente comando:

    dataform init PROJECT_NAME --default-project YOUR_GOOGLE_CLOUD_PROJECT_ID

    Reemplaza lo siguiente:

    • PROJECT_NAME: nombre del proyecto.
    • YOUR_GOOGLE_CLOUD_PROJECT_ID: Es el ID de tu proyecto de Google Cloud.

Clona un proyecto

Sigue estos pasos para clonar un proyecto de Dataform existente desde un repositorio de Git de terceros: sigue las instrucciones de tu proveedor de Git.

  • Cuando el repositorio esté clonado, ejecuta el siguiente comando el directorio del repositorio clonado:

    dataform install

Define una tabla

Almacena definiciones en la carpeta definitions/.

  • Para definir una tabla, ejecuta el siguiente comando:

    echo "config { type: 'TABLE_TYPE' } SELECT_STATEMENT" > definitions/FILE.sqlx

    Reemplaza lo siguiente:

    • TABLE_TYPE: Es el tipo de la tabla. table, incremental o view.
    • SELECT_STATEMENT: Es una sentencia SELECT que define la tabla.
    • FILE: Es el nombre del archivo de definición de tablas.

En la siguiente muestra de código, se define una vista en el archivo SQLX example.

echo "config { type: 'view' } SELECT 1 AS test" > definitions/example.sqlx

Define una aserción manual

Almacena definiciones en la carpeta definitions/.

  • Para definir una aserción manual, ejecuta el siguiente comando:

    echo "config { type: 'assertion' } SELECT_STATEMENT" > definitions/FILE.sqlx

    Reemplaza lo siguiente:

    • SELECT_STATEMENT: Es una sentencia SELECT que indica define la aserción.
    • FILE: Es el nombre de la operación de SQL personalizada. definición.

Define una operación de SQL personalizada

Almacena definiciones en la carpeta definitions/.

  • Para definir una operación de SQL personalizada, ejecuta el siguiente comando:

    echo "config { type: 'operations' } SQL_QUERY" > definitions/FILE.sqlx

    Reemplaza lo siguiente:

    • SQL_QUERY: Es tu operación de SQL personalizada.
    • FILE: Es el nombre de la operación de SQL personalizada. definición.

Ver el resultado de la compilación

Dataform compila tu código en tiempo real.

  • Para ver el resultado del proceso de compilación en la terminal, haz lo siguiente: Ejecuta el siguiente comando:

    dataform compile

  • Para ver el resultado del proceso de compilación como un objeto JSON, Ejecuta el siguiente comando:

    dataform compile --json

  • Para ver el resultado de la compilación con variables de compilación personalizadas Ejecuta el siguiente comando:

    dataform compile --vars=SAMPLE_VAR=SAMPLE_VALUE,foo=bar

    Reemplaza lo siguiente:

    • SAMPLE_VAR: Es tu variable de compilación personalizada.
    • SAMPLE_VALUE: Es el valor de tu variable de compilación personalizada.

Ejecutar código

Para ejecutar tu código, Dataform accede a BigQuery para determinar su estado actual y adaptar el SQL resultante según corresponda.

  • Para ejecutar el código de tu proyecto de Dataform, ejecuta el siguiente comando:

    dataform run

  • Ejecuta el código de tu proyecto de Dataform en BigQuery con variables de compilación personalizadas Ejecuta el siguiente comando:

    dataform run --vars=SAMPLE_VAR=SAMPLE_VALUE,sampleVar2=sampleValue2

    Reemplaza lo siguiente:

    • SAMPLE_VAR: Es tu variable de compilación personalizada.
    • SAMPLE_VALUE: Es el valor de tu variable de compilación personalizada.

  • Para ejecutar el código de tu proyecto de Dataform en BigQuery y volver a compilar todas las tablas desde cero, ejecuta el siguiente comando:

    dataform run --full-refresh

Sin --full-refresh, Dataform actualiza las tablas incrementales. sin reconstruirlas desde cero.

  • Para ver el código SQL compilado final adaptado al estado actual de BigQuery, sin ejecutarlo dentro de BigQuery, Ejecuta el siguiente comando:

    dataform run --dry-run

Obtener ayuda

  • Para ver una lista de todos los comandos y opciones disponibles, haz lo siguiente: Ejecuta el siguiente comando:

    dataform help

  • Para ver la descripción de un comando específico, Ejecuta el siguiente comando:

    dataform help COMMAND

    Reemplaza COMMAND por el comando sobre el que deseas obtener información.

¿Qué sigue?