Ingest data from Pendo
This feature is in Beta. Workspace admins can control access to this feature from the Previews page. See Manage Databricks previews.
This page shows how to create a managed Pendo ingestion pipeline using Lakeflow Connect.
Requirements
-
To create an ingestion pipeline, you must first meet the following requirements:
-
Your workspace must be enabled for Unity Catalog.
-
Serverless compute must be enabled for your workspace. See Serverless compute requirements.
-
If you plan to create a new connection: You must have
CREATE CONNECTIONprivileges on the metastore. See Manage privileges in Unity Catalog.If the connector supports UI-based pipeline authoring, an admin can create the connection and the pipeline at the same time by completing the steps on this page. However, if the users who create pipelines use API-based pipeline authoring or are non-admin users, an admin must first create the connection in Catalog Explorer. See Connect to managed ingestion sources.
-
If you plan to use an existing connection: You must have
USE CONNECTIONprivileges orALL PRIVILEGESon the connection object. -
You must have
USE CATALOGprivileges on the target catalog. -
You must have
USE SCHEMAandCREATE TABLEprivileges on an existing schema orCREATE SCHEMAprivileges on the target catalog.
-
-
To ingest from Pendo, you must first configure authentication from Databricks. See Configure Pendo for managed ingestion.
Create an ingestion pipeline
- Databricks UI
- Declarative Automation Bundles
- Databricks notebook
- In the sidebar of the Databricks workspace, click Data Ingestion.
- On the Add data page, under Databricks connectors, click Pendo.
- On the Connection page of the ingestion wizard, select the connection that stores your Pendo access credentials. If you have the
CREATE CONNECTIONprivilege on the metastore, you can clickCreate connection to create a new connection with the authentication details in Create a Pendo connection.
- Click Next.
- On the Ingestion setup page, enter a unique name for the pipeline.
- Select a catalog and a schema to write event logs to. If you have
USE CATALOGandCREATE SCHEMAprivileges on the catalog, you can clickCreate schema in the drop-down menu to create a new schema.
- Click Create pipeline and continue.
- On the Source page, select the tables to ingest.
- Click Save and continue.
- On the Destination page, select a catalog and a schema to load data into. If you have
USE CATALOGandCREATE SCHEMAprivileges on the catalog, you can clickCreate schema in the drop-down menu to create a new schema.
- Click Save and continue.
- (Optional) On the Schedules and notifications page, click
Create schedule. Set the frequency to refresh the destination tables.
- (Optional) Click
Add notification to set email notifications for pipeline operation success or failure, then click Save and run pipeline.
Use Declarative Automation Bundles to manage Pendo pipelines as code. Bundles can contain YAML definitions of jobs and tasks, are managed using the Databricks CLI, and can be shared and run in different target workspaces (such as development, staging, and production). For more information, see What are Declarative Automation Bundles?.
-
Create a bundle using the Databricks CLI:
Bashdatabricks bundle init -
Add two new resource files to the bundle:
- A pipeline definition file (for example,
resources/pendo_pipeline.yml). See pipeline.ingestion_definition and Examples. - A job definition file that controls the frequency of data ingestion (for example,
resources/pendo_job.yml).
- A pipeline definition file (for example,
-
Deploy the pipeline using the Databricks CLI:
Bashdatabricks bundle deploy
-
Import the following notebook into your Databricks workspace:
-
Leave cells one and two as they are. Do not modify.
-
Modify cell three with your pipeline configuration details. See pipeline.ingestion_definition and Examples.
-
Optionally configure advanced pipeline settings. See Common patterns for managed ingestion pipelines.
-
Click Run all.
Examples
Use these examples to configure your pipeline.
Ingest the entire schema
- Declarative Automation Bundles
- Databricks notebook
The following pipeline definition file ingests all supported Pendo tables into a destination schema:
resources:
pipelines:
pendo_pipeline:
name: pendo_pipeline
catalog: 'main'
target: 'pendo_data'
ingestion_definition:
connection_name: pendo_connection
objects:
- schema:
source_schema: 'default'
destination_catalog: 'main'
destination_schema: 'pendo_data'
The following pipeline specification ingests all supported Pendo tables into a destination schema:
pipeline_name = "pendo_pipeline"
connection_name = "<pendo-connection>"
pipeline_spec = {
"name": pipeline_name,
"ingestion_definition": {
"connection_name": connection_name,
"objects": [
{
"schema": {
"source_schema": "default",
"destination_catalog": "main",
"destination_schema": "pendo_data"
}
}
]
}
}
json_payload = json.dumps(pipeline_spec, indent=2)
create_pipeline(json_payload)
Ingest specific tables
Ingest individual Pendo tables. For a full list of supported tables, see Supported source tables.
- Declarative Automation Bundles
- Databricks notebook
The following pipeline definition file ingests individual Pendo tables:
resources:
pipelines:
pendo_pipeline:
name: pendo_pipeline
catalog: 'main'
target: 'pendo_data'
ingestion_definition:
connection_name: pendo_connection
objects:
- table:
source_schema: 'default'
source_table: 'page'
destination_catalog: 'main'
destination_schema: 'pendo_data'
destination_table: 'page'
- table:
source_schema: 'default'
source_table: 'feature'
destination_catalog: 'main'
destination_schema: 'pendo_data'
destination_table: 'feature'
- table:
source_schema: 'default'
source_table: 'guide'
destination_catalog: 'main'
destination_schema: 'pendo_data'
destination_table: 'guide'
- table:
source_schema: 'default'
source_table: 'report'
destination_catalog: 'main'
destination_schema: 'pendo_data'
destination_table: 'report'
The following pipeline specification ingests individual Pendo tables:
pipeline_name = "pendo_pipeline"
connection_name = "<pendo-connection>"
pipeline_spec = {
"name": pipeline_name,
"ingestion_definition": {
"connection_name": connection_name,
"objects": [
{
"table": {
"source_schema": "default",
"source_table": "page",
"destination_catalog": "main",
"destination_schema": "pendo_data",
"destination_table": "page"
}
},
{
"table": {
"source_schema": "default",
"source_table": "feature",
"destination_catalog": "main",
"destination_schema": "pendo_data",
"destination_table": "feature"
}
},
{
"table": {
"source_schema": "default",
"source_table": "guide",
"destination_catalog": "main",
"destination_schema": "pendo_data",
"destination_table": "guide"
}
},
{
"table": {
"source_schema": "default",
"source_table": "report",
"destination_catalog": "main",
"destination_schema": "pendo_data",
"destination_table": "report"
}
}
]
}
}
json_payload = json.dumps(pipeline_spec, indent=2)
create_pipeline(json_payload)
Declarative Automation Bundles job definition file
- Declarative Automation Bundles
resources:
jobs:
pendo_job:
name: pendo_job
schedule:
quartz_cron_expression: '0 0 0 * * ?'
timezone_id: 'UTC'
tasks:
- task_key: pendo_ingestion
pipeline_task:
pipeline_id: ${resources.pipelines.pendo_pipeline.id}
Common patterns
For advanced pipeline configurations, see Common patterns for managed ingestion pipelines.
Next steps
Start, schedule, and set alerts on your pipeline. See Common pipeline maintenance tasks.