Skip to main content

Loading Data from Mux to CockroachDB Using dlt in Python

tip

We will be using the dlt PostgreSQL destination to connect to CockroachDB. You can get the connection string for your CockroachDB database as described in the CockroachDB Docs.

Need help deploying these pipelines, or figuring out how to run them in your data stack?

Join our Slack community or book a call with our support engineer Violetta.

mux solves the hard problems software teams face when building video, from live-streaming platforms to on-demand video catalogs and anything in between. This documentation will guide you on how to load data from mux to cockroachdb using the open-source Python library dlt. cockroachdb offers a simple, reliable SQL API and is distributed, cloud-native, Kubernetes compatible, and free up to 5GB and 1vCPU. For more details about mux, visit mux.com.

dlt Key Features

  • Easy to get started: dlt is a Python library that is easy to use and understand. It is designed to be simple to use and easy to understand. Type pip install dlt and you are ready to go.
  • Data extraction and loading: dlt offers scalable data extraction by leveraging iterators, chunking, and parallelization techniques. Learn more
  • Governance support: dlt pipelines offer robust governance support through pipeline metadata utilization, schema enforcement and curation, and schema change alerts. Read more
  • Schema management: dlt empowers users to enforce and curate schemas, ensuring data consistency and quality. Adjust a schema
  • Data types: dlt supports a wide range of data types, ensuring compatibility with various data sources and destinations. Explore data types

Getting started with your pipeline locally

0. Prerequisites

dlt requires Python 3.8 or higher. Additionally, you need to have the pip package manager installed, and we recommend using a virtual environment to manage your dependencies. You can learn more about preparing your computer for dlt in our installation reference.

1. Install dlt

First you need to install the dlt library with the correct extras for CockroachDB:

pip install "dlt[postgres]"

The dlt cli has a useful command to get you started with any combination of source and destination. For this example, we want to load data from Mux to CockroachDB. You can run the following commands to create a starting point for loading data from Mux to CockroachDB:

# create a new directory
mkdir mux_pipeline
cd mux_pipeline
# initialize a new pipeline with your source and destination
dlt init mux postgres
# install the required dependencies
pip install -r requirements.txt

The last command will install the required dependencies for your pipeline. The dependencies are listed in the requirements.txt:

dlt[postgres]>=0.3.5

You now have the following folder structure in your project:

mux_pipeline/
├── .dlt/
│ ├── config.toml # configs for your pipeline
│ └── secrets.toml # secrets for your pipeline
├── mux/ # folder with source specific files
│ └── ...
├── mux_pipeline.py # your main pipeline script
├── requirements.txt # dependencies for your pipeline
└── .gitignore # ignore files for git (not required)

2. Configuring your source and destination credentials

The dlt cli will have created a .dlt directory in your project folder. This directory contains a config.toml file and a secrets.toml file that you can use to configure your pipeline. The automatically created version of these files look like this:

generated config.toml

# put your configuration values here

[runtime]
log_level="WARNING" # the system log level of dlt
# use the dlthub_telemetry setting to enable/disable anonymous usage data reporting, see https://dlthub.com/docs/telemetry
dlthub_telemetry = true

generated secrets.toml

# put your secret values and credentials here. do not share this file and do not push it to github

[sources.mux]
mux_api_access_token = "mux_api_access_token" # please set me up!
mux_api_secret_key = "mux_api_secret_key" # please set me up!

[destination.postgres]
dataset_name = "dataset_name" # please set me up!

[destination.postgres.credentials]
database = "database" # please set me up!
password = "password" # please set me up!
username = "username" # please set me up!
host = "host" # please set me up!
port = 5432
connect_timeout = 15

2.1. Adjust the generated code to your usecase

Further help setting up your source and destinations
  • Read more about setting up the Mux source in our docs.
  • Read more about setting up the CockroachDB destination in our docs.

3. Running your pipeline for the first time

The dlt cli has also created a main pipeline script for you at mux_pipeline.py, as well as a folder mux that contains additional python files for your source. These files are your local copies which you can modify to fit your needs. In some cases you may find that you only need to do small changes to your pipelines or add some configurations, in other cases these files can serve as a working starting point for your code, but will need to be adjusted to do what you need them to do.

The main pipeline script will look something like this:


import dlt
from mux import mux_source


def load_yesterday_video_views() -> None:
pipeline = dlt.pipeline(
pipeline_name="mux", destination='postgres', dataset_name="mux_data"
)
load_info = pipeline.run(mux_source())
print(load_info)


if __name__ == "__main__":
load_yesterday_video_views()

Provided you have set up your credentials, you can run your pipeline like a regular python script with the following command:

python mux_pipeline.py

4. Inspecting your load result

You can now inspect the state of your pipeline with the dlt cli:

dlt pipeline mux info

You can also use streamlit to inspect the contents of your CockroachDB destination for this:

# install streamlit
pip install streamlit
# run the streamlit app for your pipeline with the dlt cli:
dlt pipeline mux show

5. Next steps to get your pipeline running in production

One of the beauties of dlt is, that we are just a plain Python library, so you can run your pipeline in any environment that supports Python >= 3.8. We have a couple of helpers and guides in our docs to get you there:

The Deploy section will show you how to deploy your pipeline to

  • Deploy with GitHub Actions: Learn how to set up and deploy your dlt pipeline using GitHub Actions for CI/CD. Follow the guide here.
  • Deploy with Airflow and Google Composer: Discover how to deploy your dlt pipeline with Airflow and Google Composer for a managed workflow orchestration. Check out the instructions here.
  • Deploy with Google Cloud Functions: Find out how to deploy your dlt pipeline using Google Cloud Functions for serverless execution. See the steps here.
  • Explore other deployment options: Explore various other deployment methods for your dlt pipeline, including different cloud providers and orchestration tools. Browse the options here.

The running in production section will teach you about:

  • How to Monitor your pipeline: Learn how to monitor your dlt pipeline to ensure it runs smoothly and efficiently. Check out the guide here.
  • Set up alerts: Setting up alerts helps you stay informed about the status and health of your dlt pipeline. Find out how to set up alerts here.
  • Set up tracing: Tracing allows you to track the execution of your pipeline and diagnose issues. Learn how to set up tracing here.

Available Sources and Resources

For this verified source the following sources and resources are available

Source mux_source

"Mux_source" provides data on video content and viewing metrics from the Mux platform.

Resource NameWrite DispositionDescription
assets_resourcemergeFetches metadata about video assets from the Mux API's "assets" endpoint
views_resourceappendFetches data about every video view from yesterday from the Mux API

Additional pipeline guides

This demo works on codespaces. Codespaces is a development environment available for free to anyone with a Github account. You'll be asked to fork the demo repository and from there the README guides you with further steps.
The demo uses the Continue VSCode extension.

Off to codespaces!

DHelp

Ask a question

Welcome to "Codex Central", your next-gen help center, driven by OpenAI's GPT-4 model. It's more than just a forum or a FAQ hub – it's a dynamic knowledge base where coders can find AI-assisted solutions to their pressing problems. With GPT-4's powerful comprehension and predictive abilities, Codex Central provides instantaneous issue resolution, insightful debugging, and personalized guidance. Get your code running smoothly with the unparalleled support at Codex Central - coding help reimagined with AI prowess.