You can create connections to one or more Microsoft SQL Server databases from .
If you plan to create an SSO connection of this type, additional configuration may be required. See Enable SSO for Relational Connections.
To create this connection:
For additional details on creating a SQL Server connection, see Enable Relational Connections.
This connection can also be created using the API.
Property | Description | |
---|---|---|
Host | Enter your hostname. Example:
| |
Port | Set this value to 1433 . | |
Connect String options | Insert any additional connection parameters, if needed. See below. | |
User Name | (basic credential type only) Username to use to connect to the database. | |
Password | (basic credential type only) Password associated with the above username. | |
Default Column Data Type Inference | Set to | |
Test Connection | After you have defined the connection credentials type, credentials, and connection string, you can validate those credentials. | |
Connection Name | Display name of the connection | |
Connection Description | Description of the connection, which appears in the application. |
The properties that you provide are inserted into the following URL, which connects to the connection:
jdbc:sqlserver://<host>:<port>;<prop1>=<val1>;<prop2>=<val2> |
The connect string options are optional. If you are passing additional properties and values to complete the connection, the connect string options must be structured in the following manner:
;<prop1>=<val1>;<prop2>=<val2>... |
where:
<prop>
: the name of the property<val>
: the value for the propertydelimiters:
;
: any set of connect string options must begin and end with a semi-colon. =
: property names and values must be separated with an equal sign (=
).The following connect string contains several options. Please insert as a single string (no line breaks):
;database=<database_name>;encrypt=true;trustServerCertificate=false; hostNameInCertificate=*.database.windows.net;loginTimeout=30; |
Common connect string properties:
Property | Description | |
---|---|---|
database | Set this value to <database_name> , the name of the database to which to connect. | |
encrypt | Set this value to
| |
trustServerCertificate | When set to | |
hostNameInCertificate | Defines the host name in the server certificate.
| |
loginTimeout | Number of seconds that the |
Delimiters:
;
: any set of connect string options must begin and end with a semi-colon.;
: all additional property names must be prefixed with a semi-colon.=
: property names and values must be separated with an equal sign (=
).Kerberos:
You can use kerberos security for connecting to the database server. Additional configuration is required:
This connection uses the following driver:
Driver name: com.microsoft.sqlserver.jdbc.SQLServerDriver
com.microsoft.sqlserver:mssql-jdbc:7.2.2.jre8
Error message | Description | |
---|---|---|
The h | ||
Permission denied. Please verify your credentials.
| ||
" | There was an issue with the trusted certificate on the SQL Server instance. To disable validation of the certificate, add the following to the connection string options:
|
For more information, see Database Browser.
For more information on how values are converted during input and output with this database, see SQL Server Data Type Conversions.