Ingérer des données depuis Confluence

Découvrez comment créer un pipeline d'ingestion Confluence géré à l'aide de Databricks Lakeflow Connect.

Exigences

• Pour créer un pipeline d'ingestion, vous devez d'abord satisfaire aux exigences suivantes :

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

  • Le compute Serverless doit être activé pour votre Workspace. Consultez les exigences du compute Serverless.

  • 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 suivant les étapes décrites sur cette page. Cependant, si les utilisateurs qui créent des pipelines utilisent la création de pipelines basée sur l'API ou ne sont pas des utilisateurs administrateurs, un administrateur doit d'abord créer la connexion dans l'Explorateur de catalogues. Voir Connexion aux sources d'ingestion gérées.

  • Pour utiliser une connexion existante, vous devez avoir les privilèges USE CONNECTION ou ALL PRIVILEGES sur l'objet de connexion.

  • Vous devez disposer de 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 depuis Confluence, vous devez d'abord suivre les étapes de Créer une connexion Confluence.

Créez un pipeline d'ingestion

Chaque table source est ingérée dans une table de streaming. Pour une liste des tables source prises en charge, consultez Données prises en charge.

Databricks UI

1. Dans la barre latérale du workspace Databricks, cliquez sur Ingestion de données .
2. Sur la page Ajouter des données , sous Connecteurs Databricks , cliquez sur Confluence .
3. Sur la page **Connexion** de l'assistant d'ingestion, sélectionnez la connexion qui stocke vos informations d'identification d'accès à Confluence. Si vous disposez du CREATE CONNECTION privilège sur le metastore, vous pouvez cliquer sur ** Créer une connexion** pour créer une nouvelle connexion avec les détails d'authentification dans Créer une connexion Confluence.
4. Cliquez sur Suivant .
5. Sur la page **Configuration de l'ingestion**, saisissez un nom unique pour le pipeline.
6. Sélectionnez un catalogue et un schéma pour écrire les Logs d'événements. Si vous disposez des privilèges USE CATALOG et CREATE SCHEMA sur le catalogue, vous pouvez cliquer sur Créer un schéma dans le menu déroulant pour créer un nouveau schéma.
7. Cliquez sur Créer un pipeline et continuer .
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 des données. Si vous disposez des privilèges USE CATALOG et CREATE SCHEMA sur le catalogue, vous pouvez cliquer sur Créer un schéma dans le menu déroulant pour créer un nouveau schéma.
11. Cliquez sur Enregistrer et continuer .
12. (Facultatif) Sur la page Schedules and notifications , cliquez sur Créer un calendrier . Définissez la fréquence pour refresh les tables de destination.
13. (Facultatif) Cliquez sur Ajouter une notification pour définir les notifications par e-mail en cas de succès ou d'échec de l'opération du pipeline, puis cliquez sur Enregistrer et exécuter le pipeline .

Declarative Automation Bundles

Utilisez des Declarative Automation Bundles pour gérer les pipelines Confluence sous forme de code. Les bundles peuvent contenir des définitions YAML de jobs et de tâches, sont gérés à l’aide de la Databricks CLI, et peuvent être partagés et exécutés dans différents Workspace cibles (comme le développement, la pré-production et la production). Pour plus d'informations, consultez 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/confluence_pipeline.yml). Voir pipeline.ingestion_definition et Exemples.
   • Un fichier de définition de Job qui contrôle la fréquence d'ingestion de données (par exemple, resources/confluence_job.yml).

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

   Bash

   databricks bundle deploy

Databricks notebook

1. Importez le notebook suivant dans votre Databricks Workspace :

Ouvrir le notebook dans un nouvel ongletOuvrir dans Databricks

2. Laisser la cellule un telle quelle.

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

4. Cliquez sur Tout exécuter .

Exemples

Utilisez ces exemples pour configurer votre pipeline.

Ingérer une seule table source

Declarative Automation Bundles

Le fichier de définition de pipeline suivant ingère une seule table source :

YAML

variables:
  dest_catalog:
    default: main
  dest_schema:
    default: ingest_destination_schema

# The main pipeline for confluence_dab
resources:
  pipelines:
    pipeline_confluence:
      name: confluence_pipeline
      catalog: ${var.dest_catalog}
      schema: ${var.dest_schema}
      ingestion_definition:
        connection_name: <confluence-connection>
        objects:
          # An array of objects to ingest from Confluence. This example ingests the pages table.
          - table:
              source_schema: default
              source_table: pages
              destination_catalog: ${var.dest_catalog}
              destination_schema: ${var.dest_schema}

Databricks notebook

Voici un exemple de spécification de pipeline qui ingère une seule table source :

Python

