diff --git a/.github/workflows/drivers-tests.yml b/.github/workflows/drivers-tests.yml index 263a61fbc8045..9f20ec406b606 100644 --- a/.github/workflows/drivers-tests.yml +++ b/.github/workflows/drivers-tests.yml @@ -20,6 +20,7 @@ on: - 'packages/cubejs-bigquery-driver/**' - 'packages/cubejs-clickhouse-driver/**' - 'packages/cubejs-databricks-jdbc-driver/**' + - 'packages/cubejs-flightsql-jdbc-driver/**' - 'packages/cubejs-mssql-driver/**' - 'packages/cubejs-mysql-driver/**' - 'packages/cubejs-postgres-driver/**' @@ -47,6 +48,7 @@ on: - 'packages/cubejs-bigquery-driver/**' - 'packages/cubejs-clickhouse-driver/**' - 'packages/cubejs-databricks-jdbc-driver/**' + - 'packages/cubejs-flightsql-jdbc-driver/**' - 'packages/cubejs-mssql-driver/**' - 'packages/cubejs-mysql-driver/**' - 'packages/cubejs-postgres-driver/**' diff --git a/packages/cubejs-docker/dev.Dockerfile b/packages/cubejs-docker/dev.Dockerfile index 737c3b806d75a..5519da9eb9917 100644 --- a/packages/cubejs-docker/dev.Dockerfile +++ b/packages/cubejs-docker/dev.Dockerfile @@ -100,10 +100,14 @@ FROM base AS prod_base_dependencies COPY packages/cubejs-databricks-jdbc-driver/package.json packages/cubejs-databricks-jdbc-driver/package.json RUN mkdir packages/cubejs-databricks-jdbc-driver/bin RUN echo '#!/usr/bin/env node' > packages/cubejs-databricks-jdbc-driver/bin/post-install +COPY packages/cubejs-flightsql-jdbc-driver/package.json packages/cubejs-flightsql-jdbc-driver/package.json +RUN mkdir packages/cubejs-flightsql-jdbc-driver/bin +RUN echo '#!/usr/bin/env node' > packages/cubejs-flightsql-jdbc-driver/bin/post-install RUN yarn install --prod FROM prod_base_dependencies AS prod_dependencies COPY packages/cubejs-databricks-jdbc-driver/bin packages/cubejs-databricks-jdbc-driver/bin +COPY packages/cubejs-flightsql-jdbc-driver/bin packages/cubejs-flightsql-jdbc-driver/bin RUN yarn install --prod --ignore-scripts FROM base AS build @@ -152,6 +156,7 @@ COPY packages/cubejs-ksql-driver/ packages/cubejs-ksql-driver/ COPY packages/cubejs-dbt-schema-extension/ packages/cubejs-dbt-schema-extension/ COPY packages/cubejs-jdbc-driver/ packages/cubejs-jdbc-driver/ COPY packages/cubejs-databricks-jdbc-driver/ packages/cubejs-databricks-jdbc-driver/ +COPY packages/cubejs-flightsql-jdbc-driver/ packages/cubejs-flightsql-jdbc-driver/ COPY packages/cubejs-vertica-driver/ packages/cubejs-vertica-driver/ # Skip # COPY packages/cubejs-testing/ packages/cubejs-testing/ diff --git a/packages/cubejs-docker/testing-drivers.Dockerfile b/packages/cubejs-docker/testing-drivers.Dockerfile index 1332143538399..c91a004990b19 100644 --- a/packages/cubejs-docker/testing-drivers.Dockerfile +++ b/packages/cubejs-docker/testing-drivers.Dockerfile @@ -92,10 +92,14 @@ FROM base AS prod_base_dependencies COPY packages/cubejs-databricks-jdbc-driver/package.json packages/cubejs-databricks-jdbc-driver/package.json RUN mkdir packages/cubejs-databricks-jdbc-driver/bin RUN echo '#!/usr/bin/env node' > packages/cubejs-databricks-jdbc-driver/bin/post-install +COPY packages/cubejs-flightsql-jdbc-driver/package.json packages/cubejs-flightsql-jdbc-driver/package.json +RUN mkdir packages/cubejs-flightsql-jdbc-driver/bin +RUN echo '#!/usr/bin/env node' > packages/cubejs-flightsql-jdbc-driver/bin/post-install RUN yarn install --prod FROM prod_base_dependencies AS prod_dependencies COPY packages/cubejs-databricks-jdbc-driver/bin packages/cubejs-databricks-jdbc-driver/bin +COPY packages/cubejs-flightsql-jdbc-driver/bin packages/cubejs-flightsql-jdbc-driver/bin RUN yarn install --prod --ignore-scripts ###################################################################### @@ -147,6 +151,7 @@ COPY packages/cubejs-ksql-driver/ packages/cubejs-ksql-driver/ COPY packages/cubejs-dbt-schema-extension/ packages/cubejs-dbt-schema-extension/ COPY packages/cubejs-jdbc-driver/ packages/cubejs-jdbc-driver/ COPY packages/cubejs-databricks-jdbc-driver/ packages/cubejs-databricks-jdbc-driver/ +COPY packages/cubejs-flightsql-jdbc-driver/ packages/cubejs-flightsql-jdbc-driver/ COPY packages/cubejs-vertica-driver/ packages/cubejs-vertica-driver/ # We dont need client libraries diff --git a/packages/cubejs-flightsql-jdbc-driver/.gitignore b/packages/cubejs-flightsql-jdbc-driver/.gitignore new file mode 100644 index 0000000000000..291bc2be5b3a4 --- /dev/null +++ b/packages/cubejs-flightsql-jdbc-driver/.gitignore @@ -0,0 +1,2 @@ +download +dist diff --git a/packages/cubejs-flightsql-jdbc-driver/LICENSE b/packages/cubejs-flightsql-jdbc-driver/LICENSE new file mode 100644 index 0000000000000..da67a9a3301be --- /dev/null +++ b/packages/cubejs-flightsql-jdbc-driver/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2018-2020 Cube Dev, Inc. + + Licensed 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. \ No newline at end of file diff --git a/packages/cubejs-flightsql-jdbc-driver/README.md b/packages/cubejs-flightsql-jdbc-driver/README.md new file mode 100644 index 0000000000000..89de5362b5e47 --- /dev/null +++ b/packages/cubejs-flightsql-jdbc-driver/README.md @@ -0,0 +1,27 @@ +

