Skip to main content

Load Data from Slack to CockroachDB with 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.

Slack is a messaging app for business that connects people to the information they need. CockroachDB is a simple, reliable SQL API that is distributed, cloud-native, Kubernetes compatible, and free up to 5GB and 1vCPU. This documentation will guide you on how to load data from Slack to CockroachDB using the open-source python library called dlt. dlt provides an efficient way to transfer data between these platforms, ensuring data integrity and consistency. For more information about Slack, visit their website.

dlt Key Features

  • Automated maintenance: With schema inference and evolution and alerts, and with short declarative code, maintenance becomes simple. Learn more
  • Run it where Python runs: On Airflow, serverless functions, notebooks. No external APIs, backends or containers, scales on micro and large infra alike. Learn more
  • User-friendly interface: A declarative interface that removes knowledge obstacles for beginners while empowering senior professionals. Learn more
  • Governance support: Robust governance through pipeline metadata utilization, schema enforcement and curation, and schema change alerts. Learn more
  • Scalability and finetuning: Mechanisms and configuration options to scale up and finetune pipelines, including parallel execution and memory buffer adjustments. Learn more

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 Slack to CockroachDB. You can run the following commands to create a starting point for loading data from Slack to CockroachDB:

# create a new directory
mkdir slack_pipeline
cd slack_pipeline
# initialize a new pipeline with your source and destination
dlt init slack 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.12

You now have the following folder structure in your project:

slack_pipeline/
├── .dlt/
│ ├── config.toml # configs for your pipeline
│ └── secrets.toml # secrets for your pipeline
├── slack/ # folder with source specific files
│ └── ...
├── slack_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.slack]
access_token = "access_token" # 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 Slack 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 slack_pipeline.py, as well as a folder slack 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:


"""Pipeline to load slack into duckdb."""

from typing import List

import dlt
from pendulum import datetime
from slack import slack_source


def load_all_resources(replies: bool = False) -> None:
"""Load all resources from slack without any selection of channels."""

pipeline = dlt.pipeline(
pipeline_name="slack", destination='postgres', dataset_name="slack_data"
)

source = slack_source(
page_size=1000,
start_date=datetime(2023, 9, 1),
end_date=datetime(2023, 9, 8),
replies=replies,
)

# Uncomment the following line to load only the access_logs resource. It is not selected
# by default because it is a resource just available on paid accounts.
# source.access_logs.selected = True

load_info = pipeline.run(
source,
)
print(load_info)


def select_resource(selected_channels: List[str]) -> None:
"""Execute a pipeline that will load the given Slack list of channels with the selected
channels incrementally beginning at the given start date."""

pipeline = dlt.pipeline(
pipeline_name="slack", destination='postgres', dataset_name="slack_data"
)

source = slack_source(
page_size=20,
selected_channels=selected_channels,
start_date=datetime(2023, 9, 1),
end_date=datetime(2023, 9, 8),
).with_resources("channels", "1-announcements", "dlt-github-ci")

load_info = pipeline.run(
source,
)
print(load_info)


def get_users() -> None:
"""Execute a pipeline that will load Slack users list."""

pipeline = dlt.pipeline(
pipeline_name="slack", destination='postgres', dataset_name="slack_data"
)

source = slack_source(
page_size=20,
).with_resources("users")

load_info = pipeline.run(
source,
)
print(load_info)


if __name__ == "__main__":
# Add your desired resources to the list...
# resources = ["access_logs", "conversations", "conversations_history"]

# load_all_resources()

# load all resources with replies
# load_all_resources(replies=True)

# select_resource(selected_channels=["dlt-github-ci"])
# select_resource(selected_channels=["1-announcements", "dlt-github-ci"])

get_users()

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

python slack_pipeline.py

4. Inspecting your load result

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

dlt pipeline slack 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 slack 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 deploy your pipeline using Github Actions, a CI/CD runner that you can use for free.
  • Deploy with Airflow and Google Composer: Follow this guide to deploy a pipeline with Airflow and Google Composer, a managed Airflow environment provided by Google.
  • Deploy with Google Cloud Functions: Discover how to deploy your pipeline using Google Cloud Functions.
  • Explore other deployment options: Check out other deployment options for deploying your pipeline.

The running in production section will teach you about:

  • How to Monitor your pipeline: Learn how to effectively monitor your dlt pipeline to ensure smooth operation and quick identification of issues. How to Monitor your pipeline
  • Set up alerts: Configure alerts to get notified about important events and potential issues in your dlt pipeline, enabling proactive management. Set up alerts
  • Set up tracing: Implement tracing to gain detailed insights into the execution of your dlt pipeline, helping you diagnose problems and optimize performance. And set up tracing

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.