pipeline_spec = """
{
  "name": "<pipeline-name>",
  "ingestion_definition": {
    "connection_name": "<confluence-connection>",
    "objects": [
      {
        "table": {
          "source_schema": "default",
          "source_table": "pages",
          "destination_catalog": "main",
          "destination_schema": "ingest_destination_schema"
        }
      }
    ]
  },
  "channel": "PREVIEW"
}
"""
create_pipeline(pipeline_spec)

Ingérer plusieurs tables sources

Declarative Automation Bundles

Le fichier de définition de pipeline suivant ingère plusieurs tables source :

YAML

variables:
  dest_catalog:
    default: main
  dest_schema:
    default: ingest_destination_schema

# The main pipeline for confluence_dab
resources:
  pipelines:
    pipeline_confluence:
      name: confluence_pipeline
      catalog: ${var.dest_catalog}
      schema: ${var.dest_schema}
      ingestion_definition:
        connection_name: <confluence-connection>
        objects:
          # An array of objects to ingest from Confluence. This example ingests the pages and blogposts tables.
          - table:
              source_schema: default
              source_table: pages
              destination_catalog: ${var.dest_catalog}
              destination_schema: ${var.dest_schema}
          - table:
              source_schema: default
              source_table: blogposts
              destination_catalog: ${var.dest_catalog}
              destination_schema: ${var.dest_schema}

Databricks notebook

Voici un exemple de spécification de pipeline qui ingère plusieurs tables source :

Python

pipeline_spec = """
{
  "name": "<pipeline-name>",
  "ingestion_definition": {
    "connection_name": "<confluence-connection>",
    "objects": [
      {
        "table": {
          "source_schema": "default",
          "source_table": "pages",
          "destination_catalog": "main",
          "destination_schema": "ingest_destination_schema"
        }
      },
      {
        "table": {
          "source_schema": "default",
          "source_table": "blogposts",
          "destination_catalog": "main",
          "destination_schema": "ingest_destination_schema"
        }
      }
    ]
  },
  "channel": "PREVIEW"
}
"""
create_pipeline(pipeline_spec)

Fichier de définition de job Declarative Automation Bundles

Declarative Automation Bundles

Voici un exemple de fichier de définition de job à utiliser avec les Declarative Automation Bundles. Le job s'exécute tous les jours, exactement un jour après la dernière exécution.

YAML

resources:
  jobs:
    confluence_dab_job:
      name: confluence_dab_job

      trigger:
        periodic:
          interval: 1
          unit: DAYS

      email_notifications:
        on_failure:
          - <email-address>

      tasks:
        - task_key: refresh_pipeline
          pipeline_task:
            pipeline_id: ${resources.pipelines.pipeline_confluence.id}

Filtrer par espace

Vous pouvez filtrer les données ingérées vers des espaces de Confluence spécifiques en ajoutant connector_options.confluence_options à n'importe quel objet de table dans votre définition de pipeline. Spécifiez les clés d'espace exactes dans include_confluence_spaces. Les clés d'espace sont sensibles à la casse et sont différentes des noms d'espace.

Pour trouver votre clé d’espace, accédez à n’importe quelle page dans l’espace et vérifiez l’URL. Il s’agit du court identifiant qui suit /space/ ou /display/. Vous pouvez également accéder à Space tools > Overview > Space details pour afficher la clé.

Pour plus d'informations, veuillez consulter Space Keys dans la documentation Confluence.

remarque

Le filtrage spatial n'est pas pris en charge pour les tables labels et attachments. L'API Confluence n'identifie pas de quel espace proviennent ces objets, donc include_confluence_spaces est ignoré lorsque labels ou attachments est ingéré.

Declarative Automation Bundles

YAML

- table:
    source_schema: default
    source_table: pages
    destination_catalog: ${var.dest_catalog}
    destination_schema: ${var.dest_schema}
    connector_options:
      confluence_options:
        include_confluence_spaces:
          - KEY1
          - KEY2

Databricks notebook

Python

pipeline_spec = """
{
  "name": "<pipeline-name>",
  "ingestion_definition": {
    "connection_name": "<confluence-connection>",
    "objects": [
      {
        "table": {
          "source_schema": "default",
          "source_table": "pages",
          "destination_catalog": "main",
          "destination_schema": "ingest_destination_schema",
          "connector_options": {
            "confluence_options": {
              "include_confluence_spaces": ["KEY1", "KEY2"]
            }
          }
        }
      }
    ]
  }
}
"""
create_pipeline(pipeline_spec)

Modèles courants

Pour les configurations de pipeline avancées, consultez Modèles courants pour les pipelines d'ingestion gérés.

Étapes suivantes

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

Ressources supplémentaires

• FAQ du connecteur Confluence
• Limites du connecteur Confluence
• Référence du connecteur Confluence
• Dépanner l'ingestion Confluence