sqlbucket

Pre-release

This release is a pre-release and may not be stable for production use.

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

SQLBucket was built to help write, orchestrate and validate SQL ETL. It gives the possibility to set variables and introduces some control flow like if/else and for loops, to make your queries dynamic when writing them. It also implements a very simplistic integration testing framework to validate the results of your ETL pipelines in the form of SQL checks.

Lightweight, 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 with SQLBucket, you need to have a ‘projects’ folder that will contain all your SQL ETL. SQLBucket, essentially works with the following folder structure as a root folder, where you can have as many projects as you want.

projects/
    |-- project1/
    |-- project2/
    |-- project3/
        ...

Inside a project, it must contain a folder called queries that will contains your SQL files to be ran, and a config.yaml that will let you set the order in which those queries must be processed. SQLBucket leverages on the amazing Jinja2 templating library to give you the possibility to set variables in your SQL as well as giving you pure execution flows like for loops. To see in more depth what can be done, see the documentation on how to write SQL in SQLBucket.

In practice, this is how a project folder would look.

projects/
    |-- my_super_project/
        |-- config.yaml
        |-- queries/
            |-- my_super_insert_query.sql
            |-- some_other_query.sql
        |-- integrity/
            |-- test1.sql
            |-- test2.sql

The integrity folder gives you the possibility to write some checks in SQL, that will ran at the end of your ETL to validate your data. Check documentation on integrity for a more detailed explanation on testing the integrity of your ETL.

This is how you would launch a project:

from sqlbucket import SQLBucket

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

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

project.run()
project.run_integrity()

This would trigger logs as below.

You can also launch a project using the sqlbucket command line interface.

Contributing

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

Metadata

Release files for sqlbucket 0.3.2.dev1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sqlbucket 0.3.2.dev1
File	Size	Uploaded
sqlbucket-0.3.2.dev1.tar.gz	12.8 kB	Feb 9, 2020	Details

Built distribution (wheel)

Table of built distributions (wheels) for sqlbucket 0.3.2.dev1
File	Interpreter	ABI	Platform	Reset
sqlbucket-0.3.2.dev1-py3-none-any.whl 13.8 kB Feb 9, 2020	Python 3	none	any	Details

Total release size: 26.6 kB

Release files / sqlbucket-0.3.2.dev1.tar.gz

Download URL	sqlbucket-0.3.2.dev1.tar.gz
Size	12.8 kB
Tags	Source
SHA-256 checksum How to use checksums	`446da3141ed29be5d9bd3bb0da052a708ca70675c37bd8fcb214cb8a7aaaebbc`
BLAKE2b-256 checksum How to use checksums	`e1829b952338a753c6928373795b9c9ae29fef92fe116fbb303bf1b4c288051f`
Upload date	Feb 9, 2020
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.8.0`

Release files / sqlbucket-0.3.2.dev1-py3-none-any.whl

Download URL	sqlbucket-0.3.2.dev1-py3-none-any.whl
Size	13.8 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`5faf059f7d5b357f4b0c98953f82088588d995a3ae93658ba50b2cdb6b8176ef`
BLAKE2b-256 checksum How to use checksums	`afc1b5d54f4189633768710c208d7bd417e36edca4227f38a906915671bbb706`
Upload date	Feb 9, 2020
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.8.0`