Cube.js

+ +[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) + +[![npm version](https://badge.fury.io/js/%40cubejs-backend%2Fserver.svg)](https://badge.fury.io/js/%40cubejs-backend%2Fserver) +[![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) + +# Cube.js Arrow Flight SQL Database Driver + +This driver is based on top of Arrow Flight SQL JDBC driver. + +[Learn more](https://arrow.apache.org/docs/format/FlightSql.html) + +### Testing + +To test follow the following steps + +``` +$ yarn +$ yarn test +``` + +Note: Unit tests requires Java to be installed. + +### License + +Cube.js Databricks Database Driver is [Apache 2.0 licensed](./LICENSE). diff --git a/packages/cubejs-flightsql-jdbc-driver/bin/post-install b/packages/cubejs-flightsql-jdbc-driver/bin/post-install new file mode 100755 index 0000000000000..c569e3bb12802 --- /dev/null +++ b/packages/cubejs-flightsql-jdbc-driver/bin/post-install @@ -0,0 +1,11 @@ +#!/usr/bin/env node + +const fs = require('fs'); +const path = require('path'); + +if (!fs.existsSync(path.join(__dirname, '..', 'dist', 'src', 'post-install.js')) && fs.existsSync(path.join(__dirname, '..', 'tsconfig.json'))) { + console.log('Skipping post-install because it was not compiled'); + return; +} + +require('../dist/src/post-install'); diff --git a/packages/cubejs-flightsql-jdbc-driver/jest.config.js b/packages/cubejs-flightsql-jdbc-driver/jest.config.js new file mode 100644 index 0000000000000..4611f9c2f14da --- /dev/null +++ b/packages/cubejs-flightsql-jdbc-driver/jest.config.js @@ -0,0 +1,7 @@ +const base = require('../../jest.base.config'); + +/** @type {import('jest').Config} */ +module.exports = { + ...base, + rootDir: '.', +}; diff --git a/packages/cubejs-flightsql-jdbc-driver/package.json b/packages/cubejs-flightsql-jdbc-driver/package.json new file mode 100644 index 0000000000000..d1e685fd51603 --- /dev/null +++ b/packages/cubejs-flightsql-jdbc-driver/package.json @@ -0,0 +1,55 @@ +{ + "name": "@cubejs-backend/flightsql-jdbc-driver", + "description": "Cube.js Arrow flight SQL database driver", + "author": "Cube Dev, Inc.", + "version": "1.3.39", + "license": "Apache-2.0", + "repository": { + "type": "git", + "url": "https://github.com/cube-js/cube.git", + "directory": "packages/cubejs-flightsql-jdbc-driver" + }, + "engines": { + "node": "^14.0.0 || ^16.0.0 || >=17.0.0" + }, + "main": "dist/src/index.js", + "typings": "dist/src/index.d.ts", + "scripts": { + "build": "rm -rf dist && npm run tsc", + "tsc": "tsc", + "watch": "tsc -w", + "test": "npm run unit-tests", + "unit-tests": "jest dist/test --forceExit", + "lint": "eslint src/* test/ --ext .ts", + "lint:fix": "eslint --fix src/* test/ --ext .ts", + "postinstall": "node bin/post-install" + }, + "files": [ + "README.md", + "dist/src/*", + "bin" + ], + "dependencies": { + "@cubejs-backend/base-driver": "1.3.39", + "@cubejs-backend/jdbc-driver": "1.3.39", + "@cubejs-backend/schema-compiler": "1.3.39", + "@cubejs-backend/shared": "1.3.39", + "source-map-support": "^0.5.19", + "node-fetch": "^2.6.1" + }, + "devDependencies": { + "@cubejs-backend/linter": "1.3.39", + "@cubejs-backend/testing-shared": "1.3.39", + "@types/generic-pool": "^3.8.2", + "@types/jest": "^29", + "jest": "^29", + "testcontainers": "^10.28.0", + "typescript": "~5.2.2" + }, + "publishConfig": { + "access": "public" + }, + "eslintConfig": { + "extends": "../cubejs-linter" + } +} diff --git a/packages/cubejs-flightsql-jdbc-driver/src/ArrowFlightSQLJdbcDriver.ts b/packages/cubejs-flightsql-jdbc-driver/src/ArrowFlightSQLJdbcDriver.ts new file mode 100644 index 0000000000000..635753f40e1e6 --- /dev/null +++ b/packages/cubejs-flightsql-jdbc-driver/src/ArrowFlightSQLJdbcDriver.ts @@ -0,0 +1,113 @@ +/** + * @copyright Cube Dev, Inc. + * @license Apache-2.0 + * @fileoverview The `ArrowFlightSQLJdbcDriver`. + */ + +import { JDBCDriver, JDBCDriverConfiguration, } from '@cubejs-backend/jdbc-driver'; +import fs from 'fs'; +import path from 'path'; +import { assertDataSource, downloadAndExtractFile, getEnv } from '@cubejs-backend/shared'; + +export const OSS_DRIVER_VERSION = '18.3.0'; + +async function fileExistsOr( + fsPath: string, + fn: () => Promise, +): Promise { + if (fs.existsSync(fsPath)) { + return fsPath; + } + return fn(); +} + +async function downloadJDBCDriver(): Promise { + await downloadAndExtractFile( + `https://repo1.maven.org/maven2/org/apache/arrow/flight-sql-jdbc-driver/${OSS_DRIVER_VERSION}/flight-sql-jdbc-driver-${OSS_DRIVER_VERSION}.jar`, + { + showProgress: false, + cwd: path.resolve(path.join(__dirname, '..', 'download')), + skipExtract: true, + dstFileName: `flight-sql-jdbc-driver-${OSS_DRIVER_VERSION}.jar`, + } + ); + + return path.resolve(path.join(__dirname, '..', 'download', `flight-sql-jdbc-driver-${OSS_DRIVER_VERSION}.jar`)); +} + +export async function resolveJDBCDriver(): Promise { + return fileExistsOr( + path.join(process.cwd(), `flight-sql-jdbc-driver-${OSS_DRIVER_VERSION}.jar`), + async () => fileExistsOr( + path.join(__dirname, '..', 'download', `flight-sql-jdbc-driver-${OSS_DRIVER_VERSION}.jar`), + async () => { + const pathOrNull = await downloadJDBCDriver(); + if (pathOrNull) { + return pathOrNull; + } + throw new Error( + `Please download and place flight-sql-jdbc-driver-${OSS_DRIVER_VERSION}.jar inside your ` + + 'project directory' + ); + } + ) + ); +} + +/** + * ArrowFlightSQLJdbcDriver driver class. + */ +export class ArrowFlightSQLJdbcDriver extends JDBCDriver { + protected readonly config: JDBCDriverConfiguration; + + public constructor( + conf: Partial & { + /** + * Data source name. + */ + dataSource?: string, + + /** + * Max pool size value for the [cube]<-->[db] pool. + */ + maxPoolSize?: number, + + /** + * Time to wait for a response from a connection after validation + * request before determining it as not valid. Default - 10000 ms. + */ + testConnectionTimeout?: number, + } = {}, + ) { + const dataSource = + conf.dataSource || + assertDataSource('default'); + + const url: string = + conf?.url || + getEnv('jdbcUrl', { dataSource }) || + `jdbc:arrow-flight-sql://${process.env.CUBEJS_DB_HOST}:${process.env.CUBEJS_DB_PORT || '50051'}/${process.env.CUBEJS_DB_NAME}`; + + const config: JDBCDriverConfiguration = { + ...conf, + database: getEnv('dbName', { required: false, dataSource }), + dbType: 'flightsql-jdbc', + url, + drivername: 'org.apache.arrow.driver.jdbc.ArrowFlightJdbcDriver', + customClassPath: undefined, + properties: { + user: '', // user is always empty but part of jdbc API + password: process.env.CUBEJS_FLIGHT_SQL_API_KEY || '', + useEncryption: process.env.CUBEJS_FLIGHT_SQL_USE_ENCRYPTION || 'false', + disableCertificateVerification: process.env.CUBEJS_FLIGHT_SQL_DISABLE_CERT_VERIFICATION || 'true', + } + }; + + super(config); + this.config = config; + } + + protected override async getCustomClassPath() { + return resolveJDBCDriver(); + } +} diff --git a/packages/cubejs-flightsql-jdbc-driver/src/index.ts b/packages/cubejs-flightsql-jdbc-driver/src/index.ts new file mode 100644 index 0000000000000..93b0c22ff9757 --- /dev/null +++ b/packages/cubejs-flightsql-jdbc-driver/src/index.ts @@ -0,0 +1,4 @@ +import { ArrowFlightSQLJdbcDriver } from './ArrowFlightSQLJdbcDriver'; + +export default ArrowFlightSQLJdbcDriver; +export { ArrowFlightSQLJdbcDriver }; diff --git a/packages/cubejs-flightsql-jdbc-driver/src/post-install.ts b/packages/cubejs-flightsql-jdbc-driver/src/post-install.ts new file mode 100644 index 0000000000000..6a25e8c5f0035 --- /dev/null +++ b/packages/cubejs-flightsql-jdbc-driver/src/post-install.ts @@ -0,0 +1,12 @@ +import 'source-map-support/register'; + +import { displayCLIError } from '@cubejs-backend/shared'; +import { resolveJDBCDriver } from './ArrowFlightSQLJdbcDriver'; + +(async () => { + try { + await resolveJDBCDriver(); + } catch (e: any) { + await displayCLIError(e, 'Cube.js Arrow Flight SQL JDBC Installer'); + } +})(); diff --git a/packages/cubejs-flightsql-jdbc-driver/test/ArrowFlightSQLJdbcDriver.test.ts b/packages/cubejs-flightsql-jdbc-driver/test/ArrowFlightSQLJdbcDriver.test.ts new file mode 100644 index 0000000000000..5aea477d44237 --- /dev/null +++ b/packages/cubejs-flightsql-jdbc-driver/test/ArrowFlightSQLJdbcDriver.test.ts @@ -0,0 +1,49 @@ +import { GenericContainer, StartedTestContainer, Wait } from 'testcontainers'; +import { JDBCDriver } from '@cubejs-backend/jdbc-driver'; +import { ArrowFlightSQLJdbcDriver } from '../src'; + +describe('ArrowFlightSQLJdbcDriver', () => { + let container: StartedTestContainer; + let driver: JDBCDriver; + + jest.setTimeout(2 * 60 * 1000); + + beforeAll(async () => { + const containerImage = await GenericContainer + .fromDockerfile('./test', 'Dockerfile.spiceai') + .build(); + container = await containerImage + .withCopyFilesToContainer([{ + source: './test/spicepod.yaml', + target: '/app/spicepod.yaml' + }, { + source: './test/yellow_tripdata_2024-01_499.parquet', + target: '/app/yellow_tripdata_2024-01_499.parquet' + }]) + .withExposedPorts(50051) + .withWaitStrategy(Wait.forLogMessage('All components are loaded. Spice runtime is ready!')) + .withStartupTimeout(10 * 1000) + .start(); + + driver = new ArrowFlightSQLJdbcDriver({ + url: `jdbc:arrow-flight-sql://${container.getHost()}:${container.getMappedPort(50051)}`, + properties: { + password: '' + } + }); + }); + + test('testConnection', async () => { + await driver.testConnection(); + }); + + test('query', async () => { + const count = await driver.query('select count(*) from public.yellow_taxis;', []); + expect(count).toEqual([{ 'count(*)': '499' }]); + }); + + afterAll(async () => { + await driver.release(); + await container.stop(); + }); +}); diff --git a/packages/cubejs-flightsql-jdbc-driver/test/Dockerfile.spiceai b/packages/cubejs-flightsql-jdbc-driver/test/Dockerfile.spiceai new file mode 100644 index 0000000000000..78674e81402f5 --- /dev/null +++ b/packages/cubejs-flightsql-jdbc-driver/test/Dockerfile.spiceai @@ -0,0 +1,11 @@ +FROM spiceai/spiceai:1.4.0 + +# Copy the Spicepod configuration file +COPY spicepod.yaml /app/spicepod.yaml + +# Spice runtime start-up arguments +CMD ["--http","0.0.0.0:8090","--metrics", "0.0.0.0:9090","--flight","0.0.0.0:50051"] + +EXPOSE 8090 +EXPOSE 9090 +EXPOSE 50051 diff --git a/packages/cubejs-flightsql-jdbc-driver/test/spicepod.yaml b/packages/cubejs-flightsql-jdbc-driver/test/spicepod.yaml new file mode 100644 index 0000000000000..29d154af3eabc --- /dev/null +++ b/packages/cubejs-flightsql-jdbc-driver/test/spicepod.yaml @@ -0,0 +1,7 @@ +version: v1 +kind: Spicepod +name: cube-flightsql-test + +datasets: + - from: file://yellow_tripdata_2024-01_499.parquet + name: yellow_taxis diff --git a/packages/cubejs-flightsql-jdbc-driver/test/yellow_tripdata_2024-01_499.parquet b/packages/cubejs-flightsql-jdbc-driver/test/yellow_tripdata_2024-01_499.parquet new file mode 100644 index 0000000000000..4755fea45aa42 Binary files /dev/null and b/packages/cubejs-flightsql-jdbc-driver/test/yellow_tripdata_2024-01_499.parquet differ diff --git a/packages/cubejs-flightsql-jdbc-driver/tsconfig.json b/packages/cubejs-flightsql-jdbc-driver/tsconfig.json new file mode 100644 index 0000000000000..889114bc38306 --- /dev/null +++ b/packages/cubejs-flightsql-jdbc-driver/tsconfig.json @@ -0,0 +1,12 @@ +{ + "extends": "../../tsconfig.base.json", + "include": [ + "src", + "test" + ], + "compilerOptions": { + "outDir": "dist", + "rootDir": ".", + "baseUrl": "." + } +} diff --git a/packages/cubejs-server-core/src/core/DriverDependencies.js b/packages/cubejs-server-core/src/core/DriverDependencies.js index 2c500681aa4f4..00416ef79ea32 100644 --- a/packages/cubejs-server-core/src/core/DriverDependencies.js +++ b/packages/cubejs-server-core/src/core/DriverDependencies.js @@ -30,4 +30,5 @@ module.exports = { pinot: '@cubejs-backend/pinot-driver', // List for JDBC drivers 'databricks-jdbc': '@cubejs-backend/databricks-jdbc-driver', + 'flightsql-jdbc': '@cubejs-backend/flightsql-jdbc-driver', }; diff --git a/tsconfig.json b/tsconfig.json index aa6ec37cefcb6..50fb14e16d280 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -103,6 +103,9 @@ { "path": "packages/cubejs-databricks-jdbc-driver" }, + { + "path": "packages/cubejs-flightsql-jdbc-driver" + }, { "path": "packages/cubejs-prestodb-driver" },