Skip to main content

​
Microsoft SQL Server

​
Prerequisites

​
Setup

​
Manual

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 Variables

Environment VariableDescriptionPossible ValuesRequired
CUBEJS_DB_HOSTThe host URL for a databaseA valid database host URL✅
CUBEJS_DB_PORTThe port for the database connectionA valid port number❌
CUBEJS_DB_NAMEThe name of the database to connect toA valid database name✅
CUBEJS_DB_USERThe username used to connect to the databaseA valid database username✅
CUBEJS_DB_PASSThe password used to connect to the databaseA valid database password✅
CUBEJS_DB_DOMAINA domain name within the database to connect toA valid domain name within a Microsoft SQL Server database❌
CUBEJS_DB_SSLIf true, enables SSL encryption for database connections from Cubetrue, false❌
CUBEJS_DB_MAX_POOLThe maximum number of concurrent database connections to pool. Default is 8A valid number❌
CUBEJS_CONCURRENCYThe number of concurrent queries to the data sourceA valid number❌

​
Pre-Aggregation Feature Support

​
count_distinct_approx

Measures of type count_distinct_approx can not be used in pre-aggregations when using Microsoft SQL Server as a source database.

​
Pre-Aggregation Build Strategies

To learn more about pre-aggregation build strategies, head here.
FeatureWorks with read-only mode?Is default?
Simple✅✅
Batching--
Export Bucket--
By default, Microsoft SQL Server uses a simple strategy to build pre-aggregations.

​
Simple

No extra configuration is required to configure simple pre-aggregation builds for Microsoft SQL Server.

​
Batching

Microsoft SQL Server does not support batching.

​
Export Bucket

Microsoft SQL Server does not support export buckets.

​
SSL

To enable SSL-encrypted connections between Cube and Microsoft SQL Server, 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.

​
Additional Configuration

​
Windows Authentication

To connect to a Microsoft SQL Server 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 })
}