prefect-firebolt

Welcome!

prefect-firebolt is a collection of Prefect integrations for working with Firebolt data warehouses.

Firebolt is a Cloud Data Warehousing solution that helps its users streamline their Data Analytics and access to insights. For more information about getting started with Firebolt, read Firebolt's getting started guide.

Getting Started

Python setup

Requires an installation of Python 3.7+.

We recommend using a Python virtual environment manager such as pipenv, conda or virtualenv.

These tasks are designed to work with Prefect 2.0. For more information about how to use Prefect, please refer to the Prefect documentation.

Installation

Install prefect-firebolt with pip:

pip install prefect-firebolt

Then, register to view the Firebolt blocks on Prefect Cloud:

prefect block register -m prefect_firebolt

Note, to use the load method on Blocks, you must already have a block document saved through code or saved through the UI.

Write and run a flow

Execute a query against a Firebolt database:

from prefect import flow

from prefect_firebolt import FireboltCredentials, FireboltDatabase, query_firebolt


@flow
def run_firebolt_query():
    firebolt_database_block = FireboltDatabase(
        database="travel",
        credentials=FireboltCredentials(
            username="arthur.dent@hitchhikers.com", password="dont42panic"
        ),
    )

    results = query_firebolt(
        database=firebolt_database_block,
        query="SELECT * FROM ex_intergalactic_trips LIMIT 100",
    )

    return results


run_firebolt_query()        

Resources

If you encounter any bugs while using prefect-firebolt, feel free to open an issue in the prefect-firebolt repository.

If you have any questions or issues while using prefect-firebolt, you can find help in either the Prefect Discourse forum or the Prefect Slack community.

Feel free to ⭐️ or watch prefect-firebolt for updates too!

Development

If you'd like to install a version of prefect-firebolt for development, clone the repository and perform an editable install with pip:

git clone https://github.com/PrefectHQ/prefect-firebolt.git

cd prefect-firebolt/

pip install -e ".[dev]"

# Install linting pre-commit hooks
pre-commit install