Skip to content

Commit 17fa568

Browse files
committed
vertica documentation
1 parent 5a6194c commit 17fa568

File tree

1 file changed

+46
-0
lines changed
  • docs/pages/product/configuration/data-sources

1 file changed

+46
-0
lines changed
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Vertica
2+
3+
## Prerequisites
4+
5+
- The hostname for the [Vertica][vertica] database server
6+
- The username/password for the [Vertica][vertica] database server
7+
- The name of the database to use within the [Vertica][vertica] database server
8+
9+
## Setup
10+
11+
### Manual
12+
13+
Add the following to a `.env` file in your Cube project:
14+
15+
```dotenv
16+
CUBEJS_DB_TYPE=vertica
17+
CUBEJS_DB_HOST=my.vertica.host
18+
CUBEJS_DB_USER=vertica_user
19+
CUBEJS_DB_PASS=**********
20+
CUBEJS_DB_SCHEMA=my_vertica_schema
21+
```
22+
23+
## Environment Variables
24+
25+
| Environment Variable | Description | Possible Values | Required |
26+
| -------------------------- | ----------------------------------------------------------------------------------- | --------------------------------------------- | :------: |
27+
| `CUBEJS_DB_HOST` | The host URL for a database | A valid database host URL ||
28+
| `CUBEJS_DB_PORT` | The port for the database connection | A valid port number ||
29+
| `CUBEJS_DB_USER` | The username used to connect to the database | A valid database username ||
30+
| `CUBEJS_DB_PASS` | The password used to connect to the database | A valid database password ||
31+
| `CUBEJS_DB_SCHEMA` | The schema within the database to connect to | A valid schema name within a Presto database ||
32+
| `CUBEJS_DB_SSL` | If `true`, enables SSL encryption for database connections from Cube | `true`, `false` ||
33+
| `CUBEJS_CONCURRENCY` | The number of concurrent connections each queue has to the database. Default is `2` | A valid number ||
34+
| `CUBEJS_DB_MAX_POOL` | The maximum number of concurrent database connections to pool. Default is `8` | A valid number ||
35+
36+
37+
## SSL
38+
39+
To enable SSL-encrypted connections between Cube and Verica, set the
40+
`CUBEJS_DB_SSL` environment variable to `true`. For more information on how to
41+
configure custom certificates, please check out [Enable SSL Connections to the
42+
Database][ref-recipe-enable-ssl].
43+
44+
[vertica]: https://www.vertica.com/documentation/vertica/all/
45+
[ref-recipe-enable-ssl]:/guides/recipes/data-sources/using-ssl-connections-to-data-source
46+

0 commit comments

Comments
 (0)