Ingérer des données depuis SurveyMonkey

info

Bêta

Cette fonctionnalité est en version Bêta. Pour l’utiliser, un administrateur de Workspace doit activer Lakeflow Connect for SurveyMonkey depuis la page Aperçus . Consultez Gérer les aperçus Databricks.

Créez un pipeline Lakeflow Connect géré qui ingère les données SurveyMonkey dans des tables Unity Catalog. Utilisez l’interface utilisateur Databricks, les Declarative Automation Bundles ou un notebook Databricks.

Configuration requise

• Pour créer un pipeline d’ingestion, veuillez d’abord remplir les conditions suivantes :

  • Votre workspace doit être compatible avec Unity Catalog.

  • Le compute serverless doit être activé pour votre workspace. Voir Exigences de 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’interface utilisateur, un administrateur peut créer la connexion et le pipeline en même temps en suivant les étapes sur cette page. Cependant, si les utilisateurs qui créent des pipelines utilisent une 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 Se connecter aux 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 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 des données depuis SurveyMonkey, commencez par configurer l'authentification depuis Databricks et créez une connexion. Consultez Configurer l’authentification auprès de SurveyMonkey et Créer une connexion SurveyMonkey.

Options du connecteur

Pour les options acceptées par le connecteur SurveyMonkey, leur portée et les tables auxquelles elles s’appliquent, voir Options du connecteur. Définissez les options de portée du pipeline dans source_configurations. Voir Exemples pour l'utilisation.

Créer un pipeline d’ingestion

Pour obtenir la liste des tables sources prises en charge, consultez Tables sources 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 SurveyMonkey .
3. Dans la page Connexion de l’assistant d’ingestion, sélectionnez la connexion qui stocke vos identifiants SurveyMonkey. Si vous avez le privilège CREATE CONNECTION sur le métastore, cliquez sur Créer une connexion pour créer une connexion avec les identifiants de Configurer l’authentification à SurveyMonkey.
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 des événements. 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.
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 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.
11. Cliquez sur Enregistrer et continuer .
12. (Facultatif) Sur la page Calendriers et notifications , cliquez sur Créer un calendrier . Définissez la fréquence de refresh des tables de destination.
13. (Facultatif) Cliquez sur Ajouter une notification pour configurer les notifications par e-mail en cas de réussite ou d’échec du pipeline, puis cliquez sur Enregistrer et exécuter le pipeline .

Declarative Automation Bundles

Utilisez les Declarative Automation Bundles pour gérer les pipelines SurveyMonkey 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éez un bundle à l'aide de la CLI Databricks :

   Bash

   databricks bundle init

2. Ajouter deux nouveaux fichiers de ressources au bundle :

   • Un fichier de définition de pipeline (par exemple, resources/surveymonkey_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/surveymonkey_job.yml).

3. Déployez le pipeline en utilisant 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.

3. Modifiez la troisième cellule avec les détails de configuration de votre pipeline. Voir pipeline.ingestion_definition et Exemples.

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

5. Cliquez sur Tout exécuter .

Exemples

Le connecteur SurveyMonkey propose 11 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 nom de destination par table.

Declarative Automation Bundles

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

YAML

resources:
  pipelines:
    surveymonkey_pipeline:
      name: surveymonkey_pipeline
      catalog: 'main'
      target: 'surveymonkey_data'
      ingestion_definition:
        connection_name: surveymonkey_connection
        objects:
          - table:
              source_schema: 'default'
              source_table: 'surveys'
              destination_catalog: 'main'
              destination_schema: 'surveymonkey_data'
              destination_table: 'surveys'
          - table:
              source_schema: 'default'
              source_table: 'survey_responses'
              destination_catalog: 'main'
              destination_schema: 'surveymonkey_data'
              destination_table: 'survey_responses'
          - table:
              source_schema: 'default'
              source_table: 'contacts'
              destination_catalog: 'main'
              destination_schema: 'surveymonkey_data'
              destination_table: 'contacts'

