Skip to main content
Python Software Foundation 20th Year Anniversary Fundraiser  Donate today!

SQLBucket - Write your SQL ETL flow and ETL integrity tool.

Project description

https://travis-ci.org/socialpoint-labs/sqlbucket.svg?branch=master

SQLBucket is a lightweight framework to help write, orchestrate and validate SQL data pipelines. It gives the possibility to set variables and introduces some control flow using the fantastic Jinja2 library. It also implements a very simplistic unit and integration test framework where you can validate the results of your ETL in the form of SQL checks. With SQLBucket, you can apply TDD principles when writing data pipelines.

It can work as a stand alone service, or be part of your workflow manager environment (Airflow, Luigi, ..).

Installing

Install and update using pip:

pip install -U sqlbucket

SQLBucket works only for Python 3.6 and 3.7, and probably 3.8 although not tested yet.

A Simple Example

To start working, you need to instantiate your SQLBucket core object with the project_folder parameter. That folder will contain all your SQL ETL. The python file where you create your SQLBucket object is also a good place to instantiate your command line interface, as shown below.

# my_sqlbucket.py
from sqlbucket import SQLBucket


bucket = SQLBucket(projects_folder='projects')


if __name__ == '__main__':
    bucket.cli()

The following command will create your first project in your projects folder.

python my_sqlbucket.py create-project -n my_first_project

For more info on CLI, please refer to its documentations.

Your projects should now look like the structure below:

projects/
    |-- my_first_project/
        |-- config.yaml
        |-- queries/
            |-- query_one.sql
            |-- query_two.sql
        |-- integrity/
            |-- integrity_one.sql

SQLBucket project structure

An SQLBucket project is made of 3 core components: the configuration, the ETL queries and the integrity check queries.

Configuration

The config.yaml is the core of your project. This is where you can define variables at project level, and configure the order your sql queries must be executed. For a better explanations on how to configure variables you can refer to the usage documentation, and also the variables documentation which also describes environment and connections variables.

ETL queries

The queries folder simply contain your SQL queries. You can organize them in the folder structure of your choice. As long as they are in the queries folder, SQLBucket will find them and execute them when configured to do so. See the documentation on how to write SQL with SQLBucket.

Integrity queries

The integrity folder simply contain SQL queries to help you validate your ETL. You can organize them in the folder structure of your choice. The only convention is to return the result of your integrity (True/False) in a field named passed. The main idea is that integrity is done by SQL itself. Check documentation on integrity for a more detailed explanation on testing the integrity of your ETL. We also have a set of common macros that can be helpful to start with.

See below a full example that will actually first run your ETL, and then run your integrity checks for a given database configuration.

from sqlbucket import SQLBucket

connections = {
    'db_demo': 'postgresql://user:password@host:5439/database'
}

bucket = SQLBucket(connections=connections)
project = bucket.load_project(
    project_name='my_first_project',
    connection_name='db_demo',
    variables={'foo': 1}
)

# to run ETL
project.run()

# to run integrity
project.run_integrity()

We recommend setting your connection urls as environment variables for security purposes.

Template project

To get you up to speed, you can create a fork of the SQLBucket template project and start building SQL data pipelines within minutes.

Contributing

For guidance on how to make a contribution to SQLBucket, see the contributing guidelines.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for sqlbucket, version 0.4.1
Filename, size File type Python version Upload date Hashes
Filename, size sqlbucket-0.4.1-py3-none-any.whl (15.5 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size sqlbucket-0.4.1.tar.gz (14.8 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page