Tester des tables avec des assertions

Ce document explique comment utiliser le noyau Dataform pour créer des assertions de table Dataform et tester le code de votre workflow.

À propos des assertions

Une assertion est une requête de test de qualité des données qui recherche les lignes qui ne respectent pas une ou plusieurs conditions spécifiées dans la requête. Si la requête renvoie des lignes, l'assertion échoue. Dataform exécute des assertions chaque fois qu'il met à jour votre workflow SQL et vous avertit en cas d'échec.

Dataform crée automatiquement des vues dans BigQuery contenant les résultats des requêtes d'assertion compilées. Comme configuré dans votre fichier de paramètres de workflow, Dataform crée ces vues dans un schéma d'assertions dans lequel vous pouvez inspecter les résultats d'assertion.

Par exemple, pour le schéma dataform_assertions par défaut, Dataform crée une vue dans BigQuery au format suivant : dataform_assertions.assertion_name.

Vous pouvez créer des assertions pour tous les types de tables Dataform: tables, tables incrémentielles, vues et vues matérialisées.

Vous pouvez créer des assertions de différentes manières:

Avant de commencer

  1. Dans la console Google Cloud, accédez à la page Dataform page.

    Accéder à la page Dataform

  2. Sélectionnez ou créez un dépôt.

  3. Sélectionnez ou créez un espace de travail de développement.

  4. Définir une table

Rôles requis

Pour obtenir les autorisations nécessaires pour créer des assertions, demandez à votre administrateur de vous accorder le rôle IAM Éditeur Dataform (roles/dataform.editor) sur les espaces de travail. Pour en savoir plus sur l'attribution de rôles, consultez la page Gérer l'accès aux projets, aux dossiers et aux organisations.

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

Créer des assertions intégrées

Vous pouvez ajouter des assertions Dataform intégrées au bloc config d'un tableau. Dataform exécute ces assertions après la création de la table. Une fois que Dataform a créé le tableau, vous pouvez voir si l'assertion a réussi dans l'onglet Journaux d'exécution du workflow de votre espace de travail.

Vous pouvez créer les assertions suivantes dans le bloc config d'une table:

  • nonNull

    Cette condition affirme que les colonnes spécifiées ne sont pas nulles dans toutes les lignes du tableau. Cette condition est utilisée pour les colonnes qui ne peuvent jamais être nulles.

    L'exemple de code suivant montre une assertion nonNull dans le bloc config d'une table:

config {
  type: "table",
  assertions: {
    nonNull: ["user_id", "customer_id", "email"]
  }
}
SELECT ...

  • rowConditions

    Cette condition affirme que toutes les lignes de la table suivent la logique personnalisée que vous définissez. Chaque condition de ligne est une expression SQL personnalisée, et chaque ligne de table est évaluée par rapport à chaque condition de ligne. L'assertion échoue si une ligne de table renvoie false.

    L'exemple de code suivant montre une assertion rowConditions personnalisée dans le bloc config d'une table incrémentielle:

config {
  type: "incremental",
  assertions: {
    rowConditions: [
      'signup_date is null or signup_date > "2022-08-01"',
      'email like "%@%.%"'
    ]
  }
}
SELECT ...

  • uniqueKey

    Cette condition affirme que, dans une colonne spécifiée, aucune ligne de table n'a la même valeur.

    L'exemple de code suivant montre une assertion uniqueKey dans le bloc config d'une vue:

config {
  type: "view",
  assertions: {
    uniqueKey: ["user_id"]
  }
}
SELECT ...

  • uniqueKeys

    Cette condition affirme que, dans les colonnes spécifiées, aucune ligne de table n'a la même valeur. L'assertion échoue si la table comporte plusieurs lignes avec les mêmes valeurs pour toutes les colonnes spécifiées.

    L'exemple de code suivant montre une assertion uniqueKeys dans le bloc config d'un tableau:

config {
  type: "table",
  assertions: {
    uniqueKeys: [["user_id"], ["signup_date", "customer_id"]]
  }
}
SELECT ...

Ajouter des assertions au bloc config

Pour ajouter des assertions au bloc de configuration d'une table, procédez comme suit:

  1. Dans votre espace de travail de développement, dans le volet Fichiers, sélectionnez un fichier SQLX de définition de table.
  2. Dans le bloc config du fichier de table, saisissez assertions: {}.
  3. Dans assertions: {}, ajoutez vos assertions.
  4. Facultatif: cliquez sur Format.

L'exemple de code suivant montre les conditions ajoutées dans le bloc config:

config {
  type: "table",
  assertions: {
    uniqueKey: ["user_id"],
    nonNull: ["user_id", "customer_id"],
    rowConditions: [
      'signup_date is null or signup_date > "2019-01-01"',
      'email like "%@%.%"'
    ]
  }
}
SELECT ...

