Microsoft SQL Server

Prerequisites

The hostname for the Microsoft SQL Server database server
The username/password for the Microsoft SQL Server database server
The name of the database to use within the Microsoft SQL Server database server

Setup

Manual

Add the following to a .env file in your Cube project:

dotenv

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 Variable	Description	Possible Values	Required
<EnvVar>CUBEJS_DB_HOST</EnvVar>	The host URL for a database	A valid database host URL	✅
<EnvVar>CUBEJS_DB_PORT</EnvVar>	The port for the database connection	A valid port number	❌
<EnvVar>CUBEJS_DB_NAME</EnvVar>	The name of the database to connect to	A valid database name	✅
<EnvVar>CUBEJS_DB_USER</EnvVar>	The username used to connect to the database	A valid database username	✅
<EnvVar>CUBEJS_DB_PASS</EnvVar>	The password used to connect to the database	A valid database password	✅
<EnvVar>CUBEJS_DB_DOMAIN</EnvVar>	A domain name within the database to connect to	A valid domain name within a Microsoft SQL Server database	❌
<EnvVar>CUBEJS_DB_SSL</EnvVar>	If `true`, enables SSL encryption for database connections from Cube	`true`, `false`	❌
<EnvVar>CUBEJS_DB_MAX_POOL</EnvVar>	The maximum number of concurrent database connections to pool. Default is `8`	A valid number	❌
<EnvVar>CUBEJS_CONCURRENCY</EnvVar>	The number of concurrent queries to the data source	A 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.

</InfoBox>

Feature	Works 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 <EnvVar>CUBEJS_DB_SSL</EnvVar> 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:

javascript

const MssqlDriver = require("@cubejs-backend/mssql-driver")
module.exports = {
  driverFactory: ({ dataSource }) =>
    new MssqlDriver({ database: dataSource, trustedConnection: true })
}