Skip to content

Commit 926ae16

Browse files
committed
Update ODBC driver references to latest version
1 parent 4f59431 commit 926ae16

8 files changed

Lines changed: 24 additions & 25 deletions

docs/connect/odbc/linux-mac/connection-string-keywords-and-data-source-names-dsns.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Connecting using ODBC"
33
description: "Learn how to create a connection to a database from Linux or macOS using the Microsoft ODBC Driver for SQL Server."
44
ms.custom: ""
5-
ms.date: "05/11/2020"
5+
ms.date: 09/01/2020
66
ms.prod: sql
77
ms.prod_service: connectivity
88
ms.reviewer: ""
@@ -82,7 +82,7 @@ Regardless of the settings for **Encrypt** and **TrustServerCertificate**, the s
8282
By default, encrypted connections always verify the server's certificate. However, if you connect to a server that has a self-signed certificate, also add the `TrustServerCertificate` option to bypass checking the certificate against the list of trusted certificate authorities:
8383

8484
```
85-
Driver={ODBC Driver 13 for SQL Server};Server=ServerNameHere;Encrypt=YES;TrustServerCertificate=YES
85+
Driver={ODBC Driver 17 for SQL Server};Server=ServerNameHere;Encrypt=YES;TrustServerCertificate=YES
8686
```
8787

8888
TLS uses the OpenSSL library. The following table shows the minimum supported versions of OpenSSL and the default Certificate Trust Store locations for each platform:

