Ingérer des données de Smartsheet

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.

Découvrez comment créer un pipeline d'ingestion Smartsheet 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 Smartsheet, vous devez d'abord effectuer les étapes de Créer une connexion Smartsheet.

Créez un pipeline d'ingestion

Chaque objet source (feuille ou rapport) est ingéré dans une table de streaming. Pour une liste des types d'objets sources pris en charge, consultez Types d'objets sources pris 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 Smartsheet .
3. Sur la page Connexion de l'assistant d'ingestion, sélectionnez la connexion qui stocke vos identifiants d'accès Smartsheet. Si vous disposez du privilège CREATE CONNECTION sur le metastore, vous pouvez cliquer sur CRÉER CONNEXION pour créer une nouvelle connexion avec les détails d'authentification dans Créer une connexion Smartsheet.
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, 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 feuilles ou les rapports à 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 les Declarative Automation Bundles pour gérer les pipelines Smartsheet 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/smartsheet_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/smartsheet_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 un objet source unique

Le source_schema est toujours "default" pour Smartsheet. Le source_table est l'ID de feuille ou de rapport à 16 chiffres, que vous pouvez trouver dans l'URL Smartsheet ou les propriétés de la feuille.

Declarative Automation Bundles

Le fichier de définition de pipeline suivant ingère une seule feuille Smartsheet :

YAML

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

resources:
  pipelines:
    pipeline_smartsheet:
      name: smartsheet_pipeline
      catalog: ${var.dest_catalog}
      schema: ${var.dest_schema}
      ingestion_definition:
        connection_name: <smartsheet-connection>
        objects:
          - table:
              source_schema: default
              source_table: '7483920174635241'
              destination_catalog: ${var.dest_catalog}
              destination_schema: ${var.dest_schema}

Databricks notebook

Voici une spécification de pipeline d'exemple qui ingère un objet source unique :

Python

pipeline_spec = """
{
  "name": "<pipeline-name>",
  "catalog": "<catalog-name-for-event-logs>",
  "schema": "<schema-name-for-event-logs>",
  "ingestion_definition": {
    "connection_name": "<smartsheet-connection>",
    "objects": [
      {
        "table": {
          "source_schema": "default",
          "source_table": "7483920174635241",
          "destination_catalog": "main",
          "destination_schema": "ingest_destination_schema"
        }
      }
    ]
  },
  "channel": "PREVIEW"
}
"""
create_pipeline(pipeline_spec)

Ingérer plusieurs objets sources

Declarative Automation Bundles

Le fichier de définition de pipeline suivant ingère plusieurs feuilles ou rapports :

YAML

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

resources:
  pipelines:
    pipeline_smartsheet:
      name: smartsheet_pipeline
      catalog: ${var.dest_catalog}
      schema: ${var.dest_schema}
      ingestion_definition:
        connection_name: <smartsheet-connection>
        objects:
          - table:
              source_schema: default
              source_table: '7483920174635241'
              destination_catalog: ${var.dest_catalog}
              destination_schema: ${var.dest_schema}
          - table:
              source_schema: default
              source_table: '3219847562038416'
              destination_catalog: ${var.dest_catalog}
              destination_schema: ${var.dest_schema}

Databricks notebook

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

Python

pipeline_spec = """
{
  "name": "<pipeline-name>",
  "catalog": "<catalog-name-for-event-logs>",
  "schema": "<schema-name-for-event-logs>",
  "ingestion_definition": {
    "connection_name": "<smartsheet-connection>",
    "objects": [
      {
        "table": {
          "source_schema": "default",
          "source_table": "7483920174635241",
          "destination_catalog": "main",
          "destination_schema": "ingest_destination_schema"
        }
      },
      {
        "table": {
          "source_schema": "default",
          "source_table": "3219847562038416",
          "destination_catalog": "main",
          "destination_schema": "ingest_destination_schema"
        }
      }
    ]
  },
  "channel": "PREVIEW"
}
"""
create_pipeline(pipeline_spec)

Utilisez les options de connecteur et de table

Utilisez connector_options et table_configuration pour contrôler l'application des schémas, la sélection de colonnes et le filtrage des lignes.

Declarative Automation Bundles

Le fichier de définition de pipeline suivant ingère une feuille avec exclusion de colonnes et filtrage de lignes :

YAML

variables:
  dest_catalog:
    default: main
  dest_schema:
    default: hr_data

resources:
  pipelines:
    pipeline_smartsheet:
      name: smartsheet_pipeline
      catalog: ${var.dest_catalog}
      schema: ${var.dest_schema}
      ingestion_definition:
        connection_name: <smartsheet-connection>
        connector_options:
          enforce_schema: false
        objects:
          - table:
              source_schema: default
              source_table: '7483920174635241'
              destination_catalog: ${var.dest_catalog}
              destination_schema: ${var.dest_schema}
              destination_table: employee_roster
              table_configuration:
                exclude_columns:
                  - Employee Name
                  - Status
                row_filter: "row_number <= 10 OR Department != 'Engineering'"

Databricks notebook

Voici un exemple de spécification de pipeline qui utilise les options de connecteur et la configuration de table :

Python

pipeline_spec = """
{
  "name": "my_smartsheet_pipeline",
  "catalog": "your_pipeline_event_log_catalog_name",
  "schema": "your_pipeline_event_log_schema_name",
  "ingestion_definition": {
    "connection_name": "my_smartsheet_connection",
    "connector_options": {
      "enforce_schema": false
    },
    "objects": [
      {
        "table": {
          "source_schema": "default",
          "source_table": "7483920174635241",
          "destination_catalog": "main",
          "destination_schema": "hr_data",
          "destination_table": "employee_roster",
          "table_configuration": {
            "exclude_columns": ["Employee Name", "Status"],
            "row_filter": "row_number <= 10 OR Department != 'Engineering'"
          }
        }
      }
    ]
  },
  "channel": "PREVIEW"
}
"""
create_pipeline(pipeline_spec)

Fichier de définition du job de bundle

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:
    smartsheet_dab_job:
      name: smartsheet_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_smartsheet.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

• Limitations du connecteur Smartsheet
• Référence du connecteur Smartsheet
• Dépanner le connecteur Smartsheet