Ingérer des données depuis PayPal

info

Bêta

Cette fonctionnalité est en version bêta. Pour l’utiliser, un administrateur Workspace doit activer Lakeflow Connect pour PayPal sur la page Aperçus . Consultez Gérer les aperçus Databricks.

Cette page montre comment créer un pipeline d’ingestion PayPal managé à l’aide de Lakeflow Connect.

Configuration requise

• 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 nouvelle connexion, vous devez disposer des privilèges CREATE CONNECTION sur le metastore. 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. Toutefois, si les utilisateurs qui créent des pipelines utilisent une création de pipeline basée sur API ou ne sont pas des utilisateurs administrateurs, un administrateur doit d’abord créer la connexion dans Catalog Explorer. Voir Se connecter à des sources d’ingestion gérées.

  • Pour utiliser une connexion existante, vous devez disposer des privilèges USE CONNECTION ou 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 effectuer une ingestion depuis PayPal, configurez d'abord l'authentification depuis Databricks et créez une connexion. Consultez Configurer l'authentification à PayPal et Créer une connexion PayPal.

Options de connecteur

Définissez les options de portée du pipeline dans source_configurations. Voir Exemples pour l’utilisation.

Option	Champ d'application	Obligatoire	S'applique à	Description
start_datetime	Pipeline	Non	Toutes les tables incrémentielles (transaction, dispute, invoice)	Date et heure les plus anciennes à partir desquelles ingérer des données, au format yyyy-MM-ddTHH:mm:ssZ (par exemple, 2024-01-01T00:00:00Z). S’applique uniquement à la première synchronisation de chaque table ; les synchronisations ultérieures reprennent à partir du curseur stocké. Pour les default, consultez Options de connecteur.

Option	Champ d'application	Obligatoire	S'applique à	Description
start_datetime	Pipeline	Non	Toutes les tables incrémentielles (transaction, dispute, invoice)	Date et heure les plus anciennes à partir desquelles ingérer des données, au format yyyy-MM-ddTHH:mm:ssZ (par exemple, 2024-01-01T00:00:00Z). S’applique uniquement à la première synchronisation de chaque table ; les synchronisations ultérieures reprennent à partir du curseur stocké. Pour les default, consultez Options de connecteur.

Créer un pipeline d’ingestion

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

Databricks UI

1. Dans la barre latérale du workspace Databricks, cliquez sur Data Ingestion .
2. Sur la page Ajouter des données , sous Connecteurs Databricks , cliquez sur PayPal .
3. Sur la page Connexion de l'assistant d'ingestion, sélectionnez la connexion qui stocke vos identifiants PayPal. Si vous disposez du privilège CREATE CONNECTION sur le metastore, cliquez sur Créer une connexion pour créer une connexion avec les informations d’identification de la page Configurer l’authentification auprès de PayPal.
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 Créer un schéma 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 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 Créer un schéma dans le menu déroulant pour créer un schéma.
11. Cliquez sur Enregistrer et continuer .
12. (Facultatif) Sur la page Planifications et notifications , cliquez sur Créer une planification . Définissez la fréquence de refresh des tables de destination.
13. (Facultatif) Cliquez sur Ajouter une notification pour définir des notifications par e-mail en cas de réussite ou d'échec de l'opération du pipeline, puis cliquez sur Enregistrer et exécuter le pipeline .

Declarative Automation Bundles

