Ingérer des données à partir de Xero

info

Bêta

Cette fonctionnalité est en bêta. Pour l’utiliser, un administrateur de workspace doit activer Lakeflow Connect for Xero depuis la page Previews . Consultez Gérer les aperçus Databricks.

Créer un pipeline Lakeflow Connect managé qui ingère les données Xero dans des tables Unity Catalog. Utilisez l’interface utilisateur de Databricks, les bundles d’automatisation déclarative (DAB) ou un notebook Databricks.

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 métastore. Consultez Gérer les privilèges dans Unity Catalog.

    Si le connecteur prend en charge la création de pipeline basée sur l'UI, un administrateur peut créer la connexion et le pipeline en même temps en effectuant les étapes sur cette page. Cependant, si les utilisateurs qui créent des pipelines utilisent la création de pipeline basée sur l'API ou sont des utilisateurs non administrateurs, un administrateur doit d'abord créer la connexion dans l'Explorateur de catalogues. Voir Connectez-vous à 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 ingérer des données depuis Xero, commencez par configurer l’authentification depuis Databricks et créez une connexion. Consultez Configurer l’authentification auprès de Xero et Créer une connexion Xero.

• Notez l'ID de tenant de l'organisation Xero à ingérer. Voir Trouver l'ID de tenant.

Options du connecteur

Pour les options que le connecteur Xero accepte, leur portée et les tables auxquelles elles s'appliquent, voir Options de connecteur. Définissez les options définies par le pipeline dans source_configurations. Chaque pipeline doit définir tenant_id. Voir Exemples pour l'utilisation.

Créer un pipeline d’ingestion

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

Databricks UI

1. Dans la barre latérale du Databricks workspace, cliquez sur Ingestion de données .
2. Sur la page Ajouter des données , sous Connecteurs Databricks , cliquez sur Xero .
3. Sur la page Connexion de l’assistant d’ingestion, sélectionnez la connexion qui stocke vos identifiants Xero. 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 auprès de Xero.
4. Cliquez sur Suivant .
5. Sur la page Configuration de l'ingestion , 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. Pour ID du tenant , saisissez l'ID du tenant de l'organisation Xero à ingérer. Optionnellement, définissez une Date et une heure de start . Voir Options de connecteur.
8. Cliquez sur Créer un pipeline et continuer .
9. Sur la page Source , sélectionnez les tables à ingérer.
10. Cliquez sur Enregistrer et continuer .
11. Sur la page Destination , sélectionnez un catalogue et un schéma dans lequel 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.
12. Cliquez sur Enregistrer et continuer .
13. (Facultatif) Sur la page Planifications et notifications , cliquez sur Créer une planification . Définissez la fréquence de refresh des tables de destination.
14. (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 de pipeline, puis cliquez sur Enregistrer et exécuter le pipeline .

Declarative Automation Bundles

Utilisez les Declarative Automation Bundles pour gérer les pipelines Xero 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 Que sont les 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/xero_pipeline.yml). Consultez 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/xero_job.yml).

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

   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 trois premières cellules telles quelles.

3. Modifiez la quatrième cellule, qui définit pipeline_spec, avec vos détails de configuration de pipeline. Voir pipeline.ingestion_definition et les exemples.

4. Vous pouvez éventuellement configurer des paramètres de pipeline avancés. Voir Modèles courants pour les pipelines d’ingestion gérés.

5. Cliquez sur Tout exécuter .

Exemples

Le connecteur Xero met à disposition 23 tables sources dans le schéma source default. Spécifiez chaque table que vous souhaitez ingérer et définissez tenant_id sur l'organisation à 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 nom de destination par table.

Declarative Automation Bundles

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

YAML

resources:
  pipelines:
    xero_pipeline:
      name: xero_pipeline
      catalog: 'main'
      target: 'xero_data'
      ingestion_definition:
        connection_name: xero_connection
        source_configurations:
          - api_source_connector_config:
              configs:
                tenant_id: '<tenant-id>'
        objects:
          - table:
              source_schema: 'default'
              source_table: 'invoices'
              destination_catalog: 'main'
              destination_schema: 'xero_data'
              destination_table: 'invoices'
          - table:
              source_schema: 'default'
              source_table: 'contacts'
              destination_catalog: 'main'
              destination_schema: 'xero_data'
              destination_table: 'contacts'
          - table:
              source_schema: 'default'
              source_table: 'payments'
              destination_catalog: 'main'
              destination_schema: 'xero_data'
              destination_table: 'payments'

