Ingérer des données depuis Google Workspace

info

Beta

Cette fonctionnalité est en version Bêta. Les administrateurs du workspace peuvent contrôler l’accès à cette fonctionnalité à partir de la page Previews . Consultez Gérer les aperçus Databricks.

Cette page indique comment créer un pipeline d'ingestion Google Workspace géré à l'aide de Lakeflow Connect.

Prérequis

• Pour créer un pipeline d'ingestion, remplissez d'abord les conditions suivantes :

  • Votre workspace doit être activé pour Unity Catalog.

  • Le compute serverless doit être activé pour votre workspace. Voir les exigences du compute serverless.

  • Pour créer une connexion, vous devez disposer des privilèges CREATE CONNECTION sur le métastore. Consultez Gérer les privilèges dans Unity Catalog.

    Si le connecteur prend en charge la création de pipelines basée sur l’interface utilisateur, un administrateur peut créer la connexion et le pipeline en même temps en suivant les étapes de cette page. Toutefois, si les utilisateurs qui créent des pipelines utilisent la création de pipelines par API ou ne sont pas des administrateurs, un administrateur doit d'abord créer la connexion dans Catalog Explorer. See Connect to managed ingestion sources.

  • Pour utiliser une connexion existante, vous devez disposer des privilèges USE CONNECTION ou de ALL PRIVILEGES sur l’objet de connexion.

  • Vous devez disposer des privilèges USE CATALOG sur le catalogue cible.

  • Vous devez disposer des privilèges USE SCHEMA et CREATE TABLE sur un schéma existant ou des privilèges CREATE SCHEMA sur le catalogue cible.

• Pour procéder à l’ingestion à partir de Google Workspace, configurez d’abord l’authentification depuis Databricks et créez une connexion. Consultez Configurer l’authentification pour Google Workspace et Créer une connexion Google Workspace.

Créer un pipeline d’ingestion

Le connecteur Google Workspace ingère 33 tables sources, une pour chaque application d’activité Google Workspace, sous le schéma source default. Pour plus de détails, consultez Supported source tables.

Databricks UI

1. Dans la barre latérale du workspace Databricks, cliquez sur Data Ingestion .
2. Sur la page Add data , sous Databricks connectors , cliquez sur Google Workspace .
3. Sur la page Connection de l’assistant d’ingestion, sélectionnez la connexion qui stocke vos identifiants Google Workspace. Si vous disposez du privilège CREATE CONNECTION sur le métastore, cliquez sur Create connection pour créer une connexion avec les identifiants de la page Configure authentication to Google Workspace.
4. Cliquez sur Suivant .
5. Sur la page Ingestion setup , saisissez un nom pour le pipeline.
6. Sélectionnez un catalogue et un schéma dans lesquels écrire les logs d’événements. Si vous disposez des privilèges USE CATALOG et CREATE SCHEMA sur le catalogue, cliquez sur Create schema dans le menu déroulant pour créer un schéma.
7. Cliquez sur Créer un pipeline et continuer .
8. Sur la page Source , sélectionnez une ou plusieurs tables d’application d’activité à ingérer (par exemple, calendar, chat, admin). L’interface utilisateur répertorie 30 applications ; pour ingérer login, groups ou groups_enterprise, utilisez plutôt l’option Declarative Automation Bundles ou Databricks notebook .
9. Cliquez sur Enregistrer et continuer .
10. Sur la page Destination , sélectionnez un catalogue et un schéma dans lesquels charger les données. Si vous disposez des privilèges USE CATALOG et CREATE SCHEMA sur le catalogue, cliquez sur Create schema dans le menu déroulant pour créer un schéma.
11. Cliquez sur Enregistrer et continuer .
12. (Facultatif) Sur la page Schedules and notifications , cliquez sur Create schedule . Définissez la fréquence de refresh des tables de destination.
13. (Optionnel) Cliquez sur Ajouter une notification pour configurer des notifications par e-mail en cas de succès ou d'échec d'une opération du pipeline, puis cliquez sur Enregistrer et exécuter le pipeline .

Declarative Automation Bundles

Use Declarative Automation Bundles to manage Google Workspace pipelines as code. Bundles can contain YAML definitions of jobs and tasks, are managed using the Databricks CLI, and can be shared and run in different target workspaces (such as development, staging, and production). For more information, see What are Declarative Automation Bundles?.