Utilisez les Declarative Automation Bundles pour gérer les pipelines PayPal 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). Pour plus d'informations, consultez Que sont les 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/paypal_pipeline.yml). Voir pipeline.ingestion_definition et Exemples.
   • Un fichier de définition de job qui contrôle la fréquence d’ingestion des données (par exemple, resources/paypal_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 Workspace Databricks :

Ouvrir le notebook dans un nouvel ongletOuvrir dans Databricks

2. Laissez les cellules un et deux telles qu'elles sont. Ne pas modifier.

3. Modifiez la cellule trois avec les détails de configuration de votre pipeline. Consultez pipeline.ingestion_definition et Exemples.

4. Configurez éventuellement les paramètres avancés du pipeline. Voir Modèles courants pour les pipelines d'ingestion gérés.

5. Cliquez sur Tout exécuter .

Exemples

Le connecteur PayPal met à disposition six tables sources dans le schéma source default. Ingérer des tables individuelles ou le schéma entier.

Ingérer des tables spécifiques

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

Declarative Automation Bundles

Le fichier de définition de pipeline suivant ingère des tables PayPal individuelles :

YAML

resources:
  pipelines:
    paypal_pipeline:
      name: paypal_pipeline
      catalog: 'main'
      target: 'paypal_data'
      ingestion_definition:
        connection_name: paypal_connection
        objects:
          - table:
              source_schema: 'default'
              source_table: 'transaction'
              destination_catalog: 'main'
              destination_schema: 'paypal_data'
              destination_table: 'transaction'
          - table:
              source_schema: 'default'
              source_table: 'dispute'
              destination_catalog: 'main'
              destination_schema: 'paypal_data'
              destination_table: 'dispute'
          - table:
              source_schema: 'default'
              source_table: 'invoice'
              destination_catalog: 'main'
              destination_schema: 'paypal_data'
              destination_table: 'invoice'

Databricks notebook

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

Python

pipeline_name = "paypal_pipeline"
connection_name = "<paypal-connection>"
pipeline_spec = {
  "name": pipeline_name,
  "ingestion_definition": {
    "connection_name": connection_name,
    "objects": [
      {
        "table": {
          "source_schema": "default",
          "source_table": "transaction",
          "destination_catalog": "main",
          "destination_schema": "paypal_data",
          "destination_table": "transaction"
        }
      },
      {
        "table": {
          "source_schema": "default",
          "source_table": "dispute",
          "destination_catalog": "main",
          "destination_schema": "paypal_data",
          "destination_table": "dispute"
        }
      },
      {
        "table": {
          "source_schema": "default",
          "source_table": "invoice",
          "destination_catalog": "main",
          "destination_schema": "paypal_data",
          "destination_table": "invoice"
        }
      }
    ]
  }
}
json_payload = json.dumps(pipeline_spec, indent=2)
create_pipeline(json_payload)

Ingérer à partir d'une date de start spécifique

Utilisez l’option start_datetime pour contrôler jusqu’où les tables incrémentielles remontent lors de leur première synchronisation.

Declarative Automation Bundles

Le fichier de définition de pipeline suivant ingère des tables PayPal à partir d’une date de start spécifique :

YAML

resources:
  pipelines:
    paypal_pipeline:
      name: paypal_pipeline
      catalog: 'main'
      target: 'paypal_data'
      ingestion_definition:
        connection_name: paypal_connection
        source_configurations:
          - api_source_connector_config:
              configs:
                start_datetime: '<start-datetime>'
        objects:
          - table:
              source_schema: 'default'
              source_table: 'transaction'
              destination_catalog: 'main'
              destination_schema: 'paypal_data'
              destination_table: 'transaction'
          - table:
              source_schema: 'default'
              source_table: 'dispute'
              destination_catalog: 'main'
              destination_schema: 'paypal_data'
              destination_table: 'dispute'
          - table:
              source_schema: 'default'
              source_table: 'invoice'
              destination_catalog: 'main'
              destination_schema: 'paypal_data'
              destination_table: 'invoice'

Databricks notebook

La spécification de pipeline suivante ingère les tables PayPal à partir d'une date de start spécifique :

Python

pipeline_name = "paypal_pipeline"
connection_name = "<paypal-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": "transaction",
          "destination_catalog": "main",
          "destination_schema": "paypal_data",
          "destination_table": "transaction"
        }
      },
      {
        "table": {
          "source_schema": "default",
          "source_table": "dispute",
          "destination_catalog": "main",
          "destination_schema": "paypal_data",
          "destination_table": "dispute"
        }
      },
      {
        "table": {
          "source_schema": "default",
          "source_table": "invoice",
          "destination_catalog": "main",
          "destination_schema": "paypal_data",
          "destination_table": "invoice"
        }
      }
    ]
  }
}
json_payload = json.dumps(pipeline_spec, indent=2)
create_pipeline(json_payload)

Ingérer le schéma complet

Utilisez cette option pour ingérer toutes les tables source PayPal dans un seul schéma de destination avec une déclaration.

Declarative Automation Bundles

Le fichier de définition de pipeline suivant ingère toutes les tables PayPal prises en charge dans un schéma de destination :

YAML

resources:
  pipelines:
    paypal_pipeline:
      name: paypal_pipeline
      catalog: 'main'
      target: 'paypal_data'
      ingestion_definition:
        connection_name: paypal_connection
        objects:
          - schema:
              source_schema: 'default'
              destination_catalog: 'main'
              destination_schema: 'paypal_data'

Databricks notebook

La spécification de pipeline suivante ingère toutes les tables PayPal prises en charge dans un schéma de destination :

Python

pipeline_name = "paypal_pipeline"
connection_name = "<paypal-connection>"
pipeline_spec = {
  "name": pipeline_name,
  "ingestion_definition": {
    "connection_name": connection_name,
    "objects": [
      {
        "schema": {
          "source_schema": "default",
          "destination_catalog": "main",
          "destination_schema": "paypal_data"
        }
      }
    ]
  }
}
json_payload = json.dumps(pipeline_spec, indent=2)
create_pipeline(json_payload)

Fichier de définition de job Declarative Automation Bundles

Ce qui suit est 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:
    paypal_job:
      name: paypal_job
      schedule:
        quartz_cron_expression: '0 0 0 * * ?'
        timezone_id: 'UTC'
      tasks:
        - task_key: paypal_ingestion
          pipeline_task:
            pipeline_id: ${resources.pipelines.paypal_pipeline.id}

Modèles courants

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

Étapes suivantes

Start, planifiez et définissez des alertes sur votre pipeline. Consultez Tâches courantes de maintenance du pipeline.

Ressources supplémentaires

• FAQ du connecteur PayPal
• Limitations du connecteur PayPal
• Référence du connecteur PayPal
• Dépanner le connecteur PayPal