1- ---
2- redirect_from :
3- - /config/databases/mssql
4- ---
5-
6- # MS-SQL
1+ # Microsoft SQL Server
72
83## Prerequisites
94
10- - The hostname for the [ MS SQL] [ mssql ] database server
11- - The username/password for the [ MS SQL] [ mssql ] database server
12- - The name of the database to use within the [ MS SQL] [ mssql ] database server
5+ - The hostname for the [ Microsoft SQL Server] [ mssql ] database server
6+ - The username/password for the [ Microsoft SQL Server] [ mssql ] database server
7+ - The name of the database to use within the [ Microsoft SQL Server] [ mssql ]
8+ database server
139
1410## Setup
1511
@@ -27,25 +23,26 @@ CUBEJS_DB_PASS=**********
2723
2824## Environment Variables
2925
30- | Environment Variable | Description | Possible Values | Required | [ Supports multiple data sources?] [ ref-config-multiple-ds-decorating-env ] |
31- | -------------------- | ----------------------------------------------------------------------------------- | ------------------------------------------- | :------: | :----------------------------------------------------------------------: |
32- | ` CUBEJS_DB_HOST ` | The host URL for a database | A valid database host URL | ✅ | ✅ |
33- | ` CUBEJS_DB_PORT ` | The port for the database connection | A valid port number | ❌ | ✅ |
34- | ` CUBEJS_DB_NAME ` | The name of the database to connect to | A valid database name | ✅ | ✅ |
35- | ` CUBEJS_DB_USER ` | The username used to connect to the database | A valid database username | ✅ | ✅ |
36- | ` CUBEJS_DB_PASS ` | The password used to connect to the database | A valid database password | ✅ | ✅ |
37- | ` CUBEJS_DB_DOMAIN ` | A domain name within the database to connect to | A valid domain name within a MSSQL database | ❌ | ✅ |
38- | ` CUBEJS_DB_SSL ` | If ` true ` , enables SSL encryption for database connections from Cube | ` true ` , ` false ` | ❌ | ✅ |
39- | ` CUBEJS_CONCURRENCY ` | The number of concurrent connections each queue has to the database. Default is ` 2 ` | A valid number | ❌ | ❌ |
40- | ` CUBEJS_DB_MAX_POOL ` | The maximum number of concurrent database connections to pool. Default is ` 8 ` | A valid number | ❌ | ✅ |
26+ | Environment Variable | Description | Possible Values | Required | [ Supports multiple data sources?] [ ref-config-multiple-ds-decorating-env ] |
27+ | -------------------- | ----------------------------------------------------------------------------------- | ---------------------------------------------------------- | :------: | :----------------------------------------------------------------------: |
28+ | ` CUBEJS_DB_HOST ` | The host URL for a database | A valid database host URL | ✅ | ✅ |
29+ | ` CUBEJS_DB_PORT ` | The port for the database connection | A valid port number | ❌ | ✅ |
30+ | ` CUBEJS_DB_NAME ` | The name of the database to connect to | A valid database name | ✅ | ✅ |
31+ | ` CUBEJS_DB_USER ` | The username used to connect to the database | A valid database username | ✅ | ✅ |
32+ | ` CUBEJS_DB_PASS ` | The password used to connect to the database | A valid database password | ✅ | ✅ |
33+ | ` CUBEJS_DB_DOMAIN ` | A domain name within the database to connect to | A valid domain name within a Microsoft SQL Server database | ❌ | ✅ |
34+ | ` CUBEJS_DB_SSL ` | If ` true ` , enables SSL encryption for database connections from Cube | ` true ` , ` false ` | ❌ | ✅ |
35+ | ` CUBEJS_CONCURRENCY ` | The number of concurrent connections each queue has to the database. Default is ` 2 ` | A valid number | ❌ | ❌ |
36+ | ` CUBEJS_DB_MAX_POOL ` | The maximum number of concurrent database connections to pool. Default is ` 8 ` | A valid number | ❌ | ✅ |
4137
4238## Pre-Aggregation Feature Support
4339
4440### count_distinct_approx
4541
4642Measures of type
4743[ ` count_distinct_approx ` ] [ ref-schema-ref-types-formats-countdistinctapprox ] can
48- not be used in pre-aggregations when using MSSQL as a source database.
44+ not be used in pre-aggregations when using Microsoft SQL Server as a source
45+ database.
4946
5047## Pre-Aggregation Build Strategies
5148
@@ -62,35 +59,35 @@ here][ref-caching-using-preaggs-build-strats].
6259| Batching | - | - |
6360| Export Bucket | - | - |
6461
65- By default, MSSQL uses a [ simple] [ self-preaggs-simple ] strategy to build
66- pre-aggregations.
62+ By default, Microsoft SQL Server uses a [ simple] [ self-preaggs-simple ] strategy
63+ to build pre-aggregations.
6764
6865### Simple
6966
7067No extra configuration is required to configure simple pre-aggregation builds
71- for MSSQL .
68+ for Microsoft SQL Server .
7269
7370### Batching
7471
75- MSSQL does not support batching.
72+ Microsoft SQL Server does not support batching.
7673
7774### Export Bucket
7875
79- MSSQL does not support export buckets.
76+ Microsoft SQL Server does not support export buckets.
8077
8178## SSL
8279
83- To enable SSL-encrypted connections between Cube and MS SQL, set the
84- ` CUBEJS_DB_SSL ` environment variable to ` true ` . For more information on how to
85- configure custom certificates, please check out [ Enable SSL Connections to the
86- Database] [ ref-recipe-enable-ssl ] .
80+ To enable SSL-encrypted connections between Cube and Microsoft SQL Server , set
81+ the ` CUBEJS_DB_SSL ` environment variable to ` true ` . For more information on how
82+ to configure custom certificates, please check out [ Enable SSL Connections to
83+ the Database] [ ref-recipe-enable-ssl ] .
8784
8885## Additional Configuration
8986
9087### Windows Authentication
9188
92- To connect to a MSSQL database using Windows Authentication (also sometimes
93- known as ` trustedConnection ` ), instantiate the driver with
89+ To connect to a Microsoft SQL Server database using Windows Authentication (also
90+ sometimes known as ` trustedConnection ` ), instantiate the driver with
9491` trustedConnection: true ` in your ` cube.js ` configuration file:
9592
9693``` javascript
0 commit comments