1. Créez un bundle à l’aide de la CLI Databricks :

   Bash

   databricks bundle init

2. Ajoutez deux nouveaux fichiers de ressources au bundle :

   • Un fichier de définition de pipeline (par exemple, resources/google_workspace_pipeline.yml). Consultez pipeline.ingestion_definition et Exemples.
   • Un fichier de définition de job qui contrôle la fréquence de l’ingestion des données (par exemple, resources/google_workspace_job.yml).

3. Déployez le pipeline à l’aide de la CLI Databricks :

   Bash

   databricks bundle deploy

Databricks notebook

1. Import the following notebook into your Databricks workspace:

Ouvrir le notebook dans un nouvel ongletOuvrir dans Databricks

2. Laissez les cellules un et deux telles quelles. Ne pas modifier.

3. Modifiez la troisième cellule avec les détails de configuration de votre pipeline. Voir pipeline.ingestion_definition et Exemples.

4. Configurez éventuellement les paramètres avancés du pipeline. Consultez Common patterns for managed ingestion pipelines.

5. Cliquez sur Tout exécuter .

Exemples

Le connecteur Google Workspace met à disposition 33 tables dans le schéma source default, une pour chaque application d'activité. For details, see Supported source tables.

Ingérer les tables d'application d'activité

Declarative Automation Bundles

Le fichier de définition de pipeline suivant ingère les tables d'activité Google Workspace :

YAML

resources:
  pipelines:
    google_workspace_pipeline:
      name: google_workspace_pipeline
      catalog: 'main'
      target: 'google_workspace_data'
      ingestion_definition:
        connection_name: google_workspace_connection
        objects:
          - table:
              source_schema: 'default'
              source_table: 'calendar'
              destination_catalog: 'main'
              destination_schema: 'google_workspace_data'
              destination_table: 'calendar'
          - table:
              source_schema: 'default'
              source_table: 'chat'
              destination_catalog: 'main'
              destination_schema: 'google_workspace_data'
              destination_table: 'chat'
          - table:
              source_schema: 'default'
              source_table: 'admin'
              destination_catalog: 'main'
              destination_schema: 'google_workspace_data'
              destination_table: 'admin'

Databricks notebook

La spécification de pipeline suivante ingère les tables d'activité Google Workspace :

Python

pipeline_name = "google_workspace_pipeline"
connection_name = "<google-workspace-connection>"
pipeline_spec = {
  "name": pipeline_name,
  "ingestion_definition": {
    "connection_name": connection_name,
    "objects": [
      {
        "table": {
          "source_schema": "default",
          "source_table": "calendar",
          "destination_catalog": "main",
          "destination_schema": "google_workspace_data",
          "destination_table": "calendar"
        }
      },
      {
        "table": {
          "source_schema": "default",
          "source_table": "chat",
          "destination_catalog": "main",
          "destination_schema": "google_workspace_data",
          "destination_table": "chat"
        }
      },
      {
        "table": {
          "source_schema": "default",
          "source_table": "admin",
          "destination_catalog": "main",
          "destination_schema": "google_workspace_data",
          "destination_table": "admin"
        }
      }
    ]
  }
}
json_payload = json.dumps(pipeline_spec, indent=2)
create_pipeline(json_payload)

Fichier de définition de job Declarative Automation Bundles

L’exemple suivant est un fichier de définition de job destiné à être utilisé avec Declarative Automation Bundles. Le job s’exécute quotidiennement.

Declarative Automation Bundles

YAML

resources:
  jobs:
    google_workspace_job:
      name: google_workspace_job
      schedule:
        quartz_cron_expression: '0 0 0 * * ?'
        timezone_id: 'UTC'
      tasks:
        - task_key: google_workspace_ingestion
          pipeline_task:
            pipeline_id: ${resources.pipelines.google_workspace_pipeline.id}

Modèles courants

Pour les configurations de pipeline avancées, voir Common patterns for managed ingestion pipelines.

Étapes suivantes

start, planifiez et configurez des alertes sur votre pipeline. Consultez Common pipeline maintenance tasks.

Ressources supplémentaires

• FAQ sur le connecteur Google Workspace
• Limitations du connecteur Google Workspace
• Référence du connecteur Google Workspace
• Résoudre les problèmes liés au connecteur Google Workspace