Metadata-Version: 2.4
Name: apache-airflow-providers-cube
Version: 1.0.0
Summary: A Cube Apache Airflow provider package built by Cube.
Home-page: https://cube.dev/
Author: Artem Lytvynov
Author-email: artem.lytvynov@cube.dev
License: Apache License 2.0
Classifier: Framework :: Apache Airflow
Classifier: Framework :: Apache Airflow :: Provider
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: apache-airflow>=2.11.0
Requires-Dist: apache-airflow-providers-common-compat>=1.7.4
Requires-Dist: requests>=2.28.0
Requires-Dist: PyJWT>=2.6.0
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license
Dynamic: license-file
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# Airflow Cube Provider

Cube is the semantic layer for building data applications. It helps 
data engineers and application developers access data from modern data
stores, organize it into consistent definitions, and deliver it to
every application.

## Connection requirements

`CubeHook` uses `Generic` connection. So, in order to create a 
connection to a Cube you will need to create an Airflow `Generic` 
connection and specify the following required properties:

* `host` - your Cube's host (must contain schema, address and port);
* `password` - your Cube's `CUBEJS_API_SECRET`;
* `extra.security_context` - your user `securityContext` (in a Cube's terms).

Rest of the connection fields will be ignored.

> Note: the `CubeBuildOperator` uses Cube's `/cubejs-api/v1/pre-aggregations/jobs`
endpoint that is forbiden by the default. Make sure that specified 
`securityContext` and Cube's `contextToPermissions` function are 
configured in a way that allow you to run this query. See Cube's 
documentation for a more context.

## Package description

This package provides the common `CubeHook` class, the abstract 
`CubeBaseOperator`, the `CubeQueryOperator` to run analytical queries 
over a Cube and the `CubeBuildOperator` to run pre-aggregations build 
process.

## Dependencies

Python >= 3.10

| Package                                    | Version  |
|--------------------------------------------|----------|
| apache-airflow                             | >= 2.11.0 |
| apache-airflow-providers-common-compat     | >= 1.7.4  |
| PyJWT                                      | >= 2.6.0  |
| requests                                   | >= 2.28.2 |
