MS SQL
- The hostname for the MS SQL database server
- The username/password for the MS SQL database server
- The name of the database to use within the MS SQL database server
Add the following to a .env
file in your Cube project:
CUBEJS_DB_TYPE=mssql
CUBEJS_DB_HOST=my.mssql.host
CUBEJS_DB_NAME=my_mssql_database
CUBEJS_DB_USER=mssql_user
CUBEJS_DB_PASS=**********
Environment Variable | Description | Possible Values | Required | Supports multiple data sources? |
---|---|---|---|---|
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_NAME | The name of the database to connect to | A valid database name | ✅ | ✅ |
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_DOMAIN | A domain name within the database to connect to | A valid domain name within a MSSQL 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 | ❌ | ✅ |
countDistinctApprox
Measures of type
countDistinctApprox
can
not be used in pre-aggregations when using MSSQL as a source database.
To learn more about pre-aggregation build strategies, head here.
Feature | Works with read-only mode? | Is default? |
---|---|---|
Simple | ✅ | ✅ |
Batching | - | - |
Export Bucket | - | - |
By default, MSSQL uses a simple strategy to build pre-aggregations.
Simple
No extra configuration is required to configure simple pre-aggregation builds for MSSQL.
Batching
MSSQL does not support batching.
Export Bucket
MSSQL does not support export buckets.
To enable SSL-encrypted connections between Cube and MS SQL, 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.
To connect to a MSSQL database using Windows Authentication (also sometimes
known as trustedConnection
), instantiate the driver with
trustedConnection: true
in your cube.js
configuration file:
const MssqlDriver = require('@cubejs-backend/mssql-driver');
module.exports = {
driverFactory: ({ dataSource }) =>
new MssqlDriver({ database: dataSource, trustedConnection: true }),
};
Did you find this page useful?