ODBC Driver for SQL Server

Build 21.0.7958

Windows DSN Configuration

Using the Microsoft ODBC Data Source Administrator

You can use the Microsoft ODBC Data Source Administrator to edit the DSN configuration. Note that the DSN is created during the installation process.

Complete the following steps to edit the DSN configuration:

  1. Select Start > Search, and enter ODBC Data Sources in the Search box.
  2. Choose the version of the ODBC Administrator that corresponds to the bitness of your application (32-bit or 64-bit).
  3. Click the System DSN tab.
  4. Select the system data source and click Configure.
  5. Edit the information on the Connection tab and click OK.

Note: For .NET Framework 4.0, the driver distributes Microsoft Visual C++ 2017 Redistributable. For .NET Framework 3.5, the driver distributes Microsoft Visual C++ 2008 Redistributable.

You can use the CData ODBC Driver for SQL Server to connect to any instance of Microsoft SQL Server, Azure SQL Server, or Azure Data Warehouse.

Connecting to to Microsoft SQL Server

Specify the following connection properties to connect to SQL Server:

  • Server: The name of the server running SQL Server.
  • Database: The name of the SQL Server database.

Authenticating to SQL Server

You can authenticate to SQL Server using either standard or Kerberos authentication.

Authenticate using Standard Authentication

To authenticate to Microsoft SQL Server using standard authentication, set the following:

  • AuthScheme: Set AuthScheme to Password (SQL Server credentials) or NTLM (Windows Credentials).
  • User: The username provided for authentication with SQL Server.
  • Password: The password associated with the authenticating user.

Authenticating with Kerberos

Please see Using Kerberos for details on how to authenticate with Kerberos.

Connecting to Azure SQL Server and Azure Data Warehouse

You can connect to Azure SQL Server or Azure Data Warehouse by setting the following connection properties:

  • Server: The server running Azure. You can find this by logging into the Azure portal and navigating to SQL databases (or SQL data warehouses) -> Select your database -> Overview -> Server name.
  • Database: The name of the database, as seen in the Azure portal on the SQL databases (or SQL warehouses) page.

Authenticating to Azure

Standard credentials may be used to authenticate to Azure hosted SQL Server. To do so, set the following:

  • AuthScheme: Set AuthScheme to Password (SQL Server credentials) or NTLM (Windows Credentials).
  • User: The name of the user authenticating to Azure.
  • Password: The password associated with the authenticating user.

Alternatively, a form of OAuth may be used by setting AuthScheme to one of AzureAd, AzurePassword, or AzureMSI. All OAuth connections require setting Tenant:

  • AzureTenant: The id of the tenant the SQL Server database is hosted on.

Authenticating using Azure AD

Azure AD is a connection type that goes through OAuth. Set your AuthScheme to AzureAD and see Using OAuth Authentication for an authentication guide.

Authenticating using Azure Service Principal

Azure Service Principal is a connection type that goes through OAuth. Set your AuthScheme to AzureServicePrincipal and see Using Azure Service Principal Authentication for an authentication guide.

Authenticating using Azure Password

To connect using your Azure credentials directly, specify the following connection properties:

  • AuthScheme: Set this to AzurePassword.
  • User: Set this to your user account you use to connect to Azure.
  • Password: Set this to the password you use to connect to Azure.

Authenticating using MSI Authentication

If you are running SQL Server on an Azure VM, you can leverage Managed Service Identity (MSI) credentials to connect:

  • AuthScheme: Set this to AzureMSI.

The MSI credentials will then be automatically obtained for authentication.

Copyright (c) 2021 CData Software, Inc. - All rights reserved.
Build 21.0.7958