Skip to main content

Load Data from Jira to AlloyDB using dlt in Python


We will be using the dlt PostgreSQL destination to connect to AlloyDB. You can get the connection string for AlloyDB from the GCP AlloyDB Console.

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.

Jira is a leading project management tool for agile teams, enabling efficient planning, tracking, and releasing of world-class software. AlloyDB for PostgreSQL is a fully managed, PostgreSQL-compatible database service designed for demanding workloads, offering enterprise-grade performance, reliability, and availability. This documentation explains how to load data from Jira into AlloyDB using the open-source Python library dlt. By leveraging dlt, you can seamlessly integrate and manage your project data, ensuring smooth and efficient data handling. For more information on Jira, visit Atlassian.

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. Learn more
  • Scalable data extraction: dlt offers scalable data extraction by leveraging iterators, chunking, and parallelization techniques, enabling efficient processing of large datasets. Learn more
  • Automated maintenance: With schema inference, evolution, and alerts, dlt simplifies maintenance with short declarative code. Learn more
  • User-friendly interface: dlt provides a declarative interface that removes knowledge obstacles for beginners while empowering senior professionals. Learn more
  • Implicit extraction DAGs: dlt automatically generates an extraction DAG based on dependencies identified between data sources and their transformations, ensuring data consistency and integrity. 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 AlloyDB:

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

# create a new directory
mkdir jira_pipeline
cd jira_pipeline
# initialize a new pipeline with your source and destination
dlt init jira 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:


You now have the following folder structure in your project:

├── .dlt/
│ ├── config.toml # configs for your pipeline
│ └── secrets.toml # secrets for your pipeline
├── jira/ # folder with source specific files
│ └── ...
├── # 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

log_level="WARNING" # the system log level of dlt
# use the dlthub_telemetry setting to enable/disable anonymous usage data reporting, see
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

subdomain = "subdomain" # please set me up!
email = "email" # please set me up!
api_token = "api_token" # please set me up!

dataset_name = "dataset_name" # please set me up!

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 Jira source in our docs.
  • Read more about setting up the AlloyDB 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, as well as a folder jira 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:

from typing import List, Optional

import dlt
from jira import jira, jira_search

def load(endpoints: Optional[List[str]] = None) -> None:
Load data from specified Jira endpoints into a dataset.

endpoints: A list of Jira endpoints. If not provided, defaults to all resources.
if not endpoints:
endpoints = list(jira().resources.keys())

pipeline = dlt.pipeline(
pipeline_name="jira_pipeline", destination='postgres', dataset_name="jira"

load_info =*endpoints))

print(f"Load Information: {load_info}")

def load_query_data(queries: List[str]) -> None:
Load issues from specified Jira queries into a dataset.

queries: A list of JQL queries.
pipeline = dlt.pipeline(

load_info =

print(f"Load Information: {load_info}")

if __name__ == "__main__":
# Add your desired endpoints to the list 'endpoints'

queries = [
"created >= -30d order by created DESC",
'project = KAN AND status = "In Progress" order by created DESC',


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


4. Inspecting your load result

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

dlt pipeline jira_pipeline info

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

# install streamlit
pip install streamlit
# run the streamlit app for your pipeline with the dlt cli:
dlt pipeline jira_pipeline 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 pipeline using GitHub Actions for CI/CD. Read more
  • Deploy with Airflow and Google Composer: Follow this guide to deploy your pipeline using Airflow and Google Composer. Read more
  • Deploy with Google Cloud Functions: Discover how to deploy your pipeline using Google Cloud Functions. Read more
  • Explore other deployment options: Check out additional methods and guides for deploying your pipeline. Read more

The running in production section will teach you about:

  • How to Monitor your pipeline: Learn how to effectively monitor your dlt pipeline in production to ensure everything runs smoothly. How to Monitor your pipeline
  • Set up alerts: Setting up alerts helps you stay informed about the state of your dlt pipeline, so you can take immediate action if something goes wrong. Set up alerts
  • Set up tracing: Implement tracing to gain deeper insights into the performance and behavior of your dlt pipeline. And set up tracing

Available Sources and Resources

For this verified source the following sources and resources are available

Source jira

The Jira source provides data on project management tasks, including details on issues, users, workflows, and projects.

Resource NameWrite DispositionDescription
issuesreplaceIndividual pieces of work to be completed. Contains various fields such as assignee, comments, created time, reporter, status, summary, updated time, etc.
projectsreplaceA collection of tasks that need to be completed to achieve a certain outcome. Contains fields such as avatar URL, description, ID, key, lead, name, etc.
usersreplaceAdministrator of a given project. Contains fields such as account ID, account type, avatar URL, display name, email address, etc.
workflowsreplaceThe key aspect of managing and tracking the progress of issues or tasks within a project. Contains fields such as created time, description, ID, updated time, etc.

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!


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.