SqlClient

[Preview Release 5.0.0-preview1.22069.1] - 2022-03-09

Added

• Added SqlDataSourceEnumerator. #1430
• Added new attestation protocol None option to forgo enclave attestation when using VBS enclaves. #1425 and #1419
• Added a new AppContext switch to suppress insecure TLS warnings. #1457

Fixed

• Fixed all documentation paths to Unix format path. #1442
• Fixed thread safety issue for GetEnclaveProvider by converting dictionary to concurrent dictionary. #1451

Changed

• Updated Microsoft.Data.SqlClient.SNI (.NET Framework dependency) and Microsoft.Data.SqlClient.SNI.runtime (.NET Core/Standard dependency) version to v5.0.0-preview1.22062.1. #1537
• Modernized style in ValueUtilSmi. #1351
• Changed SQL server codenames to version names. #1439
• Prevented subtype generation in project files. #1452
• Changed Array.Copy to Buffer.BlockCopy for byte arrays. #1366
• Changed files in csproj to be alphabetically sorted in netfx and netcore. #1364
• Sqlstream, SqlInternalTransaction and MetaDataUtilsSmi are moved to shared folder. #1337, #1346 and #1339
• Various code improvements: #1197, #1313, #1330,#1366, #1435, #1478

Added

• Added new Attestation Protocol None for VBS enclave types. This protocol will allow users to forgo enclave attestation for VBS enclaves. #1489

For detailed release notes, refer to 4.1.0.md

This is the initial public stable release of the Microsoft.SqlServer.Server namespace in a separate assembly. This library is a dependency for Microsoft.Data.SqlClient enabling cross framework support of UDT types.

Detailed release notes are available here.

Added

• Added AppContext switch SuppressInsecureTLSWarning to allow suppression of TLS security warning when using Encrypt=false in the connection string. #1457

Fixed

• Fixed Kerberos authentication failure when using .NET 6. #1411
• Fixed connection failure when using SqlLocalDB instance pipe name. #1433
• Fixed a failure when executing concurrent queries requiring enclaves. #1451
• Updated obsolete API calls targeting .NET 6. #1401

Added

• Added missing SqlClientLogger class to .NET Core refs and missing SqlClientLogger.LogWarning method in .NET Framework refs #1392

Changed

• Avoid throwing unnecessary exception when an invalid SqlNotificationInfo value is received from SQL Server #1378
• Updated Microsoft.Data.SqlClient.SNI (.NET Framework dependency) and Microsoft.Data.SqlClient.SNI.runtime (.NET Core/Standard dependency) version to v4.0.0 #1391

For summary of all changes over v3.0, refer to 4.0.0.md

Breaking changes over preview release v4.0.0-preview2

• Dropped support for .NET Core 2.1 #1272
• [.NET Framework] Exception will not be thrown if a User ID is provided in the connection string when using Active Directory Integrated authentication #1359

Added

• Add GetFieldValueAsync<T> and GetFieldValue<T> support for XmlReader, TextReader, Stream #1019

Fixed

• Fixed FormatException when opening a connection with event tracing enabled #1291
• Fixed improper initialization of ActiveDirectoryAuthenticationProvider #1328
• Fixed MissingMethodException when accessing SqlAuthenticationParameters.ConnectionTimeout #1336
• Fixed data corruption issues by reverting changes to async cancellations #1352
• Fixed performance degradation by reverting changes to MARS state machine #1357
• Fixed bug where environment variables are ignored when using Active Directory Default authentication #1360

Changed

• Removed attributes for classes used in Microsoft.VSDesigner due to lack of support for Microsoft.Data.SqlClient #1296
• Disable encryption when connecting to SQL LocalDB #1312
• Various code health and performance improvements. See milestone for more info.

For detailed release notes, refer 4.0.0-preview3.md

Fixed

• Fixed async thread blocking issues on SqlConnection.Open() for active directory authentication modes. #1270
• Fixed unknown transaction state issues when promoting delegated transaction. 1247
• Fixed issue with connection encryption to ensure connections fail when encryption is required. #1233 Read more
• Fixed bug with LegacyRowVersionNullBehavior App Context switch. #1246
• Fixed recursive calls to RetryLogicProvider when calling SqlCommand.ExecuteScalarAsync. #1245
• Fixed async deadlock scenarios in web contexts with configurable retry logic provider. #1245
• Fixed deadlock in transaction using .NET Framework. #1243
• Fixed issue where connection goes to unusable state. #1238

Breaking changes over preview release v4.0.0-preview1

• Removed Configurable Retry Logic safety switch. #1254

Added

• Added support for SqlFileStream on Windows using .NET Standard 2.0 and above. #1240
• Added support for localdb shared instance using managed SNI. #1237