Databricks notebook

La spécification de pipeline suivante ingère les tables Xero individuelles :

Python

pipeline_name = "xero_pipeline"
connection_name = "<xero-connection>"
pipeline_spec = {
  "name": pipeline_name,
  "ingestion_definition": {
    "connection_name": connection_name,
    "source_configurations": [
      {
        "api_source_connector_config": {
          "configs": {
            "tenant_id": "<tenant-id>"
          }
        }
      }
    ],
    "objects": [
      {
        "table": {
          "source_schema": "default",
          "source_table": "invoices",
          "destination_catalog": "main",
          "destination_schema": "xero_data",
          "destination_table": "invoices"
        }
      },
      {
        "table": {
          "source_schema": "default",
          "source_table": "contacts",
          "destination_catalog": "main",
          "destination_schema": "xero_data",
          "destination_table": "contacts"
        }
      },
      {
        "table": {
          "source_schema": "default",
          "source_table": "payments",
          "destination_catalog": "main",
          "destination_schema": "xero_data",
          "destination_table": "payments"
        }
      }
    ]
  }
}
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 période de lecture des tables incrémentielles lors de leur première synchronisation.

Declarative Automation Bundles

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

YAML

resources:
  pipelines:
    xero_pipeline:
      name: xero_pipeline
      catalog: 'main'
      target: 'xero_data'
      ingestion_definition:
        connection_name: xero_connection
        source_configurations:
          - api_source_connector_config:
              configs:
                tenant_id: '<tenant-id>'
                start_datetime: '<start-datetime>'
        objects:
          - table:
              source_schema: 'default'
              source_table: 'invoices'
              destination_catalog: 'main'
              destination_schema: 'xero_data'
              destination_table: 'invoices'
          - table:
              source_schema: 'default'
              source_table: 'contacts'
              destination_catalog: 'main'
              destination_schema: 'xero_data'
              destination_table: 'contacts'
          - table:
              source_schema: 'default'
              source_table: 'payments'
              destination_catalog: 'main'
              destination_schema: 'xero_data'
              destination_table: 'payments'

Databricks notebook

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

Python

pipeline_name = "xero_pipeline"
connection_name = "<xero-connection>"
pipeline_spec = {
  "name": pipeline_name,
  "ingestion_definition": {
    "connection_name": connection_name,
    "source_configurations": [
      {
        "api_source_connector_config": {
          "configs": {
            "tenant_id": "<tenant-id>",
            "start_datetime": "<start-datetime>"
          }
        }
      }
    ],
    "objects": [
      {
        "table": {
          "source_schema": "default",
          "source_table": "invoices",
          "destination_catalog": "main",
          "destination_schema": "xero_data",
          "destination_table": "invoices"
        }
      },
      {
        "table": {
          "source_schema": "default",
          "source_table": "contacts",
          "destination_catalog": "main",
          "destination_schema": "xero_data",
          "destination_table": "contacts"
        }
      },
      {
        "table": {
          "source_schema": "default",
          "source_table": "payments",
          "destination_catalog": "main",
          "destination_schema": "xero_data",
          "destination_table": "payments"
        }
      }
    ]
  }
}
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:
    xero_job:
      name: xero_job
      schedule:
        quartz_cron_expression: '0 0 0 * * ?'
        timezone_id: 'UTC'
      tasks:
        - task_key: xero_ingestion
          pipeline_task:
            pipeline_id: ${resources.pipelines.xero_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, schedule, and set alerts on your pipeline. Voir Tâches de maintenance courantes du pipeline.

Ressources supplémentaires

• FAQ du connecteur Xero
• Limites du connecteur Xero
• Référence du connecteur Xero
• Résoudre les problèmes du connecteur Xero