Déclarer une source de données

Ce document explique comment déclarer des sources de données BigQuery avec Dataform Core.

Vous pouvez déclarer n'importe quel type de table BigQuery en tant que source de données dans Dataform. Déclarer des sources de données BigQuery externes à Dataform vous permet de les traiter comme des objets Dataform de première classe. Après avoir déclaré une source de données, vous pouvez la référencer ou la résoudre de la même manière que toute autre table dans Dataform.

Avant de commencer

Avant de déclarer une source de données, créez et initialisez un espace de travail de développement dans votre dépôt.

Rôles requis

Afin d'obtenir les autorisations dont vous avez besoin pour déclarer une source de données, demandez à votre administrateur de vous attribuer 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 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.

Créer un fichier SQLX pour la déclaration de la source de données

Stockez les fichiers SQLX pour les déclarations de source de données dans le répertoire definitions/. Pour créer un fichier SQLX dans le répertoire definitions/, procédez comme suit:

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

    Accéder à la page Dataform

  2. Sélectionnez un dépôt.

  3. Sélectionnez un espace de travail de développement.

  4. Dans le volet Fichiers, à côté de definitions/, cliquez sur le menu Plus.

  5. Cliquez sur Créer un fichier.

  6. Dans le volet Create new file (Créer un fichier), procédez comme suit:

    1. Dans le champ Ajouter un chemin d'accès au fichier, après definitions/, saisissez le nom du fichier suivi de .sqlx. Par exemple, definitions/dataset-declaration.sqlx.

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

    2. Cliquez sur Créer un fichier.

Déclarer une source de données

Vous pouvez déclarer une source de données par fichier de déclaration SQLX. Pour déclarer une source de données dans le bloc de configuration d'un fichier SQLX, procédez comme suit:

  1. Dans votre espace de travail de développement, dans le volet Fichiers, cliquez sur votre fichier SQLX pour la déclaration de la source de données.

  2. Dans le fichier, saisissez l'extrait de code suivant :

    config {
  type: "declaration",
  database: "DATABASE",
  schema: "SCHEMA",
  name: "NAME",
}

    Remplacez les éléments suivants :

    • DATABASE: ID du projet contenant la source de données.
    • SCHEMA: ensemble de données BigQuery dans lequel existe la source de données.
    • NAME: nom de la table ou de la vue que vous souhaitez utiliser comme source de données. Vous pouvez ensuite utiliser ce nom pour référencer la source de données dans Dataform.

  3. (Facultatif) Cliquez sur Format.

L'exemple de code suivant montre un exemple de déclaration de la table shakespeare dans l'ensemble de données samples du projet bigquery-public-data en tant que source de données:

    config {
      type: "declaration",
      database: "bigquery-public-data",
      schema: "samples",
      name: "shakespeare",
    }

Étapes suivantes