Fixed

• Fixed .NET decimal conversion from SqlDecimal. #1179
• Fixed Event Source changes on TryBeginExecuteEvent and WriteEndExecuteEvent to address the failure on other MS products such as OpenTelemetry and Application Insight. #1258
• Fixed command's async cancellation. #956
• Fixed deadlock in transaction using .NET Framework. #1242
• Fixed unknown transaction state issues when prompting delegated transaction. 1216

Changed

• Various code improvements #1155 #1236 #1251 #1266

For detailed release notes, refer 4.0.0-preview2.md

Fixed

• Fixed issue with connection encryption to ensure connections fail when encryption is required. #1232
• Fixed issue where connection goes to unusable state. #1239

Breaking changes over stable release 3.0.0

• Changed Encrypt connection string property to be true by default. #1210
• The driver now throws SqlException replacing AggregateException for active directory authentication modes. #1213
• Dropped obsolete Asynchronous Processing connection property from .NET Framework. #1148

Added

• Added SqlCommand.EnableOptimizedParameterBinding property that when enabled increases performance for commands with very large numbers of parameters. #1041
• Included 42108 and 42109 error codes to retriable transient errors list. #1215
• Added new App Context switch to use OS enabled client protocols only. #1168
• Added PoolBlockingPeriod connection property support in .NET Standard. #1181
• Added support for SqlDataReader.GetColumnSchema() in .NET Standard. #1181
• Added PropertyGrid support with component model annotations to SqlConnectionStringBuilder properties for .NET Core. #1152

Fixed

• Fixed issue with connectivity when TLS 1.3 is enabled on client and server. #1168
• Fixed issue with connection encryption to ensure connections fail when encryption is required. #1210
• Fixed issue where connection goes to unusable state. #1128
• Fixed recursive calls to RetryLogicProvider when calling SqlCommand.ExecuteScalarAsync. #1220
• Fixed async deadlock scenarios in web contexts with configurable retry logic provider. #1220
• Fixed EntryPointNotFoundException in InOutOfProcHelper constructor. #1120
• Fixed async thread blocking issues on SqlConnection.Open() for active directory authentication modes. #1213
• Fixed driver behavior for Always Encrypted with secure enclaves to not fail when no user parameters have been provided. #1115
• Fixed bug with LegacyRowVersionNullBehavior App Context switch. #1182
• Fixed issues in Strings.resx file containing error messages. #1136 #1178

Changed

• Updated error code to match with Windows when certificate validation fails in non-Windows client environments. #1130
• Removed designer attributes from SqlCommand and SqlDataAdapter. #1132
• Updated configurable retry logic default retriable error list. #1125
• Improved performance by changing SqlParameter bool fields to flags. #1064
• Improved performance by implementing static delegates. #1060
• Optimized async method allocations in .NET Framework by porting changes from .NET Core. #1084
• Various code improvements #902 #925 #933 #934 #1024 #1057 #1122 #1133 #1134 #1141 #1187 #1188 #1223 #1225 #1226

For detailed release notes, refer 4.0.0-preview1.md

Added

• Introduces column encryption key caching support #1056

Breaking Changes

• Microsoft.Data.SqlClient dependency version upgraded to v3.0.0+ #1111

For detailed notes, refer to 3.0.0.md

Added

• Added support for column encryption key caching when the server supports retrying queries that require enclave computations #1062
• Added support for configurable retry logic configuration file in .NET Standard #1090

Changed

• Updated Microsoft.Data.SqlClient.SNI (.NET Framework dependency) and Microsoft.Data.SqlClient.SNI.runtime (.NET Core/Standard dependency) version to v3.0.0 #1102
• Improved event counter display information #1091

Breaking Changes

• Modified column encryption key store provider registrations to give built-in system providers precedence over providers registered on connection and command instances. #1101

For summary of all changes over v2.1, refer to 3.0.0.md

Fixed

• Fixed wrong data blended with transactions in .NET Core by marking a connection as doomed if the transaction completes or aborts while there is an open result set #1051
• Fixed race condition issues between SinglePhaseCommit and TransactionEnded events #1049

Added

• Added support for "Active Directory Default" authentication mode #1043
• Added support for connection-level and command-level registration of custom key store providers to enable multi-tenant applications to control key store access #1045 #1056 #1078
• Added IP address preference support for TCP connections #1015

Fixed

• Fixed corrupted connection issue when an exception occurs during RPC execution with TVP types #1068
• Fixed race condition issues between SinglePhaseCommit and TransactionEnded events #1042

Changed

• Updated error messages for enclave exceptions to include a link to a troubleshooting guide. #994
• Changes to share common files between projects #1022 #1038 #1040 #1033 #1028 #1039