docs/connect/odbc/linux-mac/data-access-tracing-with-the-odbc-driver-on-linux.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Data Access Tracing with the ODBC Driver on Linux and macOS"
33
description: "Learn how to enable tracing on Linux and macOS with the Microsoft ODBC Driver for SQL Server to output a log file when troubleshooting application behavior."
44
ms.custom: ""
5-
ms.date: "01/19/2017"
5+
ms.date: 09/01/2020
66
ms.prod: sql
77
ms.prod_service: connectivity
88
ms.reviewer: ""
@@ -40,7 +40,7 @@ Tracing applies to all applications that use the driver in `odbcinst.ini`. To no
4040
$ ODBCSYSINI=/home/myappuser myapp
4141
```
4242

43-
In this case, you can add `Trace=Yes` to the `[ODBC Driver 13 for SQL Server]` section of `/home/myappuser/odbcinst.ini`.
43+
In this case, you can add `Trace=Yes` to the `[ODBC Driver 17 for SQL Server]` section of `/home/myappuser/odbcinst.ini`.
4444

4545
## Determining which odbc.ini File the Driver is Using
4646

docs/connect/odbc/linux-mac/known-issues-in-this-version-of-the-driver.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Known issues for the ODBC driver on Linux and macOS
33
description: "Learn about known issues with the Microsoft ODBC Driver for SQL Server on Linux and macOS and steps for troubleshooting connectivity issues."
4-
ms.date: 05/06/2020
4+
ms.date: 09/01/2020
55
ms.prod: sql
66
ms.reviewer: ""
77
ms.technology: connectivity
@@ -53,7 +53,7 @@ If you get another connection failure and do not see a log file, there (possibly
5353
Entry:
5454
Connection = 0x17c858e0
5555
Window Hdl = (nil)
56-
Str In = [DRIVER={ODBC Driver 13 for SQL Server};SERVER={contoso.com};Trusted_Connection={YES};WSID={mydb.contoso.com};AP...][length = 139 (SQL_NTS)]
56+
Str In = [DRIVER={ODBC Driver 17 for SQL Server};SERVER={contoso.com};Trusted_Connection={YES};WSID={mydb.contoso.com};AP...][length = 139 (SQL_NTS)]
5757
Str Out = (nil)
5858
Str Out Max = 0
5959
Str Out Ptr = (nil)

docs/connect/odbc/linux-mac/using-integrated-authentication.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
---
2-
description: "Using Integrated Authentication"
32
title: "Using Integrated Authentication"
4-
descrption: "The Microsoft ODBC Driver for SQL Server on Linux and macOS supports connections that use Kerberos integrated authentication."
3+
description: The Microsoft ODBC Driver for SQL Server on Linux and macOS supports connections that use Kerberos integrated authentication.
54
ms.custom: ""
6-
ms.date: "01/20/2017"
5+
ms.date: 09/01/2020
76
ms.prod: sql
87
ms.prod_service: connectivity
98
ms.reviewer: ""
@@ -27,7 +26,7 @@ As of version 17.6, the driver also supports integrated authentication with Azur
2726
You can enable Kerberos integrated authentication by specifying **Trusted_Connection=yes** in the connection string of **SQLDriverConnect** or **SQLConnect**. For example:
2827

2928
```
30-
Driver='ODBC Driver 13 for SQL Server';Server=your_server;Trusted_Connection=yes
29+
Driver='ODBC Driver 17 for SQL Server';Server=your_server;Trusted_Connection=yes
3130
```
3231

3332
When connecting with a DSN, you can also add **Trusted_Connection=yes** to the DSN entry in `odbc.ini`.

docs/connect/odbc/using-always-encrypted-with-the-odbc-driver.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Using Always Encrypted with the ODBC Driver"
33
description: "Learn how to develop ODBC applications using Always Encrypted and the Microsoft ODBC Driver for SQL Server."
44
ms.custom: ""
5-
ms.date: 05/06/2020
5+
ms.date: 09/01/2020
66
ms.prod: sql
77
ms.technology: connectivity
88
ms.topic: conceptual
@@ -35,7 +35,7 @@ Configure Always Encrypted in your database. This involves provisioning Always E
3535
The easiest way to enable both parameter encryption and resultset encrypted column decryption is by setting the value of the `ColumnEncryption` connection string keyword to **Enabled**. The following is an example of a connection string which enables Always Encrypted:
3636

3737
```
38-
SQLWCHAR *connString = L"Driver={ODBC Driver 13 for SQL Server};Server={myServer};Trusted_Connection=yes;ColumnEncryption=Enabled;";
38+
SQLWCHAR *connString = L"Driver={ODBC Driver 17 for SQL Server};Server={myServer};Trusted_Connection=yes;ColumnEncryption=Enabled;";
3939
```
4040

4141
Always Encrypted may also be enabled in the DSN configuration, using the same key and value (which will be overridden by the connection string setting, if present), or programmatically with the `SQL_COPT_SS_COLUMN_ENCRYPTION` pre-connection attribute. Setting it this way overrides the value set in the connection string or DSN:
@@ -406,13 +406,13 @@ The following connection strings show how to authenticate to Azure Key Vault wit
406406
**ClientID/Secret**:
407407

408408
```
409-
DRIVER=ODBC Driver 13 for SQL Server;SERVER=myServer;Trusted_Connection=Yes;DATABASE=myDB;ColumnEncryption=Enabled;KeyStoreAuthentication=KeyVaultClientSecret;KeyStorePrincipalId=<clientId>;KeyStoreSecret=<secret>
409+
DRIVER=ODBC Driver 17 for SQL Server;SERVER=myServer;Trusted_Connection=Yes;DATABASE=myDB;ColumnEncryption=Enabled;KeyStoreAuthentication=KeyVaultClientSecret;KeyStorePrincipalId=<clientId>;KeyStoreSecret=<secret>
410410
```
411411

412412
**Username/Password**:
413413

414414
```
415-
DRIVER=ODBC Driver 13 for SQL Server;SERVER=myServer;Trusted_Connection=Yes;DATABASE=myDB;ColumnEncryption=Enabled;KeyStoreAuthentication=KeyVaultPassword;KeyStorePrincipalId=<username>;KeyStoreSecret=<password>
415+
DRIVER=ODBC Driver 17 for SQL Server;SERVER=myServer;Trusted_Connection=Yes;DATABASE=myDB;ColumnEncryption=Enabled;KeyStoreAuthentication=KeyVaultPassword;KeyStorePrincipalId=<username>;KeyStoreSecret=<password>
416416
```
417417

418418
**Managed Identity (system-assigned)**
@@ -639,7 +639,7 @@ See [Migrate Sensitive Data Protected by Always Encrypted](../../relational-data
639639

640640
|IPD Field|Size/Type|Default Value|Description|
641641
|-|-|-|-|
642-
|`SQL_CA_SS_FORCE_ENCRYPT` (1236)|WORD (2 bytes)|0|When 0 (default): decision to encrypt this parameter is determined by availability of encryption metadata.<br><br>When nonzero: if encryption metadata is available for this parameter, it is encrypted. Otherwise, the request fails with error [CE300] [Microsoft][ODBC Driver 13 for SQL Server]Mandatory encryption was specified for a parameter but no encryption metadata was provided by the server.|
642+
|`SQL_CA_SS_FORCE_ENCRYPT` (1236)|WORD (2 bytes)|0|When 0 (default): decision to encrypt this parameter is determined by availability of encryption metadata.<br><br>When nonzero: if encryption metadata is available for this parameter, it is encrypted. Otherwise, the request fails with error [CE300] [Microsoft][ODBC Driver 17 for SQL Server]Mandatory encryption was specified for a parameter but no encryption metadata was provided by the server.|
643643

644644
### bcp_control Options
645645

docs/connect/odbc/using-azure-active-directory.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Using Azure Active Directory with the ODBC Driver"
33
description: "The Microsoft ODBC Driver for SQL Server allows ODBC applications to connect to an instance of Azure SQL Database using Azure Active Directory."
44
ms.custom: ""
5-
ms.date: "08/06/2020"
5+
ms.date: 09/01/2020
66
ms.prod: sql
77
ms.prod_service: connectivity
88
ms.reviewer: ""
@@ -139,14 +139,14 @@ The `ACCESSTOKEN` is a variable-length structure consisting of a 4-byte _length_
139139
The following sample shows the code required to connect to SQL Server using Azure Active Directory with connection keywords. Note that there is no need to change the application code itself; the connection string, or DSN if one is used, is the only modification needed to use Azure AD for authentication:
140140
~~~
141141
...
142-
SQLCHAR connString[] = "Driver={ODBC Driver 13 for SQL Server};Server={server};UID=myuser;PWD=myPass;Authentication=ActiveDirectoryPassword"
142+
SQLCHAR connString[] = "Driver={ODBC Driver 17 for SQL Server};Server={server};UID=myuser;PWD=myPass;Authentication=ActiveDirectoryPassword"
143143
...
144144
SQLDriverConnect(hDbc, NULL, connString, SQL_NTS, NULL, 0, NULL, SQL_DRIVER_NOPROMPT);
145145
...
146146
~~~
147147
The following sample shows the code required to connect to SQL Server using Azure Active Directory with access token authentication. In this case, it is necessary to modify application code to process the access token and set the associated connection attribute.
148148
~~~
149-
SQLCHAR connString[] = "Driver={ODBC Driver 13 for SQL Server};Server={server}"
149+
SQLCHAR connString[] = "Driver={ODBC Driver 17 for SQL Server};Server={server}"
150150
SQLCHAR accessToken[] = "eyJ0eXAiOi..."; // In the format extracted from an OAuth JSON response
151151
...
152152
DWORD dataSize = 2 * strlen(accessToken);

docs/connect/odbc/windows/asynchronous-execution-notification-method-sample.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Asynchronous Execution (Notification Method) Sample"
33
description: "Example code demonstrating how to use asynchronous execution (using the notification method) in the Microsoft ODBC Driver for SQL Server."
44
ms.custom: ""
5-
ms.date: "01/19/2017"
5+
ms.date: 09/01/2020
66
ms.prod: sql
77
ms.prod_service: connectivity
88
ms.reviewer: ""
@@ -312,7 +312,7 @@ int _tmain(int argc, _TCHAR* argv[])
312312
for(int i = 0; i < g_nConnection; i++)
313313
{
314314
SQLDriverConnect(g_hDbcs[i],NULL,
315-
(SQLCHAR*)"DRIVER={ODBC Driver 13 for SQL Server};Server=your_server;database=your_database;uid=usr;pwd=your_password",
315+
(SQLCHAR*)"DRIVER={ODBC Driver 17 for SQL Server};Server=your_server;database=your_database;uid=usr;pwd=your_password",
316316
SQL_NTS, (SQLCHAR*)g_connOut[i].szOutConnectionString, 500, &g_connOut[i].iLen, SQL_DRIVER_NOPROMPT);
317317
}
318318

docs/connect/odbc/windows/driver-aware-connection-pooling-in-the-odbc-driver-for-sql-server.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Driver-Aware Connection Pooling in the ODBC Driver"
33
description: "Learn about enhancements made to driver-aware connection pooling in the Microsoft ODBC Driver for SQL Server on Windows."
44
ms.custom: ""
5-
ms.date: "05/06/2020"
5+
ms.date: 09/01/2020
66
ms.prod: sql
77
ms.prod_service: connectivity
88
ms.reviewer: ""
@@ -37,7 +37,7 @@ If one of the following connection-attribute IDs or connection string keywords i
3737

3838
- If there is a difference in any of the following connection keywords between your connection string and a pooled connection string, a pooled connection is not used.
3939

40-
|Keyword|ODBC Driver 13|ODBC Driver 11|
40+
|Keyword|ODBC Driver 17/13|ODBC Driver 11|
4141
|-|-|-|
4242
|`Address`|Yes|Yes|
4343
|`AnsiNPW`|Yes|Yes|
@@ -62,7 +62,7 @@ If one of the following connection-attribute IDs or connection string keywords i
6262

6363
- If there is a difference in any of the following connection attributes between your connection string and a pooled connection string, a pooled connection is not used.
6464

65-
|Attribute|ODBC Driver 13|ODBC Driver 11|
65+
|Attribute|ODBC Driver 17/13|ODBC Driver 11|
6666
|-|-|-|
6767
|`SQL_ATTR_CURRENT_CATALOG`|Yes|Yes|
6868
|`SQL_ATTR_PACKET_SIZE`|Yes|Yes|
@@ -88,7 +88,7 @@ If one of the following connection-attribute IDs or connection string keywords i
8888

8989
These connection keywords are not considered when the Driver Manager tries to match your connection with a connection in the pool. (Even if you change one of these parameters, an existing connection can be reused. The driver will reset the options, as needed.) These attributes can be reset in the client side without making an extra network call.
9090

91-
|Keyword|ODBC Driver 13|ODBC Driver 11|
91+
|Keyword|ODBC Driver 17/13|ODBC Driver 11|
9292
|-|-|-|
9393
|`AutoTranslate`|Yes|Yes|
9494
|`Description`|Yes|Yes|
@@ -102,7 +102,7 @@ If one of the following connection-attribute IDs or connection string keywords i
102102

103103
If you change one of the following connection attributes, an existing connection can be reused. The driver will reset the value, as needed. The driver can reset these attributes in the client without making an extra network call.
104104

105-
|Attribute|ODBC Driver 13|ODBC Driver 11|
105+
|Attribute|ODBC Driver 17/13|ODBC Driver 11|
106106
|-|-|-|
107107
|All statement attributes|Yes|Yes|
108108
|`SQL_ATTR_AUTOCOMMIT`|Yes|Yes|

0 commit comments

Comments
 (0)