Créer des assertions manuelles avec SQLX

Les assertions manuelles sont des requêtes SQL que vous écrivez dans un fichier SQLX dédié. Une requête SQL d'assertion manuelle doit renvoyer zéro ligne. Si la requête renvoie des lignes lors de son exécution, l'assertion échoue.

Pour ajouter des assertions manuelles dans un nouveau fichier SQLX, procédez comme suit:

  1. Dans le volet Fichiers, à côté de definitions/, cliquez sur le menu Plus.
  2. Cliquez sur Créer un fichier.

  3. Dans le champ Ajouter un chemin d'accès au fichier, saisissez le nom du fichier suivi de .sqlx. Par exemple, definitions/custom_assertion.sqlx.

    Les noms de fichiers ne peuvent contenir que des chiffres, des lettres, des traits d'union et des traits de soulignement.

  4. Cliquez sur Créer un fichier.

  5. Dans le volet Fichiers, cliquez sur le nouveau fichier.

  6. Dans le fichier, saisissez:

    config {
  type: "assertion"
}

  7. Sous le bloc config, rédigez votre requête SQL ou plusieurs requêtes.

  8. Facultatif: cliquez sur Format.

L'exemple de code suivant montre une assertion manuelle dans un fichier SQLX qui affirme que les champs A, B et c ne sont jamais NULL dans sometable:

config { type: "assertion" }

SELECT
  *
FROM
  ${ref("sometable")}
WHERE
  a IS NULL
  OR b IS NULL
  OR c IS NULL

Définir des assertions en tant que dépendances

Lorsque l'action de workflow B dépend de l'action de workflow A qui comporte des assertions, l'échec des assertions de l'action A n'empêche pas Dataform d'exécuter l'action B. Pour exécuter l'action B uniquement si les assertions de l'action A sont validées, vous devez définir les assertions de l'action A comme dépendances de l'action B.

Vous pouvez définir des assertions en tant que dépendances d'une action sélectionnée de différentes manières:

Définir les assertions sélectionnées comme dépendances

Vous pouvez définir manuellement des assertions sélectionnées en tant que dépendances en les ajoutant à dependencies: [ "" ] dans le bloc config de l'action modifiée.

Par exemple, si l'action B dépend de l'action A et que vous souhaitez que l'action B ne dépende que d'assertions sélectionnées de l'action A, vous pouvez ajouter ces assertions sélectionnées au bloc config de l'action B.

Vous pouvez définir manuellement des assertions sélectionnées en tant que dépendances pour tous les types d'actions, à l'exception des déclarations de sources de données.

Définir les assertions d'une action de dépendance sélectionnée en tant que dépendances

Vous pouvez définir le paramètre includeDependentAssertions pour définir automatiquement toutes les assertions directes d'une action de workflow de dépendance sélectionnée en tant que dépendances de l'action modifiée. Dataform ajoute ces assertions en tant que dépendances lors de chaque compilation de l'action pour s'assurer que les dépendances sont à jour si les assertions de l'action de dépendance changent.

Par exemple, si l'action C dépend des actions A et B, mais que vous ne souhaitez que l'action C dépende des assertions de l'action A, vous pouvez modifier l'action C et définir le paramètre includeDependentAssertions pour définir automatiquement toutes les assertions de l'action A comme dépendances de l'action C.

Vous pouvez définir le paramètre includeDependentAssertions pour les actions des types suivants:

  • table
  • view
  • operations
Définir les assertions de toutes les actions de dépendance en tant que dépendances

Vous pouvez définir le paramètre dependOnDependencyAssertions pour définir automatiquement toutes les assertions directes de toutes les actions de dépendance de l'action modifiée en tant que dépendances supplémentaires de l'action modifiée. Dataform ajoute ces assertions en tant que dépendances lors de chaque compilation de l'action pour s'assurer que les dépendances sont à jour si les assertions de l'action de dépendance changent.

Par exemple, si l'action C dépend des actions A et B, vous pouvez modifier l'action C et définir le paramètre dependOnDependencyAssertions pour définir automatiquement toutes les assertions des actions A et B en tant que dépendances de l'action C.

Vous pouvez définir le paramètre dependOnDependencyAssertions pour les actions des types suivants:

  • table
  • view
  • operations

Lorsque vous définissez le paramètre dependOnDependencyAssertions et les paramètres includeDependentAssertions dans un seul fichier, le paramètre includeDependentAssertions est prioritaire. Par exemple, si vous définissez dependOnDependencyAssertions sur true, mais que vous définissez également includeDependentAssertions sur false pour une action de dépendance sélectionnée, Dataform n'ajoutera pas d'assertions de cette action aux dépendances.

L'exemple de code suivant montre les paramètres dependOnDependencyAssertions et includeDependentAssertions définis dans le même fichier de définition de table:

// filename is tableName.sqlx

