airflow-provider-firebolt

Firebolt Provider for Apache Airflow

This is the provider package for the firebolt provider. All classes for this provider package are in the firebolt_provider Python package.

Contents

• Installation
• Configuration
• Modules
  • Operators
  • Hooks

Installation

You can install this package via

pip install airflow-provider-firebolt

airflow-provider-firebolt requires apache-airflow 2.0+ and firebolt-sdk 1.1+.

Configuration

In the Airflow user interface, configure a Connection for Firebolt. Configure the following fields:

• Conn Id: firebolt_conn_id.
• Conn Type: Firebolt.
• Client ID: Service account ID.
• Client Secret: Service account secret.
• Engine_Name: Firebolt Engine Name.
• Account: Name of the account you're connecting to.

Client id and secret credentials can be obtained by registering a Service account.

Note

If you're accessing Firebolt UI via app.firebolt.io then use Username and Password instead of Client ID and Client Secret to connect.

Modules

Operators

operators.firebolt.FireboltOperator runs a provided SQL script against Firebolt and returns results.

operators.firebolt.FireboltStartEngineOperator operators.firebolt.FireboltStopEngineOperator starts/stops the specified engine, and waits until it is actually started/stopped. If the engine_name is not specified, it will use the engine_name from the connection, if it also not specified it will start the default engine of the connection database. Note: start/stop operator requires actual engine name, if engine URL is specified instead, start/stop engine operators will not be able to handle it correctly.

Hooks

hooks.firebolt.FireboltHook establishes a connection to Firebolt.

Contributing

See: CONTRIBUTING.MD