Connectors and Connections > Data Ingestion and Replication connection properties > Microsoft SQL Server connection properties
  

Microsoft SQL Server connection properties

When you set up a Microsoft SQL Server connection, configure the connection properties.
The following table describes the Microsoft SQL Server connection properties:
Property
Description
Connection Name
Name of the connection.
Each connection name must be unique within the organization. Connection names can contain alphanumeric characters, spaces, and the following special characters: _ . + -,
Maximum length is 255 characters.
Description
Description of the connection. Maximum length is 4000 characters.
Type
Type of connection.
Select SQL Server from the list.
Runtime Environment
The name of the runtime environment where you want to run the tasks.
You cannot run a database ingestion and replication task on a Hosted Agent or serverless runtime environment.
SQL Server Version
Microsoft SQL Server database version.
Authentication Mode
Authentication method to access Microsoft SQL Server.
Select one of the following methods:
  • - SQL Server Authentication. Uses your Microsoft SQL Server user name and password to access Microsoft SQL Server.
  • - Windows Authentication (Deprecated). Uses the Microsoft Windows authentication to access Microsoft SQL Server. This option is available when you access Data Integration by using Microsoft Windows.
  • When you choose this option, you don't need to enter credentials to access Microsoft SQL Server and ensure that the user account that starts the Secure Agent service is available in the Microsoft SQL Server database.
    Note: Windows authentication is not certified for Microsoft SQL Server 2017 version hosted on Linux. You can't configure Windows Authentication when you use a serverless runtime environment.
  • - Active Directory Password. Uses the Azure Active Directory user name and password to authenticate and access the Microsoft Azure SQL Database.
  • Note: Database Ingestion and Replication supports this authentication mode for initial load jobs and for incremental load and combined initial and incremental load jobs that use the CDC Tables or Log-based capture method. If you use this option for these jobs, verify that the Validate Server Certificate value is False.
  • - Windows Authentication v2. Uses this authentication method to access Microsoft SQL Server from Data Integration or Data Ingestion and Replication using an agent hosted on a Linux or Windows machine.
  • When you choose this option on Linux, enter your domain name and Microsoft Windows credentials to access Microsoft SQL Server.
    When you choose this option on Windows, the agent uses the user credentials specified in the connection only to test the connection. During runtime, the agent uses the credentials of the user who started the Secure Agent service. Ensure that the user account that starts the Secure Agent service is available in the Microsoft SQL Server database.
  • - Kerberos. Doesn't apply to Data Ingestion and Replication tasks.
Domain
Applies to Windows Authentication v2.
The domain name of the Windows user.
User Name
User name for the database login. The user name can't contain a semicolon.
To connect to Microsoft Azure SQL Database, specify the user name in the following format: username@host
If you use Windows Authentication v2 on Windows, the user name is used as follows:
  • - During design time, the agent uses the user name specified here to test the connection.
  • - During runtime, the Microsoft SQL server driver ignores the user name specified in this field and uses the credentials of the user who started the Secure Agent service.
If you use Windows Authentication v2 on Linux, the user name specified here is used both during design time and runtime.
Note: This property is not applicable if you use the Windows Authentication mode to access Microsoft SQL Server.
Password
Password for the database login. The password can't contain a semicolon.
If you use Windows Authentication v2 on Windows, the password is used as follows:
  • - During design time, the agent uses the password specified here to test the connection.
  • - During runtime, the Microsoft SQL server driver ignores the password specified in this field and uses the credentials of the user who started the Secure Agent service.
If you use Windows Authentication v2 on Linux, the password specified here is used both during design time and runtime.
Note: This property is not applicable if you use the Windows Authentication mode to access Microsoft SQL Server.
Host
Name of the machine hosting the database server.
To connect to Microsoft Azure SQL Database, specify the fully qualified host name.
For example, vmjcmwxsfboheng.westus.cloudapp.azure.com.
Port
Network port number used to connect to the database server.
Default is 1433.
Instance Name
Instance name of the Microsoft SQL Server database.
Database Name
Database name for the Microsoft SQL Server target connection. Database name is case-sensitive if the database is case-sensitive. Maximum length is 100 characters.
Database names can include alphanumeric and underscore characters.
Schema
Schema used for the target connection.
Code Page
The code page of the database server.
Encryption Method
The method that the Secure Agent uses to encrypt the data sent between the driver and the database server. You can use the encryption method to connect to a SQL Server database.
Options are:
  • - None. Don't use encryption.
  • - SSL
  • - Request SSL
  • - Login SSL
Default is None.
Crypto Protocol Version
Cryptographic protocols to use when you enable SSL encryption.
Validate Server Certificate
When set to True, Secure Agent validates the certificate that is sent by the database server.
If you specify the HostNameInCertificate parameter, Secure Agent also validates the host name in the certificate.
When set to false, the Secure Agent doesn't validate the certificate that is sent by the database server.
Trust Store
The location and name of the truststore file. The truststore file contains a list of Certificate Authorities (CAs) that the driver uses for SSL server authentication.
Trust Store Password
The password to access the contents of the truststore file.
Host Name in Certificate
Host name of the machine that hosts the secure database. If you specify a host name, the Secure Agent validates the host name included in the connection with the host name in the SSL certificate.
Metadata Advanced Connection Properties
Additional properties for the JDBC driver to fetch the metadata.
If you specify more than one property, separate each key-value pair with a semicolon.
For example,
LoginTimeout=100
Note: The default connection timeout is 270 seconds. Add this property to configure the connection timeout during design time.
Runtime Advanced Connection Properties
Additional properties for the ODBC driver to run mappings.
If you specify more than one property, separate each key-value pair with a semicolon.
For example,
LoginTimeout=100
Note: The default connection timeout is 270 seconds. Add this property to configure the connection timeout during runtime.