config {
type: "table",
dependOnDependencyAssertions: true,
dependencies: [ "actionA", {name: "actionB", includeDependentAssertions: false} ]
}

SELECT * FROM ${ref("actionC")}

Dans l'exemple de code précédent, Dataform ajoute toutes les assertions directes de actionA et actionC aux dépendances de tableName lors de la compilation.

Définir les assertions sélectionnées comme dépendances

Pour exécuter une action de workflow uniquement lorsque les assertions sélectionnées sont validées, vous pouvez ajouter l'assertion sélectionnée à dependencies: [ "" ] dans le bloc config de l'action modifiée.

Pour définir une assertion sélectionnée comme dépendance d'une action de workflow sélectionnée, procédez comme suit:

  1. Dans votre espace de travail de développement, dans le volet Fichiers, développez definitions/.
  2. Sélectionnez un fichier SQLX d'action de workflow.
  3. Dans le bloc config du fichier d'action, saisissez dependencies: [ "" ].

  4. Dans dependencies: [ "" ], saisissez le nom de l'assertion d'action ou le nom de fichier de l'assertion manuelle que vous souhaitez définir comme dépendance dans l'un des formats suivants:

    nonNull

    config {
  type: "ACTION_TYPE",
  dependencies: [ "ACTION_DATASET_NAME_ACTION_NAME_assertions_nonNull"]
}

    Remplacez les éléments suivants :

    • ACTION_TYPE: type d'action de workflow : table, view ou operations.
    • ACTION_DATASET_NAME: nom de l'ensemble de données dans lequel l'action est définie. L'ensemble de données par défaut est défini dans le fichier de paramètres du workflow.
    • ACTION_NAME: nom de l'action dans laquelle l'assertion est définie.

    rowConditions

    config {
  type: "ACTION_TYPE",
  dependencies: [ "ACTION_DATASET_NAME_ACTION_NAME_assertions_rowConditions"]
}

    Remplacez les éléments suivants :

    • ACTION_TYPE: type d'action de workflow : table, view ou operations.
    • DATASET_NAME: nom de l'ensemble de données dans lequel l'action est définie. L'ensemble de données par défaut est défini dans le fichier de paramètres du workflow.
    • ACTION_NAME: nom de l'action dans laquelle l'assertion est définie.

    uniqueKey

    config {
  type: "ACTION_TYPE",
  dependencies: [ "ACTION_DATASET_NAME_ACTION_NAME_assertions_uniqueKey_INDEX"]
}

    Remplacez les éléments suivants :

    • ACTION_TYPE: type d'action de workflow : table, view ou operations.
    • DATASET_NAME: nom de l'ensemble de données dans lequel la table est définie. L'ensemble de données par défaut est défini dans le fichier de paramètres du workflow.
    • ACTION_NAME: nom de la table dans laquelle l'assertion est définie.
    • INDEX: index du tableau de clés défini dans l'assertion uniqueKey que vous souhaitez ajouter en tant que dépendance. Par exemple, 0 ou 1. Si un seul tableau de clés est défini dans l'assertion, l'index est 0.

    uniqueKeys

    config {
  type: "ACTION_TYPE",
  dependencies: [ "ACTION_DATASET_NAME_ACTION_NAME_assertions_uniqueKeys_INDEX"]
}

    Remplacez les éléments suivants :

    • ACTION_TYPE: type d'action de workflow : table, view ou operations.
    • DATASET_NAME: nom de l'ensemble de données dans lequel la table est définie. L'ensemble de données par défaut est défini dans le fichier de paramètres du workflow.
    • ACTION_NAME: nom de la table dans laquelle l'assertion est définie.
    • INDEX: index du tableau de clés défini dans l'assertion uniqueKeys que vous souhaitez ajouter en tant que dépendance (par exemple, 0 ou 1). Si un seul tableau de clés est défini dans l'assertion, l'index est 0.

    assertion manuelle

    config {
  type: "ACTION_TYPE",
  dependencies: [ "MANUAL_ASSERTION_NAME"]
}

    Remplacez les éléments suivants :

    • ACTION_TYPE: type d'action de workflow : table, view ou operations.
    • MANUAL_ASSERTION_NAME : nom de l'assertion manuelle.

  5. Pour ajouter une autre assertion en tant que dépendance à la table modifiée, répétez l'étape 4.

  6. Facultatif: cliquez sur Format.

L'exemple de code suivant montre les assertions ajoutées à la table A, définie dans l'ensemble de données dataform:

config {
  type: "table",
  assertions: {
    uniqueKey: ["user_id"],
    nonNull: ["user_id", "customer_id"],
  }
}

L'exemple de code suivant montre les assertions de la table A ajoutées en tant que dépendances à la table B:

config {
  type: "table",
  dependencies: [ "dataform_A_assertions_uniqueKey_0",  "dataform_A_assertions_nonNull"]
}

