Skip to content

Commit 0659c84

Browse files
jronsseKSDaemon
andauthored
feat(drivers): introduce Apache Pinot (#8689)
* feat(driver): introduce Apache Pinot * feat(driver): add Pinot documentation * chore: publish under inthememory scope * chore: clear changelog * chore: rebase master --------- Co-authored-by: Konstantin Burkalev <[email protected]>
1 parent 0b00351 commit 0659c84

32 files changed

+1341
-30
lines changed

docs/pages/product/configuration/data-sources/_meta.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,5 +23,6 @@ module.exports = {
2323
"singlestore": "SingleStore",
2424
"snowflake": "Snowflake",
2525
"sqlite": "SQLite",
26-
"trino": "Trino"
26+
"trino": "Trino",
27+
"pinot": "Pinot"
2728
}
Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
---
2+
redirect_from:
3+
- /config/databases/pinot
4+
---
5+
6+
# Pinot
7+
8+
Apache Pinot is a real-time distributed OLAP datastore purpose-built for low-latency, high-throughput analytics, and perfect for user-facing analytical workloads
9+
10+
## Prerequisites
11+
12+
- The hostname for the [Pinot][pinot] broker
13+
- The port for the [Pinot][pinot] broker
14+
15+
## Setup
16+
17+
### Manual
18+
19+
Add the following to a `.env` file in your Cube project:
20+
21+
```dotenv
22+
CUBEJS_DB_TYPE=pinot
23+
CUBEJS_DB_HOST=http[s]://pinot.broker.host
24+
CUBEJS_DB_PORT=8099
25+
CUBEJS_DB_USER=pinot_user
26+
CUBEJS_DB_PASS=**********
27+
```
28+
29+
## Environment Variables
30+
31+
| Environment Variable | Description | Possible Values | Required |
32+
| -------------------------- | ----------------------------------------------------------------------------------- | --------------------------------------------- | :------: |
33+
| `CUBEJS_DB_HOST` | The host URL for your Pinot broker | A valid host URL ||
34+
| `CUBEJS_DB_PORT` | The port for the database connection | A valid port number ||
35+
| `CUBEJS_DB_USER` | The username used to connect to the broker | A valid username ||
36+
| `CUBEJS_DB_PASS` | The password used to connect to the broker | A valid password ||
37+
38+
## Pre-Aggregation Feature Support
39+
40+
### count_distinct_approx
41+
42+
Measures of type
43+
[`count_distinct_approx`][ref-schema-ref-types-formats-countdistinctapprox] can
44+
be used in pre-aggregations when using Pinot as a source database. To learn more
45+
about Pinot support for approximate aggregate functions, [click
46+
here][pinot-docs-approx-agg-fns].
47+
48+
## Pre-aggregation build strategies
49+
50+
<InfoBox>
51+
52+
To learn more about pre-aggregation build strategies, [head
53+
here][ref-caching-using-preaggs-build-strats].
54+
55+
</InfoBox>
56+
57+
| Feature | Works with read-only mode? | Is default? |
58+
| ------------- | :------------------------: | :---------: |
59+
| Simple |||
60+
| Batching | - | - |
61+
| Export bucket | - | - |
62+
63+
By default, Pinot uses a simple strategy to build pre-aggregations.
64+
65+
### Simple
66+
67+
No extra configuration is required to configure simple pre-aggregation builds
68+
for Pinot.
69+
70+
### Batching
71+
72+
Pinot does not support batching.
73+
74+
### Export bucket
75+
76+
Pinot does not support export buckets.
77+
78+
## SSL
79+
80+
Cube does not require any additional configuration to enable SSL as Elasticsearch connections are made over HTTPS.
81+
82+
[pinot]: https://docs.pinot.apache.org/
83+
[pinot-docs-approx-agg-fns]:
84+
https://docs.pinot.apache.org/users/user-guide-query/query-syntax/how-to-handle-unique-counting
85+
[ref-recipe-enable-ssl]:
86+
/guides/recipes/data-sources/using-ssl-connections-to-data-source
87+
[ref-schema-ref-types-formats-countdistinctapprox]: /reference/data-model/types-and-formats#count_distinct_approx

packages/cubejs-docker/dev.Dockerfile

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,7 @@ COPY packages/cubejs-questdb-driver/package.json packages/cubejs-questdb-driver/
6363
COPY packages/cubejs-materialize-driver/package.json packages/cubejs-materialize-driver/package.json
6464
COPY packages/cubejs-prestodb-driver/package.json packages/cubejs-prestodb-driver/package.json
6565
COPY packages/cubejs-trino-driver/package.json packages/cubejs-trino-driver/package.json
66+
COPY packages/cubejs-pinot-driver/package.json packages/cubejs-pinot-driver/package.json
6667
COPY packages/cubejs-query-orchestrator/package.json packages/cubejs-query-orchestrator/package.json
6768
COPY packages/cubejs-schema-compiler/package.json packages/cubejs-schema-compiler/package.json
6869
COPY packages/cubejs-server/package.json packages/cubejs-server/package.json
@@ -138,6 +139,7 @@ COPY packages/cubejs-questdb-driver/ packages/cubejs-questdb-driver/
138139
COPY packages/cubejs-materialize-driver/ packages/cubejs-materialize-driver/
139140
COPY packages/cubejs-prestodb-driver/ packages/cubejs-prestodb-driver/
140141
COPY packages/cubejs-trino-driver/ packages/cubejs-trino-driver/
142+
COPY packages/cubejs-pinot-driver/ packages/cubejs-pinot-driver/
141143
COPY packages/cubejs-query-orchestrator/ packages/cubejs-query-orchestrator/
142144
COPY packages/cubejs-schema-compiler/ packages/cubejs-schema-compiler/
143145
COPY packages/cubejs-server/ packages/cubejs-server/

packages/cubejs-docker/package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@
3535
"@cubejs-backend/snowflake-driver": "1.0.3",
3636
"@cubejs-backend/sqlite-driver": "1.0.3",
3737
"@cubejs-backend/trino-driver": "1.1.0",
38+
"@cubejs-backend/pinot-driver": "1.1.0",
3839
"cubejs-cli": "1.1.0",
3940
"typescript": "~5.2.2"
4041
},

