Configurer les paramètres de workflow Dataform

Cette page explique comment modifier les paramètres de traitement du workflow SQL Dataform pour un dépôt spécifique.

Vous pouvez modifier le fichier de paramètres pour renommer les schémas ou ajouter des variables de compilation personnalisées à votre dépôt.

À propos des paramètres de dépôt

Chaque dépôt Dataform contient un fichier de paramètres de workflow unique. Le fichier contient l'ID du projet Google Cloud et le schéma dans lequel Dataform publie des éléments dans BigQuery. Dataform utilise les paramètres par défaut que vous pouvez remplacer en fonction de vos besoins en modifiant le fichier de paramètres.

Depuis Dataform Core 3.0, les paramètres de workflow sont par défaut stockés dans le fichier workflow_settings.yaml. Dans les versions antérieures de Dataform Core, les paramètres de workflow sont stockés dans le fichier dataform.json. Le fichier workflow_settings.yaml Dataform Core 3.0 est rétrocompatible avec dataform.json. Vous pouvez continuer à utiliser dataform.json pour configurer les paramètres Dataform.

À propos de workflow_settings.yaml

Le fichier workflow_settings.yaml, introduit dans Dataform Core 3.0, stocke les paramètres de workflow Dataform au format YAML.

L'exemple de code suivant montre un exemple de fichier workflow_settings.yaml:

  defaultProject: my-gcp-project-id
  defaultDataset: dataform
  defaultLocation: australia-southeast2
  defaultAssertionDataset: dataform_assertions

Dans l'exemple de code précédent, les paires clé-valeur sont décrites comme suit:

  • defaultProject: ID de votre projet BigQuery Google Cloud.
  • defaultDataset: ensemble de données BigQuery dans lequel Dataform crée des éléments, appelés dataform par défaut.
  • defaultLocation: région par défaut de votre ensemble de données BigQuery. Pour en savoir plus sur les emplacements des ensembles de données BigQuery, consultez la section Emplacements des ensembles de données. Dans cet emplacement, Dataform traite votre code et stocke les données exécutées. Cette région de traitement doit correspondre à l'emplacement de vos ensembles de données BigQuery, mais pas nécessairement à la région du dépôt Dataform.
  • defaultAssertionDataset: ensemble de données BigQuery dans lequel Dataform crée des vues avec des résultats d'assertion, appelés dataform_assertions par défaut.

Pour en savoir plus sur les propriétés workflow_settings.yaml, consultez la documentation de référence sur les configurations pour les paramètres de workflow dans GitHub.

Vous pouvez accéder aux propriétés définies dans workflow_settings.yaml dans votre code Dataform en tant que propriétés de l'objet dataform.projectConfig.

Les mappages suivants des options workflow_settings.yaml avec les options dataform.projectConfig accessibles au code s'appliquent:

  • defaultProject => defaultDatabase.
  • defaultDataset => defaultSchema.
  • defaultAssertionDataset => assertionSchema.
  • projectSuffix => databaseSuffix.
  • datasetSuffix => schemaSuffix.
  • namePrefix => tablePrefix.

L'exemple de code suivant montre l'objet dataform.projectConfig appelé dans une instruction SELECT d'une vue:

  config { type: "view" }
  SELECT ${when(
    !dataform.projectConfig.tablePrefix,
    "table prefix is set!",
    "table prefix is not set!"
  )}

À propos de dataform.json

Le fichier dataform.json stocke les paramètres de workflow Dataform au format JSON.

L'exemple de code suivant montre un exemple de fichier dataform.json:

  {
    "warehouse": "bigquery",
    "defaultDatabase": "my-gcp-project-id",
    "defaultSchema": "dataform",
    "defaultLocation": "australia-southeast2",
    "assertionSchema": "dataform_assertions"
  }

Dans l'exemple de code précédent, les paires clé-valeur sont décrites comme suit:

  • warehouse: pointeur vers BigQuery, où Dataform crée des éléments.
  • defaultDatabase: ID de votre projet BigQuery Google Cloud.
  • defaultSchema: ensemble de données BigQuery dans lequel Dataform crée des éléments, appelés dataform par défaut.
  • defaultLocation: région par défaut de votre ensemble de données BigQuery. Pour en savoir plus sur les emplacements des ensembles de données BigQuery, consultez la section Emplacements des ensembles de données. Dans cet emplacement, Dataform traite votre code et stocke les données exécutées. Cette région de traitement doit correspondre à l'emplacement de vos ensembles de données BigQuery, mais pas nécessairement à la région du dépôt Dataform.
  • assertionSchema: ensemble de données BigQuery dans lequel Dataform crée des vues avec des résultats d'assertion, appelés dataform_assertions par défaut.

Vous pouvez accéder aux propriétés définies dans dataform.json dans le code de votre projet en tant que propriétés de l'objet dataform.projectConfig.

Avant de commencer

  1. Créez un dépôt.

  2. Créez et initialisez un espace de travail de développement dans votre dépôt.

Rôles requis

Pour obtenir les autorisations nécessaires pour configurer les paramètres Dataform, demandez à votre administrateur de vous attribuer le rôle IAM Administrateur Dataform (roles/dataform.admin) pour les dépôts. Pour en savoir plus sur l'attribution de rôles, consultez la section Gérer les accès.

