<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
# Firebolt Provider for Apache Airflow
[](https://github.com/firebolt-db/airflow-provider-firebolt/actions/workflows/pull-request.yml)
<img width="1114" alt="Screen Shot 2022-02-02 at 2 57 37 PM" src="https://user-images.githubusercontent.com/7674553/152251803-427f45b5-2160-4434-9f3e-431db4d3e79e.png">
This is the provider package for the `firebolt` provider. All classes for this provider package are in the `firebolt_provider` Python package.
## Contents
- <a href="#installation">Installation</a>[]()
- <a href="#configuration">Configuration</a>[]()
- <a href="#modules">Modules</a>[]()
- <a href="#operators">Operators</a>[]()
- <a href="#hooks">Hooks</a>[]()
<a id="installation"></a>
## Installation
You can install this package via
```shell
pip install airflow-provider-firebolt
```
`airflow-provider-firebolt` requires `apache-airflow` 2.0+ and `firebolt-sdk` 1.1+.
<a id="configuration"></a>
## 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](https://docs.firebolt.io/godocs/Guides/managing-your-organization/service-accounts.html#manage-service-accounts).
### 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.
<a id="modules"></a>
## Modules
<a id="operators"></a>
### Operators
[operators.firebolt.FireboltOperator](https://github.com/firebolt-db/airflow-provider-firebolt/blob/main/firebolt_provider/operators/firebolt.py) runs a provided SQL script against Firebolt and returns results.
[operators.firebolt.FireboltStartEngineOperator](https://github.com/firebolt-db/airflow-provider-firebolt/blob/main/firebolt_provider/operators/firebolt.py)
[operators.firebolt.FireboltStopEngineOperator](https://github.com/firebolt-db/airflow-provider-firebolt/blob/main/firebolt_provider/operators/firebolt.py) 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.
<a id="hooks"></a>
### Hooks
[hooks.firebolt.FireboltHook](https://github.com/firebolt-db/airflow-provider-firebolt/blob/main/firebolt_provider/hooks/firebolt.py) establishes a connection to Firebolt.
## Contributing
See: [CONTRIBUTING.MD](https://github.com/firebolt-db/airflow-provider-firebolt/tree/main/CONTRIBUTING.MD)
Raw data
{
"_id": null,
"home_page": "https://github.com/firebolt-db/airflow-provider-firebolt",
"name": "airflow-provider-firebolt",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "",
"author": "Firebolt",
"author_email": "support@firebolt.io",
"download_url": "https://files.pythonhosted.org/packages/e3/e8/a512bbe2ab2506b4490237bcba2ae29994956c80f154eb76e61bcf145cbf/airflow_provider_firebolt-0.4.1.tar.gz",
"platform": null,
"description": "<!--\n Licensed to the Apache Software Foundation (ASF) under one\n or more contributor license agreements. See the NOTICE file\n distributed with this work for additional information\n regarding copyright ownership. The ASF licenses this file\n to you under the Apache License, Version 2.0 (the\n \"License\"); you may not use this file except in compliance\n with the License. You may obtain a copy of the License at\n\n http://www.apache.org/licenses/LICENSE-2.0\n\n Unless required by applicable law or agreed to in writing,\n software distributed under the License is distributed on an\n \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY\n KIND, either express or implied. See the License for the\n specific language governing permissions and limitations\n under the License.\n -->\n\n# Firebolt Provider for Apache Airflow\n\n[](https://github.com/firebolt-db/airflow-provider-firebolt/actions/workflows/pull-request.yml)\n\n\n\n<img width=\"1114\" alt=\"Screen Shot 2022-02-02 at 2 57 37 PM\" src=\"https://user-images.githubusercontent.com/7674553/152251803-427f45b5-2160-4434-9f3e-431db4d3e79e.png\">\n\nThis is the provider package for the `firebolt` provider. All classes for this provider package are in the `firebolt_provider` Python package.\n\n## Contents\n\n- <a href=\"#installation\">Installation</a>[]()\n- <a href=\"#configuration\">Configuration</a>[]()\n- <a href=\"#modules\">Modules</a>[]()\n - <a href=\"#operators\">Operators</a>[]()\n - <a href=\"#hooks\">Hooks</a>[]()\n\n\n<a id=\"installation\"></a>\n## Installation\n\nYou can install this package via\n\n```shell\npip install airflow-provider-firebolt\n```\n\n`airflow-provider-firebolt` requires `apache-airflow` 2.0+ and `firebolt-sdk` 1.1+.\n\n\n<a id=\"configuration\"></a>\n## Configuration\n\nIn the Airflow user interface, configure a Connection for Firebolt. Configure the following fields:\n\n* `Conn Id`: `firebolt_conn_id`.\n* `Conn Type`: `Firebolt`.\n* `Client ID`: Service account ID.\n* `Client Secret`: Service account secret.\n* `Engine_Name`: Firebolt Engine Name.\n* `Account`: Name of the account you're connecting to.\n\nClient id and secret credentials can be obtained by registering a [Service account](https://docs.firebolt.io/godocs/Guides/managing-your-organization/service-accounts.html#manage-service-accounts).\n\n### Note\nIf you're accessing Firebolt UI via `app.firebolt.io` then use Username and Password instead of Client ID and Client Secret to connect.\n\n<a id=\"modules\"></a>\n## Modules\n\n\n<a id=\"operators\"></a>\n### Operators\n\n[operators.firebolt.FireboltOperator](https://github.com/firebolt-db/airflow-provider-firebolt/blob/main/firebolt_provider/operators/firebolt.py) runs a provided SQL script against Firebolt and returns results.\n\n[operators.firebolt.FireboltStartEngineOperator](https://github.com/firebolt-db/airflow-provider-firebolt/blob/main/firebolt_provider/operators/firebolt.py)\n[operators.firebolt.FireboltStopEngineOperator](https://github.com/firebolt-db/airflow-provider-firebolt/blob/main/firebolt_provider/operators/firebolt.py) 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.\n\n\n\n\n<a id=\"hooks\"></a>\n### Hooks\n\n[hooks.firebolt.FireboltHook](https://github.com/firebolt-db/airflow-provider-firebolt/blob/main/firebolt_provider/hooks/firebolt.py) establishes a connection to Firebolt.\n\n## Contributing\n\nSee: [CONTRIBUTING.MD](https://github.com/firebolt-db/airflow-provider-firebolt/tree/main/CONTRIBUTING.MD)\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "A Firebolt provider for Apache Airflow",
"version": "0.4.1",
"project_urls": {
"Bug Tracker": "https://github.com/firebolt-db/airflow-provider-firebolt/issues",
"Homepage": "https://github.com/firebolt-db/airflow-provider-firebolt"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b509988fb83324a854373da24d305e0274df0222ca3fa9d6752b1e362e3a0fdc",
"md5": "8de9d6cb33262ddd12cf09f00d06e35a",
"sha256": "a141cb3840678721fad2c2139f67f67dd5ae626e9a02d485bd670e9c265cfb37"
},
"downloads": -1,
"filename": "airflow_provider_firebolt-0.4.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8de9d6cb33262ddd12cf09f00d06e35a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 21813,
"upload_time": "2024-01-31T14:28:58",
"upload_time_iso_8601": "2024-01-31T14:28:58.958254Z",
"url": "https://files.pythonhosted.org/packages/b5/09/988fb83324a854373da24d305e0274df0222ca3fa9d6752b1e362e3a0fdc/airflow_provider_firebolt-0.4.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e3e8a512bbe2ab2506b4490237bcba2ae29994956c80f154eb76e61bcf145cbf",
"md5": "bff08bf2828e41d63fc34ac9c5b9a2f1",
"sha256": "de25681d6a8e3b57e29f633403fbc93b6c2b025636f0fd08ef588c9054235dcd"
},
"downloads": -1,
"filename": "airflow_provider_firebolt-0.4.1.tar.gz",
"has_sig": false,
"md5_digest": "bff08bf2828e41d63fc34ac9c5b9a2f1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 13652,
"upload_time": "2024-01-31T14:29:01",
"upload_time_iso_8601": "2024-01-31T14:29:01.320835Z",
"url": "https://files.pythonhosted.org/packages/e3/e8/a512bbe2ab2506b4490237bcba2ae29994956c80f154eb76e61bcf145cbf/airflow_provider_firebolt-0.4.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-31 14:29:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "firebolt-db",
"github_project": "airflow-provider-firebolt",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "airflow-provider-firebolt"
}
JSON