packages/cubejs-docker/package.json.local

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@
3838
"@cubejs-backend/snowflake-driver": "file:/cube-build/packages/cubejs-snowflake-driver",
3939
"@cubejs-backend/sqlite-driver": "file:/cube-build/packages/cubejs-sqlite-driver",
4040
"@cubejs-backend/trino-driver": "file:/cube-build/packages/cubejs-trino-driver",
41+
"@cubejs-backend/pinot-driver": "file:/cube-build/packages/cubejs-pinot-driver",
4142
"cubejs-cli": "file:/cube-build/packages/cubejs-cli",
4243
"typescript": "~4.1.5"
4344
},

packages/cubejs-docker/testing-drivers.Dockerfile

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@ COPY packages/cubejs-questdb-driver/package.json packages/cubejs-questdb-driver/
5757
COPY packages/cubejs-materialize-driver/package.json packages/cubejs-materialize-driver/package.json
5858
COPY packages/cubejs-prestodb-driver/package.json packages/cubejs-prestodb-driver/package.json
5959
COPY packages/cubejs-trino-driver/package.json packages/cubejs-trino-driver/package.json
60+
COPY packages/cubejs-pinot-driver/package.json packages/cubejs-pinot-driver/package.json
6061
COPY packages/cubejs-query-orchestrator/package.json packages/cubejs-query-orchestrator/package.json
6162
COPY packages/cubejs-schema-compiler/package.json packages/cubejs-schema-compiler/package.json
6263
COPY packages/cubejs-server/package.json packages/cubejs-server/package.json
@@ -134,6 +135,7 @@ COPY packages/cubejs-questdb-driver/ packages/cubejs-questdb-driver/
134135
COPY packages/cubejs-materialize-driver/ packages/cubejs-materialize-driver/
135136
COPY packages/cubejs-prestodb-driver/ packages/cubejs-prestodb-driver/
136137
COPY packages/cubejs-trino-driver/ packages/cubejs-trino-driver/
138+
COPY packages/cubejs-pinot-driver/ packages/cubejs-pinot-driver/
137139
COPY packages/cubejs-query-orchestrator/ packages/cubejs-query-orchestrator/
138140
COPY packages/cubejs-schema-compiler/ packages/cubejs-schema-compiler/
139141
COPY packages/cubejs-server/ packages/cubejs-server/
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
dist

packages/cubejs-pinot-driver/CHANGELOG.md

Whitespace-only changes.
Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright 2018-2020 Cube Dev, Inc.
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
<p align="center"><a href="https://cube.dev"><img src="https://i.imgur.com/zYHXm4o.png" alt="Cube.js" width="300px"></a></p>
2+
3+
[Website](https://cube.dev)[Docs](https://cube.dev/docs)[Blog](https://cube.dev/blog)[Slack](https://slack.cube.dev)[Twitter](https://twitter.com/the_cube_dev)
4+
5+
[![npm version](https://badge.fury.io/js/%40cubejs-backend%2Fserver.svg)](https://badge.fury.io/js/%40cubejs-backend%2Fserver)
6+
[![GitHub Actions](https://github.com/cube-js/cube.js/workflows/Build/badge.svg)](https://github.com/cube-js/cube.js/actions?query=workflow%3ABuild+branch%3Amaster)
7+
8+
# Cube.js Pinot Database Driver
9+
10+
Cube.js Pinot driver.
11+
12+
[Learn more](https://github.com/cube-js/cube.js#getting-started)
13+
14+
### Project Status
15+
16+
In Review. [#8689](https://github.com/cube-js/cube/pull/8689)
17+
18+
### Installation
19+
20+
`npm i @inthememory/pinot-driver`
21+
22+
### Usage
23+
#### For Docker
24+
25+
Build development [docker image](https://github.com/cube-js/cube/blob/master/packages/cubejs-docker/DEVELOPMENT.md).
26+
27+
Assuming the built image is tagged `cubejs/cube:dev`
28+
29+
```
30+
FROM cubejs/cube:dev
31+
RUN npm i @inthememory/pinot-driver
32+
```
33+
34+
```
35+
environment:
36+
- CUBEJS_DB_TYPE=pinot
37+
- CUBEJS_DB_HOST= #broker_host
38+
- CUBEJS_DB_PORT= #broker_port
39+
- CUBEJS_DB_USER= #database user
40+
- CUBEJS_DB_PASS= #database password
41+
- CUBEJS_DEV_MODE=true #if running locally
42+
```
43+
44+
### License
45+
46+
Cube.js Pinot Database Driver is [Apache 2.0 licensed](./LICENSE).

0 commit comments

Comments
 (0)