Vous pouvez également obtenir les autorisations requises via des rôles personnalisés ou d'autres rôles prédéfinis.

Configurer les noms de schéma

Pour configurer des noms de schéma, vous devez modifier les propriétés defaultDataset et defaultAssertionSchema dans le fichier workflow_settings.yaml, ou les propriétés defaultSchema et assertionSchema dans le fichier dataform.json.

Pour configurer le nom d'un schéma, procédez comme suit:

workflow_settings.yaml

  1. Dans votre espace de travail de développement, dans le volet Fichiers, cliquez sur le fichier workflow_settings.yaml.

  2. Modifiez la valeur de defaultDataset, defaultAssertionSchema ou les deux.

L'exemple de code suivant montre un nom defaultDataset personnalisé défini dans le fichier workflow_settings.yaml:

  ...
  defaultDataset: mytables
  ...

dataform.json

  1. Dans votre espace de travail de développement, dans le volet Fichiers, cliquez sur le fichier dataform.json.

  2. Modifiez la valeur de defaultSchema, assertionSchema ou les deux.

L'exemple de code suivant montre un nom defaultSchema personnalisé défini dans le fichier dataform.json:

{
  ...
  "defaultSchema": "mytables",
  ...
}

Créer des variables de compilation personnalisées

Les variables de compilation contiennent des valeurs que vous pouvez modifier avec des remplacements de compilation dans une configuration de version ou dans une requête API Dataform.

Après avoir défini une variable de compilation dans workflow_settings.yaml et l'avoir ajoutée aux tables sélectionnées, vous pouvez modifier sa valeur dans une configuration de version ou utiliser les remplacements de compilation de l'API Dataform pour exécuter des tables de manière conditionnelle.

Pour en savoir plus sur l'exécution de tables de manière conditionnelle à l'aide de variables de compilation, consultez la page Introduction au cycle de vie du code dans Dataform.

Pour créer une variable de compilation que vous pouvez utiliser dans un dépôt, procédez comme suit:

workflow_settings.yaml

  1. Accédez à votre espace de travail de développement Dataform.
  2. Dans le volet Fichiers, sélectionnez le fichier workflow_settings.yaml.

  3. Saisissez l'extrait de code suivant:

    "vars": {
  "YOUR_VARIABLE":"VALUE"
}

    Remplacez les éléments suivants :

    • YOUR_VARIABLE par le nom de la variable.
    • VALUE par la valeur par défaut de la variable de compilation.

L'exemple de code suivant montre la variable de compilation myVariableName définie sur myVariableValue dans le fichier workflow_settings.yaml:

...
vars:
  myVariableName: myVariableValue
...

L'exemple de code suivant montre le fichier workflow_settings.yaml avec la variable de compilation executionSetting définie sur dev:

defaultProject: default_bigquery_database
defaultLocation: us-west1
defaultDataset: dataform_data,
vars:
executionSetting: dev

dataform.json

  1. Accédez à votre espace de travail de développement Dataform.
  2. Dans le volet Fichiers, sélectionnez le fichier dataform.json.

  3. Saisissez l'extrait de code suivant:

    "vars": {
  "YOUR_VARIABLE":"VALUE"
}

    Remplacez les éléments suivants :

    • YOUR_VARIABLE par le nom de la variable.
    • VALUE par la valeur par défaut de la variable de compilation.

L'exemple de code suivant montre la variable de compilation myVariableName définie sur myVariableValue dans le fichier dataform.json:

{
  ...
  "vars": {
    "myVariableName": "myVariableValue"
  },
  ...
}

L'exemple de code suivant montre le fichier dataform.json avec la variable de compilation executionSetting définie sur dev:

{
"warehouse": "bigquery",
"defaultSchema": "dataform_data",
"defaultDatabase": "default_bigquery_database".
"defaultLocation":"us-west-1",
"vars": {
"executionSetting":"dev"
}
}

Ajouter une variable de compilation à une table

Pour ajouter une variable de compilation à un fichier de définition de table SQLX, procédez comme suit:

  1. Accédez à votre espace de travail de développement Dataform.
  2. Dans le volet Fichiers, sélectionnez un fichier de définition de table SQLX.

  3. Dans le fichier, saisissez une clause when au format suivant:

    ${when(dataform.projectConfig.vars.YOUR_VARIABLE === "SET_VALUE", "CONDITION")}

    Remplacez les éléments suivants :

    • YOUR_VARIABLE par le nom de votre variable, par exemple executionSetting.
    • SET_VALUE par une valeur pour la variable (par exemple, staging) ;
    • CONDITION par une condition d'exécution de la table.

L'exemple de code suivant montre un fichier SQLX de définition de table avec une clause when et la variable executionSetting qui exécute 10% des données dans le paramètre d'exécution en préproduction:

  select
    *
  from ${ref("data")}
  ${when(
    dataform.projectConfig.vars.executionSetting === "staging",
    "where mod(farm_fingerprint(id) / 10) = 0",
  )}

L'exemple de code suivant montre un fichier SQLX de définition de vue contenant une clause when et la variable myVariableName:

  config { type: "view" }
  SELECT ${when(
    dataform.projectConfig.vars.myVariableName === "myVariableValue",
    "myVariableName is set to myVariableValue!",
    "myVariableName is not set to myVariableValue!"
  )}

Étapes suivantes