Ingérer des données depuis QuickBooks

info

Bêta

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

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

Configuration requise

Pour créer un pipeline d’ingestion, répondez d’abord aux exigences 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. Consultez Gérer les privilèges dans Unity Catalog.
  
  Si le connecteur prend en charge la création de pipelines via l'interface utilisateur, un administrateur peut créer la connexion et le pipeline en même temps en suivant les étapes de cette page. Cependant, 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 l'Explorateur de catalogues. Consultez Connexion aux sources d'ingestion managé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 des privilèges USE CATALOG sur le catalogue cible.
- Vous devez avoir les privilèges USE SCHEMA et CREATE TABLE sur un schéma existant ou les privilèges CREATE SCHEMA sur le catalogue cible.
Pour ingérer des données depuis QuickBooks, configurez d'abord l'authentification depuis Databricks et créez une connexion. Voir Configurer l'authentification à QuickBooks et Créer une connexion QuickBooks.

Options du connecteur

Définissez des options étendues au pipeline dans source_configurations. Voir les exemples pour l'utilisation.

Option	Portée	Obligatoire	S'applique à	Description
`start_datetime`	Pipeline	Non	Toutes les tables incrémentielles	Date et heure les plus anciennes à partir desquelles les données doivent être ingérées, au format `yyyy-MM-ddTHH:mm:ssXXX` (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 les Options du connecteur.

Option	Portée	Obligatoire	S'applique à	Description
`start_datetime`	Pipeline	Non	Toutes les tables incrémentielles	Date et heure les plus anciennes à partir desquelles les données doivent être ingérées, au format `yyyy-MM-ddTHH:mm:ssXXX` (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 les Options du connecteur.

Créer un pipeline d'ingestion

Pour consulter la liste des tables source prises en charge, reportez-vous à la section Tables source prises en charge.

Databricks UI
Declarative Automation Bundles
Databricks notebook

Dans la barre latérale du workspace Databricks, cliquez sur Data Ingestion .
Sur la page Add data , sous Databricks connectors , cliquez sur QuickBooks .
Sur la page Connexion de l’assistant d’ingestion, sélectionnez la connexion qui stocke vos identifiants QuickBooks. Si vous disposez du privilège CREATE CONNECTION sur le metastore, cliquez sur Créer une connexion pour créer une connexion avec les identifiants de Configurer l’authentification à QuickBooks.
Cliquez sur Suivant .
Sur la page Configuration de l'ingestion , saisissez un nom pour le pipeline.
Sélectionnez un catalogue et un schéma vers lesquels écrire les logs d’événement. 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.
Cliquez sur Créer un pipeline et continuer .
Sur la page Source , sélectionnez les tables à ingérer.
Cliquez sur Enregistrer et continuer .
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.
Cliquez sur Enregistrer et continuer .
(Facultatif) Sur la page Planifications et notifications , cliquez sur Créer une planification . Définissez la fréquence de refresh des tables de destination.
(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 de pipeline, puis cliquez sur Enregistrer et exécuter le pipeline .

Utilisez les Declarative Automation Bundles pour gérer les pipelines QuickBooks 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 ?.

Créer un bundle à l'aide de la CLI Databricks :
Bash
```
databricks bundle init
```
Ajoutez deux nouveaux fichiers de ressources au bundle :
- Un fichier de définition de pipeline (par exemple, resources/quickbooks_pipeline.yml). Voir pipeline.ingestion_definition et Exemples.
- Un fichier de définition de job qui contrôle la fréquence de l'ingestion de données (par exemple, resources/quickbooks_job.yml).
Déployez le pipeline à l'aide de la CLI Databricks :
Bash
```
databricks bundle deploy
```

Exemples

Le connecteur QuickBooks met à disposition 37 tables source dans le schéma source default. Spécifiez chaque table que vous souhaitez ingérer.

Ingérer des tables spécifiques

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

Declarative Automation Bundles
Databricks notebook

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

YAML
resources:
  pipelines:
    quickbooks_pipeline:
      name: quickbooks_pipeline
      catalog: 'main'
      target: 'quickbooks_data'
      ingestion_definition:
        connection_name: quickbooks_connection
        objects:
          - table:
              source_schema: 'default'
              source_table: 'invoice'
              destination_catalog: 'main'
              destination_schema: 'quickbooks_data'
              destination_table: 'invoice'
          - table:
              source_schema: 'default'
              source_table: 'customer'
              destination_catalog: 'main'
              destination_schema: 'quickbooks_data'
              destination_table: 'customer'
          - table:
              source_schema: 'default'
              source_table: 'payment'
              destination_catalog: 'main'
              destination_schema: 'quickbooks_data'
              destination_table: 'payment'

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

Python
pipeline_name = "quickbooks_pipeline"
connection_name = "<quickbooks-connection>"
pipeline_spec = {
  "name": pipeline_name,
  "ingestion_definition": {
    "connection_name": connection_name,
    "objects": [
      {
        "table": {
          "source_schema": "default",
          "source_table": "invoice",
          "destination_catalog": "main",
          "destination_schema": "quickbooks_data",
          "destination_table": "invoice"
        }
      },
      {
        "table": {
          "source_schema": "default",
          "source_table": "customer",
          "destination_catalog": "main",
          "destination_schema": "quickbooks_data",
          "destination_table": "customer"
        }
      },
      {
        "table": {
          "source_schema": "default",
          "source_table": "payment",
          "destination_catalog": "main",
          "destination_schema": "quickbooks_data",
          "destination_table": "payment"
        }
      }
    ]
  }
}
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 la distance de lecture des tables incrémentielles lors de leur première synchronisation.

Declarative Automation Bundles
Databricks notebook

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

YAML
resources:
  pipelines:
    quickbooks_pipeline:
      name: quickbooks_pipeline
      catalog: 'main'
      target: 'quickbooks_data'
      ingestion_definition:
        connection_name: quickbooks_connection
        source_configurations:
          - api_source_connector_config:
              configs:
                start_datetime: '<start-datetime>'
        objects:
          - table:
              source_schema: 'default'
              source_table: 'invoice'
              destination_catalog: 'main'
              destination_schema: 'quickbooks_data'
              destination_table: 'invoice'
          - table:
              source_schema: 'default'
              source_table: 'customer'
              destination_catalog: 'main'
              destination_schema: 'quickbooks_data'
              destination_table: 'customer'
          - table:
              source_schema: 'default'
              source_table: 'payment'
              destination_catalog: 'main'
              destination_schema: 'quickbooks_data'
              destination_table: 'payment'

La spécification de pipeline suivante ingère des tables QuickBooks à partir d’une date de start spécifique :

Python
pipeline_name = "quickbooks_pipeline"
connection_name = "<quickbooks-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": "invoice",
          "destination_catalog": "main",
          "destination_schema": "quickbooks_data",
          "destination_table": "invoice"
        }
      },
      {
        "table": {
          "source_schema": "default",
          "source_table": "customer",
          "destination_catalog": "main",
          "destination_schema": "quickbooks_data",
          "destination_table": "customer"
        }
      },
      {
        "table": {
          "source_schema": "default",
          "source_table": "payment",
          "destination_catalog": "main",
          "destination_schema": "quickbooks_data",
          "destination_table": "payment"
        }
      }
    ]
  }
}
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 Declarative Automation Bundles. Le job s'exécute quotidiennement.

Declarative Automation Bundles

YAML
resources:
  jobs:
    quickbooks_job:
      name: quickbooks_job
      schedule:
        quartz_cron_expression: '0 0 0 * * ?'
        timezone_id: 'UTC'
      tasks:
        - task_key: quickbooks_ingestion
          pipeline_task:
            pipeline_id: ${resources.pipelines.quickbooks_pipeline.id}

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 définissez des alertes sur votre pipeline. Voir Tâches de maintenance courantes du pipeline.

Configuration requise​

Options du connecteur​

Créer un pipeline d'ingestion​

Exemples​

Ingérer des tables spécifiques​

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

Fichier de définition de job Declarative Automation Bundles​

Modèles courants​

Étapes suivantes​

Ressources supplémentaires​