Microsoft SQL Server Spatial (JDBC): Add Database Connection

To define a new connection from the Connection parameter in a Microsoft SQL Server (JDBC) format:

Select Add Database Connection. See database-specific parameters below, as well as the section Adding a Database Connection in a Workspace in Using Database Connections. The new connection can be made visible only to the current user, or can be shared among multiple users.

Note To select an existing, previously defined connection, see the section Reusing a Database Connection in Using Database Connections.

Database Connection

Microsoft SQL Server (JDBC)

Name

Enter a name for the new connection.

Connection Parameters

Server

The host name of the Microsoft SQL Server. (It is not necessary to specify a port if a default configuration is used.)

If you have configured your Microsoft SQL Server to use a non-standard port number, you can specify this port here.

The correct syntax is:

<Host>[\<Instance>][:<port>]

Database

To initiate a database connection, enter (or browse for) the database name.

Authentication

SQL Server Authentication – Select this option to connect using a SQL Server login account, specified through the Username and Password parameters.
Windows Authentication - Select this option when connecting through a Windows user account, and the database can validate the account name and password using the Windows principal token in the operating system. Since the user account is retrieved by Windows, the Username and Password parameters are ignored.
Microsoft Entra MFA – Select this option to connect using a dialog box pop-up that displays the specified username and asks for a password. This method supports multi-factor authentication.
Microsoft Entra Password – Select this option to connect using an identity that is defined in Microsoft Entra (formerly Azure Active Directory). The Username and Password parameters should match the username and password of the identity in Microsoft Entra.
Microsoft Entra Integrated – Select this option to connect using the current Windows user identity that is defined in Microsoft Entra (formerly Azure Active Directory). This authentication mode requires the on-premises Active Directory Federation Services (ADFS) to be federated with the Microsoft Entra ID in the cloud.

Encrypt Connection

When selected, this parameter requests Secure Sockets Layer (SSL) encryption for the connection. If the server does not have a certificate trusted by the client machine, the connection will fail. Otherwise, data will be encrypted before traveling over the network. There are multiple ways to trust a server certificate on a client machine.

If this parameter is not selected, encryption behavior will be determined by encryption properties set for SQL Server Native Client, and for SQL Server.

Tip When Encrypt Connection is selected, please provide a fully qualified Server name. For example, a server named safe-sql-server might have a fully qualified name of safe-sql-server.dev.safe. This fully qualified name should be an exact match for the server name on the trusted certificate.

Multi-Subnet Failover

Enable this option if you are connecting to a SQL Server that has been configured for High Availability (HA).

Advanced – Specify JDBC Connection

When enabled, this parameter will allow the JDBC connection string and properties to be specified directly, in order to connect to the database.

Option	Description
Connection String	The connection string for the database to which you are connecting.
Mask Connection Details	When this option is checked (set to Yes) – Connection strings and properties for database connections are masked in translation and error logs. Connection details may contain sensitive information, such as passwords. A masked connection string appears as: jdbc:<subprotocol>:********** While masked connection properties appear as: {<property_name1>=********, <property_name2>=********, ...} Warning** Connection strings for connections whose parameters are embedded in the workspace are not masked, regardless of this setting. When this option is left unchecked (set to No) – Connection strings and properties are logged in plain text.
Connection Property and Value	JDBC connections can be configured with driver-specific arbitrary name/value pairs. The name/value pairs can often be specified in either the Connection String or a Properties object (sometimes only in one way or the other). Name/value pairs entered here will be set in the order specified, then passed on in a Properties object. They do not require manual encoding of characters that are not safe in Connection Strings.

Option

Description

Connection String

The connection string for the database to which you are connecting.

Mask Connection Details

When this option is checked (set to Yes) – Connection strings and properties for database connections are masked in translation and error logs.

Connection details may contain sensitive information, such as passwords. A masked connection string appears as:

jdbc:<subprotocol>:************

While masked connection properties appear as:

{<property_name1>=************,
<property_name2>=************, ...}

Warning Connection strings for connections whose parameters are embedded in the workspace are not masked, regardless of this setting.

When this option is left unchecked (set to No) – Connection strings and properties are logged in plain text.

Connection Property and Value

JDBC connections can be configured with driver-specific arbitrary name/value pairs. The name/value pairs can often be specified in either the Connection String or a Properties object (sometimes only in one way or the other).

Name/value pairs entered here will be set in the order specified, then passed on in a Properties object. They do not require manual encoding of characters that are not safe in Connection Strings.