Skip to content

Commit f0263ff

Browse files
author
vincent.mathon
committed
feat(flightsql-jdbc): Add support for Arrow Flight JDBC driver (#8829)
1 parent 24d1177 commit f0263ff

File tree

22 files changed

+586
-26741
lines changed

22 files changed

+586
-26741
lines changed

.github/workflows/drivers-tests.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ on:
2020
- 'packages/cubejs-bigquery-driver/**'
2121
- 'packages/cubejs-clickhouse-driver/**'
2222
- 'packages/cubejs-databricks-jdbc-driver/**'
23+
- 'packages/cubejs-flightsql-jdbc-driver/**'
2324
- 'packages/cubejs-mssql-driver/**'
2425
- 'packages/cubejs-mysql-driver/**'
2526
- 'packages/cubejs-postgres-driver/**'
@@ -47,6 +48,7 @@ on:
4748
- 'packages/cubejs-bigquery-driver/**'
4849
- 'packages/cubejs-clickhouse-driver/**'
4950
- 'packages/cubejs-databricks-jdbc-driver/**'
51+
- 'packages/cubejs-flightsql-jdbc-driver/**'
5052
- 'packages/cubejs-mssql-driver/**'
5153
- 'packages/cubejs-mysql-driver/**'
5254
- 'packages/cubejs-postgres-driver/**'

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
module.exports = {
2+
"arrowflight-sql": "Arrow flight SQL",
23
"aws-athena": "Amazon Athena",
34
"aws-redshift": "Amazon Redshift",
45
"pinot": "Apache Pinot",
Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# Arrowflight SQL JDBC
2+
3+
[Arrow Flight SQL][arrowflight-sql] is a protocol for interacting with SQL databases using the Arrow in-memory format and the Flight RPC framework.
4+
We provide an integration of cubejs with such a database using the [Arrow Flight SQL JDBC Driver](https://arrow.apache.org/docs/java/flight_sql_jdbc_driver.html)
5+
6+
Examples of products supporting Arrow Flight SQL:
7+
- [Dremio][dremio]
8+
- [Apache Doris][apache-doris]
9+
- [Clickhouse][clickhouse]
10+
- [Spice.ai][spiceai]
11+
- [InfluxDB][influxdb]
12+
13+
## Prerequisites
14+
15+
- [A JDK installation][gh-cubejs-jdbc-install]
16+
- The [JDBC URL][arrowflight-sql-jdbc-driver] for the [Arrowflight][arrowflight-sql] database
17+
18+
## Setup
19+
20+
Add the following to a `.env` file in your Cube project:
21+
22+
```dotenv
23+
CUBEJS_DB_TYPE=flightsql-jdbc
24+
# CUBEJS_DB_NAME is optional
25+
CUBEJS_DB_NAME=default
26+
CUBEJS_DB_HOST=localhost
27+
CUBEJS_DB_PORT=50051
28+
```
29+
30+
## Environment Variables
31+
32+
| Environment Variable | Description | Possible Values |
33+
|-----------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------|
34+
| `CUBEJS_DB_TYPE` | The Cube.js database type | flightsql-jdbc |
35+
| `CUBEJS_JDBC_URL` | The URL for the JDBC connection for full control of the settings. If not set default to jdbc:arrow-flight-sql://CUBEJS_DB_HOST:CUBEJS_DB_PORT/CUBEJS_DB_NAME | A valid Arrow flight JDBC URL |
36+
| `CUBEJS_DB_NAME` | The name of the database to connect to, default to 'default' | A valid database name |
37+
| `CUBEJS_DB_HOST` | The database host | A valid database host |
38+
| `CUBEJS_DB_PORT` | The database port, default to 50051 | A valid port |
39+
| `CUBEJS_FLIGHT_SQL_API_KEY` | The database API key, default to '' | A valid API key |
40+
| `CUBEJS_FLIGHT_SQL_USE_ENCRYPTION` | Whether to use TLS or not, default to false | 'true' or 'false' |
41+
| `CUBEJS_FLIGHT_SQL_DISABLE_CERT_VERIFICATION` | Whether to disable certificate validation or not when TLS is used, default to true | 'true' or 'false' |
42+
| `ARROW_FLIGHT_SQL_DRIVER_VERSION` | The version of the arrow flight JDBC driver to use, default to 18.3.0 | see [Maven repository][maven-flight-sql-jdbc-driver] |
43+
44+
45+
[arrowflight-sql]: https://arrow.apache.org/docs/java/flight_sql.html
46+
[arrowflight-sql-jdbc-driver]: https://arrow.apache.org/docs/java/flight_sql_jdbc_driver.html
47+
[gh-cubejs-jdbc-install]: https://github.com/cube-js/cube/blob/master/packages/cubejs-jdbc-driver/README.md#java-installation
48+
[maven-flight-sql-jdbc-driver]: https://central.sonatype.com/artifact/org.apache.arrow/flight-sql-jdbc-driver
49+
[dremio]: https://docs.dremio.com/current/client-applications/drivers/arrow-flight-sql-jdbc-driver
50+
[apache-doris]: https://doris.apache.org/docs/3.0/db-connect/arrow-flight-sql-connect
51+
[clickhouse]: https://clickhouse.com/docs/interfaces/arrowflight
52+
[spiceai]: https://spiceai.org/docs/api/jdbc
53+
[influxdb]: https://docs.influxdata.com/influxdb3/cloud-dedicated/reference/client-libraries/flight/java-flightsql

packages/cubejs-docker/dev.Dockerfile

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,10 +100,14 @@ FROM base AS prod_base_dependencies
100100
COPY packages/cubejs-databricks-jdbc-driver/package.json packages/cubejs-databricks-jdbc-driver/package.json
101101
RUN mkdir packages/cubejs-databricks-jdbc-driver/bin
102102
RUN echo '#!/usr/bin/env node' > packages/cubejs-databricks-jdbc-driver/bin/post-install
103+
COPY packages/cubejs-flightsql-jdbc-driver/package.json packages/cubejs-flightsql-jdbc-driver/package.json
104+
RUN mkdir packages/cubejs-flightsql-jdbc-driver/bin
105+
RUN echo '#!/usr/bin/env node' > packages/cubejs-flightsql-jdbc-driver/bin/post-install
103106
RUN yarn install --prod
104107

105108
FROM prod_base_dependencies AS prod_dependencies
106109
COPY packages/cubejs-databricks-jdbc-driver/bin packages/cubejs-databricks-jdbc-driver/bin
110+
COPY packages/cubejs-flightsql-jdbc-driver/bin packages/cubejs-flightsql-jdbc-driver/bin
107111
RUN yarn install --prod --ignore-scripts
108112

109113
FROM base AS build
@@ -152,6 +156,7 @@ COPY packages/cubejs-ksql-driver/ packages/cubejs-ksql-driver/
152156
COPY packages/cubejs-dbt-schema-extension/ packages/cubejs-dbt-schema-extension/
153157
COPY packages/cubejs-jdbc-driver/ packages/cubejs-jdbc-driver/
154158
COPY packages/cubejs-databricks-jdbc-driver/ packages/cubejs-databricks-jdbc-driver/
159+
COPY packages/cubejs-flightsql-jdbc-driver/ packages/cubejs-flightsql-jdbc-driver/
155160
COPY packages/cubejs-vertica-driver/ packages/cubejs-vertica-driver/
156161
# Skip
157162
# COPY packages/cubejs-testing/ packages/cubejs-testing/

packages/cubejs-docker/testing-drivers.Dockerfile

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,10 +92,14 @@ FROM base AS prod_base_dependencies
9292
COPY packages/cubejs-databricks-jdbc-driver/package.json packages/cubejs-databricks-jdbc-driver/package.json
9393
RUN mkdir packages/cubejs-databricks-jdbc-driver/bin
9494
RUN echo '#!/usr/bin/env node' > packages/cubejs-databricks-jdbc-driver/bin/post-install
95+
COPY packages/cubejs-flightsql-jdbc-driver/package.json packages/cubejs-flightsql-jdbc-driver/package.json
96+
RUN mkdir packages/cubejs-flightsql-jdbc-driver/bin
97+
RUN echo '#!/usr/bin/env node' > packages/cubejs-flightsql-jdbc-driver/bin/post-install
9598
RUN yarn install --prod
9699

97100
FROM prod_base_dependencies AS prod_dependencies
98101
COPY packages/cubejs-databricks-jdbc-driver/bin packages/cubejs-databricks-jdbc-driver/bin
102+
COPY packages/cubejs-flightsql-jdbc-driver/bin packages/cubejs-flightsql-jdbc-driver/bin
99103
RUN yarn install --prod --ignore-scripts
100104

101105
######################################################################
@@ -147,6 +151,7 @@ COPY packages/cubejs-ksql-driver/ packages/cubejs-ksql-driver/
147151
COPY packages/cubejs-dbt-schema-extension/ packages/cubejs-dbt-schema-extension/
148152
COPY packages/cubejs-jdbc-driver/ packages/cubejs-jdbc-driver/
149153
COPY packages/cubejs-databricks-jdbc-driver/ packages/cubejs-databricks-jdbc-driver/
154+
COPY packages/cubejs-flightsql-jdbc-driver/ packages/cubejs-flightsql-jdbc-driver/
150155
COPY packages/cubejs-vertica-driver/ packages/cubejs-vertica-driver/
151156

152157
# We dont need client libraries
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
download
2+
dist
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.

0 commit comments

Comments
 (0)