feat(vertica-driver): Introduce VerticaDriver (#9081)

* feat(vertica-driver): VerticaDriver

* fixed linter error

* fix dependencies versions

* driver & smoke tests

* vertica driver added to integration tests

* add vertica to smoke test

* update packages

* vertica driver published

* vertica driver

* update README.md

* docker installation instruction

* up version

* update README and package refs

* add cube build pipeline

* remove

* Added Query Implementation (#2)

* Added custom dialect for CubeDriver

* Sql fixes (#5)

* Additional sql fixes (#6)

* draft

* update test

* fix build

* update vertica driver dependencies

* vertica documentation

* add vertica to data sources

* fix lint errors

* update jest

* include vertica tests

* update wait strategy and test shared package

* change version of vertica driver

* some ci-related fixes

* fix version, names, refs to align with the Cube repo

* update yarn.lock

* fix old refs

---------

Co-authored-by: Eduard Karacharov <[email protected]>
Co-authored-by: timbrownls20 <[email protected]>
Co-authored-by: Roger <[email protected]>
Co-authored-by: David O'Bryen <[email protected]>

Author: 5 people

.github/actions/integration/vertica.sh

@@ -0,0 +1,12 @@
+#!/bin/bash
+set -eo pipefail
+
+# Debug log for test containers
+export DEBUG=testcontainers
+
+export TEST_VERTICA_VERSION=12.0.4-0
+
+echo "::group::Vertica ${TEST_VERTICA_VERSION}"
+docker pull vertica/vertica-ce:${TEST_VERTICA_VERSION}
+yarn lerna run --concurrency 1 --stream --no-prefix integration:vertica
+echo "::endgroup::"

.github/actions/smoke.sh

@@ -57,6 +57,10 @@ echo "::group::MongoBI"
 yarn lerna run --concurrency 1 --stream --no-prefix smoke:mongobi
 echo "::endgroup::"
 
+echo "::group::Vertica"
+yarn lerna run --concurrency 1 --stream --no-prefix smoke:vertica
+echo "::endgroup::"
+
 echo "::group::RBAC"
 yarn lerna run --concurrency 1 --stream --no-prefix smoke:rbac
 echo "::endgroup::"

.github/workflows/drivers-tests.yml

@@ -24,6 +24,7 @@ on:
       - 'packages/cubejs-mysql-driver/**'
       - 'packages/cubejs-postgres-driver/**'
       - 'packages/cubejs-snowflake-driver/**'
+      - 'packages/cubejs-vertica-driver/**'
 
       # To test SQL API Push down
       - 'packages/cubejs-backend-native/**'
@@ -49,6 +50,7 @@ on:
       - 'packages/cubejs-mysql-driver/**'
       - 'packages/cubejs-postgres-driver/**'
       - 'packages/cubejs-snowflake-driver/**'
+      - 'packages/cubejs-vertica-driver/**'
 
       # To test SQL API Push down
       - 'packages/cubejs-backend-native/**'

.github/workflows/push.yml

@@ -336,7 +336,7 @@ jobs:
         node-version: [20.x]
         db: [
             'clickhouse', 'druid', 'elasticsearch', 'mssql', 'mysql', 'postgres', 'prestodb',
-            'mysql-aurora-serverless', 'crate', 'mongobi', 'firebolt', 'dremio'
+            'mysql-aurora-serverless', 'crate', 'mongobi', 'firebolt', 'dremio', 'vertica'
         ]
       fail-fast: false
 

.yarnrc.yml

@@ -0,0 +1 @@
+nodeLinker: node-modules

docs/pages/product/configuration/data-sources.mdx

@@ -59,6 +59,11 @@ sources][ref-config-multi-data-src] out of the box.
     imageUrl="https://static.cube.dev/icons/firebolt.svg"
     title="Firebolt"
   />
+   <GridItem
+    url="data-sources/vertica"
+    imageUrl="https://static.cube.dev/icons/vertica.svg"
+    title="Vertica"
+  />
 </Grid>
 
 ## Query engines

docs/pages/product/configuration/data-sources/vertica.mdx

@@ -0,0 +1,46 @@
+# Vertica
+
+## Prerequisites
+
+- The hostname for the [Vertica][vertica] database server
+- The username/password for the [Vertica][vertica] database server
+- The name of the database to use within the [Vertica][vertica] database server
+
+## Setup
+
+### Manual
+
+Add the following to a `.env` file in your Cube project:
+
+```dotenv
+CUBEJS_DB_TYPE=vertica
+CUBEJS_DB_HOST=my.vertica.host
+CUBEJS_DB_USER=vertica_user
+CUBEJS_DB_PASS=**********
+CUBEJS_DB_SCHEMA=my_vertica_schema
+```
+
+## Environment Variables
+
+| Environment Variable       | Description                                                                         | Possible Values                               | Required |
+| -------------------------- | ----------------------------------------------------------------------------------- | --------------------------------------------- | :------: |
+| `CUBEJS_DB_HOST`           | The host URL for a database                                                         | A valid database host URL                     |    ✅    |
+| `CUBEJS_DB_PORT`           | The port for the database connection                                                | A valid port number                           |    ❌    |
+| `CUBEJS_DB_USER`           | The username used to connect to the database                                        | A valid database username                     |    ✅    |
+| `CUBEJS_DB_PASS`           | The password used to connect to the database                                        | A valid database password                     |    ✅    |
+| `CUBEJS_DB_SCHEMA`         | The schema within the database to connect to                                        | A valid schema name within a Presto database  |    ✅    |
+| `CUBEJS_DB_SSL`            | If `true`, enables SSL encryption for database connections from Cube                | `true`, `false`                               |    ❌    |
+| `CUBEJS_CONCURRENCY`       | The number of concurrent connections each queue has to the database. Default is `2` | A valid number                                |    ❌    |
+| `CUBEJS_DB_MAX_POOL`       | The maximum number of concurrent database connections to pool. Default is `8`       | A valid number                                |    ❌    |
+
+
+## SSL
+
+To enable SSL-encrypted connections between Cube and Verica, set the
+`CUBEJS_DB_SSL` environment variable to `true`. For more information on how to
+configure custom certificates, please check out [Enable SSL Connections to the
+Database][ref-recipe-enable-ssl].
+
+[vertica]: https://www.vertica.com/documentation/vertica/all/
+[ref-recipe-enable-ssl]:/guides/recipes/data-sources/using-ssl-connections-to-data-source
+  

packages/cubejs-docker/dev.Dockerfile

@@ -73,6 +73,7 @@ COPY packages/cubejs-sqlite-driver/package.json packages/cubejs-sqlite-driver/pa
 COPY packages/cubejs-ksql-driver/package.json packages/cubejs-ksql-driver/package.json
 COPY packages/cubejs-dbt-schema-extension/package.json packages/cubejs-dbt-schema-extension/package.json
 COPY packages/cubejs-jdbc-driver/package.json packages/cubejs-jdbc-driver/package.json
+COPY packages/cubejs-vertica-driver/package.json packages/cubejs-vertica-driver/package.json
 # Skip
 # COPY packages/cubejs-testing/package.json packages/cubejs-testing/package.json
 # COPY packages/cubejs-docker/package.json packages/cubejs-docker/package.json
@@ -150,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-vertica-driver/ packages/cubejs-vertica-driver/
 # Skip
 # COPY packages/cubejs-testing/ packages/cubejs-testing/
 # COPY packages/cubejs-docker/ packages/cubejs-docker/

packages/cubejs-docker/package.json

@@ -36,6 +36,7 @@
     "@cubejs-backend/snowflake-driver": "1.1.10",
     "@cubejs-backend/sqlite-driver": "1.1.10",
     "@cubejs-backend/trino-driver": "1.1.11",
+    "@cubejs-backend/vertica-driver": "1.1.11",
     "cubejs-cli": "1.1.11",
     "typescript": "~5.2.2"
   },

packages/cubejs-server-core/src/core/DriverDependencies.js

@@ -26,6 +26,7 @@ module.exports = {
   ksql: '@cubejs-backend/ksql-driver',
   questdb: '@cubejs-backend/questdb-driver',
   materialize: '@cubejs-backend/materialize-driver',
+  vertica: '@cubejs-backend/vertica-driver',
   pinot: '@cubejs-backend/pinot-driver',
   // List for JDBC drivers
   'databricks-jdbc': '@cubejs-backend/databricks-jdbc-driver',