L'exemple de code suivant montre une assertion manuelle définie dans le fichier manualAssertion.sqlx, ajoutée en tant que dépendance à une vue:

config {
  type: "view",
  dependencies: [ "manualAssertion"]
}

L'exemple de code suivant montre le fichier manual_assertion et les assertions de la table sometable ajoutées en tant que dépendances à une table:

config {
  type: "table",
  dependencies: [ "manual_assertion",  "dataform_sometable_assertions_nonNull" ,  "dataform_sometable_assertions_rowConditions"]
}

SELECT * FROM ${ref("referenced_table")} LEFT JOIN ...

Définir les assertions d'une action sélectionnée comme dépendances

Pour exécuter une action de workflow uniquement lorsque toutes les assertions directes d'une action de dépendance sélectionnée sont acceptées, définissez le paramètre includeDependentAssertions sur true dans l'action modifiée. Dataform ajoute automatiquement des assertions directes de l'action de dépendance sélectionnée aux dépendances lors de la compilation. La valeur par défaut est false.

Pour définir toutes les assertions d'une action de dépendance sélectionnée comme dépendances, procédez comme suit:

  1. Dans votre espace de travail de développement, dans le volet Fichiers, développez definitions/.
  2. Sélectionnez un fichier SQLX d'action de workflow.

  3. Dans le fichier, définissez le paramètre includeDependentAssertions sur true de l'une des manières suivantes:

    Dans le bloc config

    config {
type: "ACTION_TYPE",
dependencies: [{name: "dEPENDENCY_ACTION_NAME", includeDependentAssertions: true}]
}

    Remplacez les éléments suivants :

    • ACTION_TYPE: type d'action de workflow : table, view ou operations.
    • DEPENDENCY_ACTION_NAME: nom de l'action de dépendance que vous souhaitez définir comme dépendances de l'action modifiée.

    Dans l'instruction SELECT

      config { type: "ACTION_TYPE" }

  SELECT * FROM ${ref({name: "DEPENDENCY_ACTION_NAME", includeDependentAssertions: true})}

    Remplacez les éléments suivants :

    • ACTION_TYPE: type d'action de workflow : table, view ou operations.
    • DEPENDENCY_ACTION_NAME: nom de l'action de dépendance que vous souhaitez définir comme dépendances de l'action modifiée.

  4. Facultatif: cliquez sur Format.

L'exemple de code suivant montre tableC qui dépend de viewA, tableB et de toutes les assertions de tableB:

// filename is tableC.sqlx

config {
type: "table",
dependencies: ["viewA", {name: "tableB", includeDependentAssertions: true}]
}

SELECT * FROM ...

Dans l'exemple de code précédent, Dataform ajoute automatiquement toutes les assertions directes de tableB en tant que dépendances à tableC lors de la compilation.

Définir les assertions de toutes les actions de dépendance comme dépendances

Pour exécuter une action de workflow uniquement lorsque toutes les assertions directes de toutes les actions de dépendance sont acceptées, définissez le paramètre dependOnDependencyAssertions sur true dans l'action modifiée. Dataform ajoute automatiquement des assertions directes d'actions de dépendance en tant que dépendances lors de la compilation. La valeur par défaut est false.

Lorsque vous définissez le paramètre dependOnDependencyAssertions et les paramètres includeDependentAssertions dans un seul fichier, le paramètre includeDependentAssertions est prioritaire pour l'action de dépendance pour laquelle il est défini.

Pour définir toutes les assertions d'une action de dépendance sélectionnée comme dépendances, procédez comme suit:

  1. Dans votre espace de travail de développement, dans le volet Fichiers, développez definitions/.
  2. Sélectionnez un fichier SQLX d'action de workflow.

  3. Dans le fichier, définissez le paramètre dependOnDependencyAssertions sur true au format suivant:

    config {
type: "ACTION_TYPE",
dependOnDependencyAssertions: true,
dependencies: [ "dependency1", "dependency2" ]
}

    Remplacez ACTION_TYPE: type de l'action du workflow. Les valeurs autorisées incluent table, view et operations.

  4. Facultatif: cliquez sur Format.

L'exemple de code suivant montre sometableE qui dépend de sometableA, sometabletableB, sometableC et sometableD, ainsi que toutes les assertions directes des tables de dépendances:

// filename is sometableE.sqlx

config {
type: "table",
dependOnDependencyAssertions: true,
dependencies: [ "sometableA", "sometableB" ]
}

SELECT * FROM ${ref("sometableC")}
SELECT * FROM ${ref("sometableD")}

Dans l'exemple de code précédent, Dataform ajoute automatiquement toutes les assertions directes de sometableA, sometableB, sometableC et sometableD en tant que dépendances à sometableE lors de la compilation.

Étape suivante