Databricks notebook

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

Python

pipeline_name = "surveymonkey_pipeline"
connection_name = "<surveymonkey-connection>"
pipeline_spec = {
  "name": pipeline_name,
  "ingestion_definition": {
    "connection_name": connection_name,
    "objects": [
      {
        "table": {
          "source_schema": "default",
          "source_table": "surveys",
          "destination_catalog": "main",
          "destination_schema": "surveymonkey_data",
          "destination_table": "surveys"
        }
      },
      {
        "table": {
          "source_schema": "default",
          "source_table": "survey_responses",
          "destination_catalog": "main",
          "destination_schema": "surveymonkey_data",
          "destination_table": "survey_responses"
        }
      },
      {
        "table": {
          "source_schema": "default",
          "source_table": "contacts",
          "destination_catalog": "main",
          "destination_schema": "surveymonkey_data",
          "destination_table": "contacts"
        }
      }
    ]
  }
}
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 définir 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 SurveyMonkey à partir d’une date de start spécifique :

YAML

resources:
  pipelines:
    surveymonkey_pipeline:
      name: surveymonkey_pipeline
      catalog: 'main'
      target: 'surveymonkey_data'
      ingestion_definition:
        connection_name: surveymonkey_connection
        source_configurations:
          - api_source_connector_config:
              configs:
                start_datetime: '<start-datetime>'
        objects:
          - table:
              source_schema: 'default'
              source_table: 'surveys'
              destination_catalog: 'main'
              destination_schema: 'surveymonkey_data'
              destination_table: 'surveys'
          - table:
              source_schema: 'default'
              source_table: 'survey_responses'
              destination_catalog: 'main'
              destination_schema: 'surveymonkey_data'
              destination_table: 'survey_responses'

Databricks notebook

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

Python

pipeline_name = "surveymonkey_pipeline"
connection_name = "<surveymonkey-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": "surveys",
          "destination_catalog": "main",
          "destination_schema": "surveymonkey_data",
          "destination_table": "surveys"
        }
      },
      {
        "table": {
          "source_schema": "default",
          "source_table": "survey_responses",
          "destination_catalog": "main",
          "destination_schema": "surveymonkey_data",
          "destination_table": "survey_responses"
        }
      }
    ]
  }
}
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 sources SurveyMonkey dans un seul schéma de destination à l’aide d’une seule déclaration.

Declarative Automation Bundles

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

YAML

resources:
  pipelines:
    surveymonkey_pipeline:
      name: surveymonkey_pipeline
      catalog: 'main'
      target: 'surveymonkey_data'
      ingestion_definition:
        connection_name: surveymonkey_connection
        objects:
          - schema:
              source_schema: 'default'
              destination_catalog: 'main'
              destination_schema: 'surveymonkey_data'

Databricks notebook

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

Python

pipeline_name = "surveymonkey_pipeline"
connection_name = "<surveymonkey-connection>"
pipeline_spec = {
  "name": pipeline_name,
  "ingestion_definition": {
    "connection_name": connection_name,
    "objects": [
      {
        "schema": {
          "source_schema": "default",
          "destination_catalog": "main",
          "destination_schema": "surveymonkey_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 Declarative Automation Bundles. Le job s'exécute quotidiennement.

Declarative Automation Bundles

YAML

resources:
  jobs:
    surveymonkey_job:
      name: surveymonkey_job
      schedule:
        quartz_cron_expression: '0 0 0 * * ?'
        timezone_id: 'UTC'
      tasks:
        - task_key: surveymonkey_ingestion
          pipeline_task:
            pipeline_id: ${resources.pipelines.surveymonkey_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, planifier et définir des alertes sur votre pipeline. Voir Tâches courantes de maintenance des pipelines.

Ressources supplémentaires

• FAQ sur le connecteur SurveyMonkey
• Limitations du connecteur SurveyMonkey
• Référence du connecteur SurveyMonkey
• Résoudre les problèmes du connecteur SurveyMonkey