Ingérer des données de Square

info

Bêta

Cette fonctionnalité est en Bêta. Les administrateurs du Workspace peuvent contrôler l'accès à cette fonctionnalité à partir de la page Previews . Consultez Gérer les aperçus Databricks.

Cette page explique comment créer un pipeline d'ingestion Square géré à l'aide de Lakeflow Connect.

Exigences

• Pour créer un pipeline d'ingestion, respectez d'abord les 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 Square, configurez d’abord l’authentification depuis Databricks et créez une connexion. Voir Configurer l'authentification à Square et Créer une connexion Square.

Créez un pipeline d'ingestion

Pour la liste des tables source prises en charge, consultez Tables source 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 Square .
3. Sur la page Connexion de l'assistant d'ingestion, sélectionnez la connexion qui stocke vos identifiants Square. 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 Configurer l'authentification à Square.
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 pour é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 des données. Si vous avez les 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 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 les Declarative Automation Bundles pour gérer les pipelines Square 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 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/square_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/square_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. Laissez les cellules un et deux telles quelles. Ne pas modifier.

3. Modifiez la troisième cellule avec les détails de configuration de votre pipeline. Voir 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 Square met à disposition 17 tables sources dans le schéma source default. Ingérez des tables individuelles ou l’intégralité du schéma.

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 la destination par table.

Declarative Automation Bundles

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

YAML

resources:
  pipelines:
    square_pipeline:
      name: square_pipeline
      catalog: 'main'
      target: 'square_data'
      ingestion_definition:
        connection_name: square_connection
        objects:
          - table:
              source_schema: 'default'
              source_table: 'payments'
              destination_catalog: 'main'
              destination_schema: 'square_data'
              destination_table: 'payments'
          - table:
              source_schema: 'default'
              source_table: 'orders'
              destination_catalog: 'main'
              destination_schema: 'square_data'
              destination_table: 'orders'
          - table:
              source_schema: 'default'
              source_table: 'customers'
              destination_catalog: 'main'
              destination_schema: 'square_data'
              destination_table: 'customers'

Databricks notebook

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

Python

pipeline_name = "square_pipeline"
connection_name = "<square-connection>"
pipeline_spec = {
  "name": pipeline_name,
  "ingestion_definition": {
    "connection_name": connection_name,
    "objects": [
      {
        "table": {
          "source_schema": "default",
          "source_table": "payments",
          "destination_catalog": "main",
          "destination_schema": "square_data",
          "destination_table": "payments"
        }
      },
      {
        "table": {
          "source_schema": "default",
          "source_table": "orders",
          "destination_catalog": "main",
          "destination_schema": "square_data",
          "destination_table": "orders"
        }
      },
      {
        "table": {
          "source_schema": "default",
          "source_table": "customers",
          "destination_catalog": "main",
          "destination_schema": "square_data",
          "destination_table": "customers"
        }
      }
    ]
  }
}
json_payload = json.dumps(pipeline_spec, indent=2)
create_pipeline(json_payload)

Ingérez l'intégralité du schéma

Utilisez cette option pour ingérer toutes les tables sources Square dans un schéma de destination unique avec une seule déclaration.

Declarative Automation Bundles

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

YAML

resources:
  pipelines:
    square_pipeline:
      name: square_pipeline
      catalog: 'main'
      target: 'square_data'
      ingestion_definition:
        connection_name: square_connection
        objects:
          - schema:
              source_schema: 'default'
              destination_catalog: 'main'
              destination_schema: 'square_data'

Databricks notebook

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

Python

pipeline_name = "square_pipeline"
connection_name = "<square-connection>"
pipeline_spec = {
  "name": pipeline_name,
  "ingestion_definition": {
    "connection_name": connection_name,
    "objects": [
      {
        "schema": {
          "source_schema": "default",
          "destination_catalog": "main",
          "destination_schema": "square_data"
        }
      }
    ]
  }
}
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:
    square_job:
      name: square_job
      schedule:
        quartz_cron_expression: '0 0 0 * * ?'
        timezone_id: 'UTC'
      tasks:
        - task_key: square_ingestion
          pipeline_task:
            pipeline_id: ${resources.pipelines.square_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 configurez des alertes sur votre pipeline. Consultez les Tâches de maintenance courantes du pipeline.

Ressources supplémentaires

• FAQ sur les connecteurs carrés
• Limitations des connecteurs Square
• Référence du connecteur carré
• Dépanner le connecteur Square