@cubejs-backend/dremio-driver 1.1.9 → 1.1.10

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [1.1.10](https://github.com/cube-js/cube/compare/v1.1.9...v1.1.10) (2024-12-16)
+
+
+### Features
+
+* **dremio-driver:** Add Dremio Cloud Support ([#8956](https://github.com/cube-js/cube/issues/8956)) ([d2c2fcd](https://github.com/cube-js/cube/commit/d2c2fcdaf8944ea7dd27e73b63c0b151c317022e))
+
+
+
+
+
 ## [1.1.9](https://github.com/cube-js/cube/compare/v1.1.8...v1.1.9) (2024-12-08)
 
 **Note:** Version bump only for package @cubejs-backend/dremio-driver

package/README.md

@@ -9,11 +9,26 @@
 
 Pure Javascript Dremio driver.
 
+## Dremio Cloud
+
+To use this driver with [Dremio Cloud](https://docs.dremio.com/cloud/reference/api/), use the following setup:
+
+| Environment Variable        | Value                                              |
+| --------------------------- | -------------------------------------------------- |
+| CUBEJS_DB_TYPE              | dremio                                             |
+| CUBEJS_DB_URL               | https://api.dremio.cloud/v0/projects/${PROJECT_ID} |
+| CUBEJS_DB_NAME              | ${DB_NAME}                                         |
+| CUBEJS_DB_DREMIO_AUTH_TOKEN | ${PERSONAL_ACCESS_TOKEN}                           |
+
+> [!NOTE]
+> When `CUBEJS_DB_URL` is set it takes precedence over `CUBEJS_DB_HOST` and it
+> is assumed that the driver is connecting to the Dremio Cloud API.
+
 ## Support
 
-This package is **community supported** and should be used at your own risk. 
+This package is **community supported** and should be used at your own risk.
 
-While the Cube Dev team is happy to review and accept future community contributions, we don't have active plans for further development. This includes bug fixes unless they affect different parts of Cube.js. **We're looking for maintainers for this package.** If you'd like to become a maintainer, please contact us in Cube.js Slack. 
+While the Cube Dev team is happy to review and accept future community contributions, we don't have active plans for further development. This includes bug fixes unless they affect different parts of Cube.js. **We're looking for maintainers for this package.** If you'd like to become a maintainer, please contact us in Cube.js Slack.
 
 ## License
 

package/driver/DremioDriver.js

@@ -49,6 +49,14 @@ class DremioDriver extends BaseDriver {
       assertDataSource('default');
 
     this.config = {
+      dbUrl:
+        config.dbUrl ||
+        getEnv('dbUrl', { dataSource }) ||
+        '',
+      dremioAuthToken:
+        config.dremioAuthToken ||
+        getEnv('dremioAuthToken', { dataSource }) ||
+        '',
       host:
         config.host ||
         getEnv('dbHost', { dataSource }) ||
@@ -80,11 +88,20 @@ class DremioDriver extends BaseDriver {
         getEnv('dbPollMaxInterval', { dataSource })
       ) * 1000,
     };
-    const protocol = (this.config.ssl === true || this.config.ssl === 'true')
-      ? 'https'
-      : 'http';
-    this.config.url =
-      `${protocol}://${this.config.host}:${this.config.port}`;
+
+    if (this.config.dbUrl) {
+      this.config.url = this.config.dbUrl;
+      this.config.apiVersion = '';
+      if (this.config.dremioAuthToken === '') {
+        throw new Error('dremioAuthToken is blank');
+      }
+    } else {
+      const protocol = (this.config.ssl === true || this.config.ssl === 'true')
+        ? 'https'
+        : 'http';
+      this.config.url = `${protocol}://${this.config.host}:${this.config.port}`;
+      this.config.apiVersion = '/api/v3';
+    }
   }
 
   /**
@@ -103,6 +120,20 @@ class DremioDriver extends BaseDriver {
    * @protected
    */
   async getToken() {
+    if (this.config.dremioAuthToken) {
+      const bearerToken = `Bearer ${this.config.dremioAuthToken}`;
+      await axios.get(
+        `${this.config.url}${this.config.apiVersion}/catalog`,
+        {
+          headers: {
+            Authorization: bearerToken
+          },
+        },
+      );
+
+      return bearerToken;
+    }
+
     if (this.authToken && this.authToken.expires > new Date().getTime()) {
       return `_dremio${this.authToken.token}`;
     }
@@ -129,7 +160,7 @@ class DremioDriver extends BaseDriver {
 
     return axios.request({
       method,
-      url: `${this.config.url}${url}`,
+      url: `${this.config.url}${this.config.apiVersion}${url}`,
       headers: {
         Authorization: token
       },
@@ -141,7 +172,7 @@ class DremioDriver extends BaseDriver {
    * @protected
    */
   async getJobStatus(jobId) {
-    const { data } = await this.restDremioQuery('get', `/api/v3/job/${jobId}`);
+    const { data } = await this.restDremioQuery('get', `/job/${jobId}`);
 
     if (data.jobState === 'FAILED') {
       throw new Error(data.errorMessage);
@@ -162,7 +193,7 @@ class DremioDriver extends BaseDriver {
    * @protected
    */
   async getJobResults(jobId, limit = 500, offset = 0) {
-    return this.restDremioQuery('get', `/api/v3/job/${jobId}/results?offset=${offset}&limit=${limit}`);
+    return this.restDremioQuery('get', `/job/${jobId}/results?offset=${offset}&limit=${limit}`);
   }
 
   /**
@@ -171,7 +202,7 @@ class DremioDriver extends BaseDriver {
    * @return {Promise<*>}
    */
   async executeQuery(sql) {
-    const { data } = await this.restDremioQuery('post', '/api/v3/sql', { sql });
+    const { data } = await this.restDremioQuery('post', '/sql', { sql });
     return data.id;
   }
 
@@ -216,7 +247,7 @@ class DremioDriver extends BaseDriver {
   }
 
   async refreshTablesSchema(path) {
-    const { data } = await this.restDremioQuery('get', `/api/v3/catalog/by-path/${path}`);
+    const { data } = await this.restDremioQuery('get', `/catalog/by-path/${path}`);
     if (!data || !data.children) {
       return true;
     }

package/package.json

@@ -2,7 +2,7 @@
   "name": "@cubejs-backend/dremio-driver",
   "description": "Cube.js Dremio driver",
   "author": "Cube Dev, Inc.",
-  "version": "1.1.9",
+  "version": "1.1.10",
   "repository": {
     "type": "git",
     "url": "https://github.com/cube-js/cube.git",
@@ -17,9 +17,9 @@
     "lint:fix": "eslint driver/*.js"
   },
   "dependencies": {
-    "@cubejs-backend/base-driver": "1.1.8",
-    "@cubejs-backend/schema-compiler": "1.1.9",
-    "@cubejs-backend/shared": "1.1.8",
+    "@cubejs-backend/base-driver": "1.1.10",
+    "@cubejs-backend/schema-compiler": "1.1.10",
+    "@cubejs-backend/shared": "1.1.10",
     "axios": "^0.21.1",
     "moment-timezone": "^0.5.31",
     "sqlstring": "^2.3.1"
@@ -38,5 +38,5 @@
   "eslintConfig": {
     "extends": "../cubejs-linter"
   },
-  "gitHead": "dcc46c760ef73dfb735d4b6c382e6789668a1b82"
+  "gitHead": "8ff2eca3b6424510c1fad8f30079031f6445110d"
 }