Ingérer des données depuis GitLab

info

Bêta

Cette fonctionnalité est en bêta. Pour l'utiliser, un administrateur du workspace doit activer Lakeflow Connect pour GitLab depuis la page Prévisualisations . Consultez Gérer les aperçus Databricks.

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

Prérequis

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

  • Votre workspace doit prendre en charge Unity Catalog.

  • Le compute serverless doit être activé pour votre workspace. Consultez Serverless compute requirements.

  • Pour créer une nouvelle connexion, vous devez disposer des privilèges CREATE CONNECTION sur le métastore. Voir 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 effectuant les étapes de cette page. Cependant, si les utilisateurs qui créent des pipelines utilisent une création de pipeline basée sur l’API ou ne sont pas administrateurs, un administrateur doit d’abord créer la connexion dans Catalog Explorer. Voir 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 ingérer des données à partir de GitLab, configurez d’abord l’authentification depuis Databricks et créez une connexion. Consultez la page Configurer l’authentification pour GitLab et Créer une connexion GitLab.

Options du connecteur

Définissez des options étendues au pipeline dans source_configurations. Consultez la section Exemples pour en savoir plus sur l’utilisation.

Option	Portée	Obligatoire	S’applique à	Description
start_datetime	Pipeline	Non	Toutes les tables incrémentielles	Le timestamp d’enregistrement le plus ancien à ingérer lors de la première synchronisation, au format yyyy-MM-dd'T'HH:mm:ss.SSS'Z'. Pour la valeur par default, voir Connector options.

Option	Portée	Obligatoire	S’applique à	Description
start_datetime	Pipeline	Non	Toutes les tables incrémentielles	Le timestamp d’enregistrement le plus ancien à ingérer lors de la première synchronisation, au format yyyy-MM-dd'T'HH:mm:ss.SSS'Z'. Pour la valeur par default, voir Connector options.

Créer un pipeline d’ingestion

Pour obtenir la liste des tables sources prises en charge, consultez la page Tables sources prises en charge.

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 GitLab .
3. Sur la page Connection de l’assistant d’ingestion, sélectionnez la connexion qui stocke vos identifiants GitLab. 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 Configurer l’authentification pour GitLab.
4. Cliquez sur Suivant .
5. Sur la page Ingestion setup , entrez un nom pour le pipeline.
6. Sélectionnez un catalogue et un schéma dans lesquels écrire des 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.
7. Cliquez sur Create pipeline and continue .
8. Sur la page Source , sélectionnez les tables à ingérer.
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. (Optionnel) Sur la page Schedules and notifications , cliquez sur Create schedule . Définissez la fréquence pour refresh les tables de destination.
13. (Optionnel) Cliquez sur Add notification pour configurer les notifications par e-mail en cas de réussite ou d’échec d’une opération de pipeline, puis cliquez sur Save and run pipeline .

Declarative Automation Bundles

Utilisez les Declarative Automation Bundles pour gérer les pipelines GitLab en tant que code. Les bundles peuvent contenir des définitions YAML de jobs et de tâches, sont gérés à l’aide de la CLI Databricks et peuvent être partagés et exécutés dans différents Workspace cibles (tels que le développement, la pré-production et la production). Voir What are Declarative Automation Bundles ?.

1. Créer 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/gitlab_pipeline.yml). Voir pipeline.ingestion_definition et Exemples.
   • Un fichier de définition du job qui contrôle la fréquence d’ingestion des données (par exemple, resources/gitlab_job.yml).

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

   Bash

   databricks bundle deploy

Databricks notebook

1. Importez le notebook suivant dans votre Workspace Databricks :

Ouvrir le notebook dans un nouvel ongletOuvrir dans Databricks

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

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

4. Configurez éventuellement les paramètres avancés du pipeline. Consultez la page Modèles courants de pipelines d’ingestion gérés.

5. Cliquez sur Tout exécuter .

Exemples

Le connecteur GitLab met 28 tables source à disposition dans le schéma source default. Les exemples suivants permettent d'ingérer des tables spécifiques.

Ingérer des tables spécifiques

Utilisez cette option pour ingérer un sous-ensemble spécifique de tables ou pour personnaliser la désignation de la destination par table.

Declarative Automation Bundles

Le fichier de définition de pipeline suivant ingère les tables GitLab individuelles :

YAML

resources:
  pipelines:
    gitlab_pipeline:
      name: gitlab_pipeline
      catalog: 'main'
      target: 'gitlab_data'
      ingestion_definition:
        connection_name: gitlab_connection
        source_configurations:
          - api_source_connector_config:
              configs:
                start_datetime: '<start-datetime>'
        objects:
          - table:
              source_schema: 'default'
              source_table: 'projects'
              destination_catalog: 'main'
              destination_schema: 'gitlab_data'
              destination_table: 'projects'
          - table:
              source_schema: 'default'
              source_table: 'issues'
              destination_catalog: 'main'
              destination_schema: 'gitlab_data'
              destination_table: 'issues'
          - table:
              source_schema: 'default'
              source_table: 'merge_requests'
              destination_catalog: 'main'
              destination_schema: 'gitlab_data'
              destination_table: 'merge_requests'
          - table:
              source_schema: 'default'
              source_table: 'commits'
              destination_catalog: 'main'
              destination_schema: 'gitlab_data'
              destination_table: 'commits'

Databricks notebook

La spécification de pipeline suivante ingère des tables GitLab individuelles :

Python

pipeline_name = "gitlab_pipeline"
connection_name = "<gitlab-connection>"
pipeline_spec = {
  "name": pipeline_name,
  "ingestion_definition": {
    "connection_name": connection_name,
    "source_configurations": [
      {
        "api_source_connector_config": {
          "configs": {
            "start_datetime": "<start-datetime>"
          }
        }
      }
    ],
    "objects": [
      {
        "table": {
          "source_schema": "default",
          "source_table": "projects",
          "destination_catalog": "main",
          "destination_schema": "gitlab_data",
          "destination_table": "projects"
        }
      },
      {
        "table": {
          "source_schema": "default",
          "source_table": "issues",
          "destination_catalog": "main",
          "destination_schema": "gitlab_data",
          "destination_table": "issues"
        }
      },
      {
        "table": {
          "source_schema": "default",
          "source_table": "merge_requests",
          "destination_catalog": "main",
          "destination_schema": "gitlab_data",
          "destination_table": "merge_requests"
        }
      },
      {
        "table": {
          "source_schema": "default",
          "source_table": "commits",
          "destination_catalog": "main",
          "destination_schema": "gitlab_data",
          "destination_table": "commits"
        }
      }
    ]
  }
}
json_payload = json.dumps(pipeline_spec, indent=2)
create_pipeline(json_payload)

Fichier de définition de job Declarative Automation Bundles

Voici un exemple de fichier de définition de job à utiliser avec les Declarative Automation Bundles. Le job s’exécute quotidiennement.

Declarative Automation Bundles

YAML

resources:
  jobs:
    gitlab_job:
      name: gitlab_job
      schedule:
        quartz_cron_expression: '0 0 0 * * ?'
        timezone_id: 'UTC'
      tasks:
        - task_key: gitlab_ingestion
          pipeline_task:
            pipeline_id: ${resources.pipelines.gitlab_pipeline.id}

Modèles courants

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

Étapes suivantes

Start, planifiez et configurez des alertes sur votre pipeline. Consultez les tâches courantes de maintenance du pipeline.

Ressources supplémentaires

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