For detailed release notes, refer 3.0.0-preview3.md

Breaking Changes over preview release v3.0.0-preview1

• User Id connection property now requires Client Id instead of Object Id for User-Assigned Managed Identity #1010
• SqlDataReader now returns a DBNull value instead of an empty byte[]. Legacy behavior can be enabled by setting AppContext switch Switch.Microsoft.Data.SqlClient.LegacyRowVersionNullBehavior #998

Added

• Microsoft.Data.SqlClient now depends on Azure.Identity library to acquire token for "Active Directory Managed Identity/MSI" and "Active Directory Service Principal" authentication modes. #1010
• Upgraded Native SNI dependency to v3.0.0-preview1 along with enhanced event tracing support #1006

Fixed

• Fixed wrong data blended with transactions in .NET Core by marking a connection with open result to be doomed #1023
• Fixed derived parameters containing typename incorrectly #1020
• Fixed server connection leak possibilities when an exception occurs in pooling layer #890
• Fixed IP connection resolving logic in .NET Core #1016 #1031

Changed

• Performance improvements in SqlDateTime to DateTime internal conversion method #912
• Improved memory allocation by avoiding unnecessary context switching 1008
• Updated Microsoft.Identity.Client version from 4.21.1 to 4.22.0 #1036
• Various performance improvements #963 #996 #1004 #1012 #1017
• Event source tracing improvements #1018
• Changes to share common files between NetFx and NetCore source code #871 #887

For detailed release notes, refer 3.0.0-preview2.md.

Breaking Changes over stable release v2.1

• The minimum supported .NET Framework version has been increased to v4.6.1. .NET Framework v4.6.0 is no longer supported. #899

Added

• Added support for Configurable Retry Logic #693 #966
• Added support for Event counters in .NET Core 3.1+ and .NET Standard 2.1+ #719
• Added support for Assembly Context Unloading in .NET Core #913
• Added missing System.Runtime.Caching dependency for .NET Standard assemblies #877

Fixed

• Fixed wrong results issues by changing the timeout timer to ensure a correct execution state #906
• Fixed Kerberos authentication issues when configured Server Principal Name (SPN) didn't contain default port #930
• Fixed MARS header errors when MakeReadAsyncBlocking App Context switch is set to false #910 #922
• Fixed unwanted exceptions being thrown from SqlDataReader.Dispose #920
• Fixed issues connecting to SQL Server instance with instance name specified from Unix environment #870
• Fixed TCP Keep Alive issues in .NET Core #854
• Fixed Kerberos Authentication issues caused due to regression #845
• Fixed issues with System-Assigned Managed Identity in Azure Functions #829
• Fixed missing error messages in Managed SNI #882
• Fixed event source trace string issue #940

Changes

• Changed App Context switch MakeReadAsyncBlocking default to false #937
• Replaced usage of BinaryFormatter with DataContractSerializer #869
• Prohibited DtdProcessing on XmlTextReader instance in .NET Core #884
• Improved performance by reducing memory allocations in SerializeEncodingChar/WriteEncodingChar and some options boxing #785
• Improved performance by preventing orphaned active packets being GC'ed without clear #888
• Various performance improvements #889 #900
• Partial event source tracing improvements in .NET Core #867 #897
• Changes to share common files between NetFx and NetCore source code #827 #835 #838 #881

For detailed release notes, refer 3.0.0-preview1.md.

Fixed

• Fixed wrong results issues by changing the timeout timer to ensure a correct execution state #950
• Fixed MARS header contains errors issue against .NET Framework 4.8+ #959

Added

• Upgraded Azure Key Vault Provider to use new Azure Key Vault libraries #630

Breaking Changes

• Drops support for .NET Framework 4.6. The new minimum supported .NET Framework version is v4.6.1 #630
• Updated dependency of Microsoft.Data.SqlClient on .NET Framework and .NET Core to LTS stable version v1.1.3+ #946

Fixed

• Fixed issue connecting with instance name from a Linux/macOS environment #874
• Fixed wrong results issues by changing the timeout timer to ensure a correct execution state #929
• Fixed a vulnerability by prohibiting DtdProcessing on XmlTextReader instances in .NET Core #885
• Fixed Kerberos authentication when an SPN does not contain the port #935
• Fixed missing error messages in Managed SNI #883
• Fixed missing System.Runtime.Caching dependency for .NET Standard assemblies #878
• Fixed event source tracing issues #941
• Fixed MARS header contains errors issue against .NET Framework 4.8.1 #928

Fixed

• Fixed issue with System-Assigned Managed Identity in Azure Functions #841
• Fixed issue with Kerberos Authentication for .NET Core in Unix environments #848
• Fixed issue with TCP Keep Alive for .NET Core in Unix environments #855