Ingérer des données depuis Productboard

info

Bêta

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

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

Exigences

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

  • Votre Workspace doit être activé pour Unity Catalog.

  • Le compute serverless doit être activé pour votre workspace. Voir Exigences pour le 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 via l’interface utilisateur, un administrateur peut créer la connexion et le pipeline simultanément en suivant les étapes décrites sur cette page. Toutefois, si les utilisateurs qui créent des pipelines utilisent la création de pipelines par API ou s'ils ne sont pas des utilisateurs administrateurs, un administrateur doit d'abord créer la connexion dans Catalog Explorer. Voir Connecter à 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 avoir 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 à partir de Productboard, commencez par configurer l'authentification depuis Databricks et créez une connexion. Voir Configurer l'authentification à Productboard et Créer une connexion Productboard.

Options du connecteur

Définissez les options propres au pipeline dans source_configurations. Consultez les Exemples pour savoir comment les utiliser.

Option	Portée	Obligatoire	S’applique à	Description
start_datetime	Pipeline	Non	notes	La valeur updatedAt la plus ancienne à ingérer lors de la première synchronisation, au format yyyy-MM-ddTHH:mm:ssZ (par exemple, 2024-01-01T00:00:00Z). La valeur par default est 2020-01-01T00:00:00Z.

Option	Portée	Obligatoire	S’applique à	Description
start_datetime	Pipeline	Non	notes	La valeur updatedAt la plus ancienne à ingérer lors de la première synchronisation, au format yyyy-MM-ddTHH:mm:ssZ (par exemple, 2024-01-01T00:00:00Z). La valeur par default est 2020-01-01T00:00:00Z.

Créer un pipeline d’ingestion

Pour la liste des tables sources prises en charge, voir Tables sources prises en charge.

Databricks UI

1. Dans la barre latérale du workspace Databricks, cliquez sur Ingestion des données .
2. Sur la page Ajouter des données , sous Connecteurs Databricks , cliquez sur Productboard .
3. Sur la page Connexion de l'assistant d'ingestion, sélectionnez la connexion qui stocke vos identifiants Productboard. Si vous disposez du 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 à Productboard.
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 lequel écrire les logs d’événement. 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 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 Productboard 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éer 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/productboard_pipeline.yml). Voir pipeline.ingestion_definition et Exemples.
   • Fichier de définition de job qui contrôle la fréquence d’ingestion des données (par exemple resources/productboard_job.yml).

3. Déployer 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 la cellule un telle quelle.

3. Dans la deuxième cellule, remplacez <Paste generated token here> par un jeton d'accès personnel.

4. Laissez la cellule trois telle quelle.

5. Modifiez la cellule quatre avec les détails de votre configuration de pipeline. Voir pipeline.ingestion_definition et Exemples.

6. Configurez les paramètres avancés du pipeline si vous le souhaitez. Consultez les modèles courants pour les pipelines d'ingestion gérés.

7. Cliquez sur Tout exécuter .

Exemples

Le connecteur Productboard rend ses tables sources disponibles dans le schéma source default. Ingérer des tables individuelles ou le schéma entier. Pour la liste complète des tables, voir Tables sources prises en charge.

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 Productboard individuelles :

YAML

resources:
  pipelines:
    productboard_pipeline:
      name: productboard_pipeline
      catalog: 'main'
      target: 'productboard_data'
      ingestion_definition:
        connection_name: productboard_connection
        source_configurations:
          - api_source_connector_config:
              configs:
                start_datetime: '<start-datetime>'
        objects:
          - table:
              source_schema: 'default'
              source_table: 'features'
              destination_catalog: 'main'
              destination_schema: 'productboard_data'
              destination_table: 'features'
          - table:
              source_schema: 'default'
              source_table: 'notes'
              destination_catalog: 'main'
              destination_schema: 'productboard_data'
              destination_table: 'notes'
          - table:
              source_schema: 'default'
              source_table: 'companies'
              destination_catalog: 'main'
              destination_schema: 'productboard_data'
              destination_table: 'companies'

Databricks notebook

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

Python

pipeline_name = "productboard_pipeline"
connection_name = "<productboard-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": "features",
          "destination_catalog": "main",
          "destination_schema": "productboard_data",
          "destination_table": "features"
        }
      },
      {
        "table": {
          "source_schema": "default",
          "source_table": "notes",
          "destination_catalog": "main",
          "destination_schema": "productboard_data",
          "destination_table": "notes"
        }
      },
      {
        "table": {
          "source_schema": "default",
          "source_table": "companies",
          "destination_catalog": "main",
          "destination_schema": "productboard_data",
          "destination_table": "companies"
        }
      }
    ]
  }
}
json_payload = json.dumps(pipeline_spec, indent=2)
create_pipeline(json_payload)

Ingérer l’intégralité du schéma

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

Declarative Automation Bundles

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

YAML

resources:
  pipelines:
    productboard_pipeline:
      name: productboard_pipeline
      catalog: 'main'
      target: 'productboard_data'
      ingestion_definition:
        connection_name: productboard_connection
        source_configurations:
          - api_source_connector_config:
              configs:
                start_datetime: '<start-datetime>'
        objects:
          - schema:
              source_schema: 'default'
              destination_catalog: 'main'
              destination_schema: 'productboard_data'

Databricks notebook

La spécification de pipeline suivante ingère toutes les tables Productboard compatibles dans un schéma de destination :

Python

pipeline_name = "productboard_pipeline"
connection_name = "<productboard-connection>"
pipeline_spec = {
  "name": pipeline_name,
  "ingestion_definition": {
    "connection_name": connection_name,
    "source_configurations": [
      {
        "api_source_connector_config": {
          "configs": {
            "start_datetime": "<start-datetime>"
          }
        }
      }
    ],
    "objects": [
      {
        "schema": {
          "source_schema": "default",
          "destination_catalog": "main",
          "destination_schema": "productboard_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:
    productboard_job:
      name: productboard_job
      schedule:
        quartz_cron_expression: '0 0 0 * * ?'
        timezone_id: 'UTC'
      tasks:
        - task_key: productboard_ingestion
          pipeline_task:
            pipeline_id: ${resources.pipelines.productboard_pipeline.id}

Modèles courants

Pour les configurations de pipeline avancées, consultez les modèles courants pour les pipelines d'ingestion gérés.

Étapes suivantes

Start, planifiez et définissez des alertes sur votre pipeline. Consultez Tâches de maintenance courantes des pipelines.

Ressources supplémentaires

• FAQ du connecteur Productboard
• Limitations du connecteur Productboard
• Référence du connecteur Productboard
• Dépanner le connecteur Productboard