diff --git a/CHANGELOG.md b/CHANGELOG.md index f8c69434f9..a7afe535e5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -827,6 +827,55 @@ This update brings the below changes over the previous release: - Added Microsoft.SqlServer.Types to verify support for SqlHierarchyId and Spatial for .NET Core. [#1848](https://github.com/dotnet/SqlClient/pull/1848) - Code health improvements:[#1943](https://github.com/dotnet/SqlClient/pull/1943)[#1949](https://github.com/dotnet/SqlClient/pull/1949)[#1198](https://github.com/dotnet/SqlClient/pull/1198)[#1829](https://github.com/dotnet/SqlClient/pull/1829) +## [Stable release 5.1.8] - 2025-11-14 + +This update brings the following changes since the [5.1.7](release-notes/5.1/5.1.7.md) release: + +### Added + +#### App Context Switch for Ignoring Server-Provided Failover Partner + +*What Changed:* + +- A new app context switch `Switch.Microsoft.Data.SqlClient.IgnoreServerProvidedFailoverPartner` was introduced to let the client ignore server-provided failover partner info in Basic Availability Groups (BAGs). When the switch is enabled, only the failover partner specified in the connection string is used; server-supplied partner values are skipped. This context switch was introduced in PR [#3704](https://github.com/dotnet/SqlClient/pull/3704). + +*Who Benefits:* + +- Applications connecting to SQL Server BAGs using TCP and custom ports, especially where the server's provided partner name lacks the protocol, host, or port. This avoids connection failures when the server-provided partner is incompatible or incomplete. +- Teams who manage availability groups and rely on client-side control of failover behavior in heterogeneous networking environments. + +*Impact:* + +- If your environment might be affected (i.e., you operate a BAG with custom ports, or have experienced failures after failover), you can enable the new switch in your application: + +```c# +AppContext.SetSwitch("Switch.Microsoft.Data.SqlClient.IgnoreServerProvidedFailoverPartner", true); +``` + +- Then, ensure your connection string includes your preferred failover partner (with correct `tcp:host,port`) so that the client uses that instead of the server's suggestion. +- Without enabling this, by default, the client continues to prefer the server-provided partner, maintaining backwards compatibility. + +### Fixed + +- Fixed a bulk copy bug that incorrectly prepended a UTF-8 Byte-Order-Marker + when processing row data. + ([#3617](https://github.com/dotnet/SqlClient/pull/3617)) + +### Changed + +- Modernized creation of `Microsoft.Identity.Client.PublicClientApplication` + instances to use its builder pattern. + ([#3367](https://github.com/dotnet/SqlClient/pull/3367)) +- Replaced use of undocumented .NET Framework internals when reading + `SqlDecimal` values. + ([#3465](https://github.com/dotnet/SqlClient/pull/3465)) +- Updated the following dependencies + ([#3754](https://github.com/dotnet/SqlClient/pull/3754)): + - Azure.Core 1.41.0 + (Avoids transitive [vulnerability](https://github.com/Azure/azure-sdk-for-net/issues/44817)) + - Azure.Identity 1.12.1 + - Microsoft.Identity.Client 4.76.0 + ## [Stable release 5.1.7] - 2025-04-25 This update brings the following changes since the 5.1.6 release: diff --git a/release-notes/5.1/5.1.8.md b/release-notes/5.1/5.1.8.md new file mode 100644 index 0000000000..2a4b9e654a --- /dev/null +++ b/release-notes/5.1/5.1.8.md @@ -0,0 +1,126 @@ +# Release Notes + +## Microsoft.Data.SqlClient 5.1.8 - November 14, 2025 + +This update brings the following changes since the [5.1.7](5.1.7.md) release: + +### Added + +#### App Context Switch for Ignoring Server-Provided Failover Partner + +*What Changed:* + +- A new app context switch `Switch.Microsoft.Data.SqlClient.IgnoreServerProvidedFailoverPartner` was introduced to let the client ignore server-provided failover partner info in Basic Availability Groups (BAGs). When the switch is enabled, only the failover partner specified in the connection string is used; server-supplied partner values are skipped. This context switch was introduced in PR [#3704](https://github.com/dotnet/SqlClient/pull/3704). + +*Who Benefits:* + +- Applications connecting to SQL Server BAGs using TCP and custom ports, especially where the server's provided partner name lacks the protocol, host, or port. This avoids connection failures when the server-provided partner is incompatible or incomplete. +- Teams who manage availability groups and rely on client-side control of failover behavior in heterogeneous networking environments. + +*Impact:* + +- If your environment might be affected (i.e., you operate a BAG with custom ports, or have experienced failures after failover), you can enable the new switch in your application: + +```c# +AppContext.SetSwitch("Switch.Microsoft.Data.SqlClient.IgnoreServerProvidedFailoverPartner", true); +``` + +- Then, ensure your connection string includes your preferred failover partner (with correct `tcp:host,port`) so that the client uses that instead of the server's suggestion. +- Without enabling this, by default, the client continues to prefer the server-provided partner, maintaining backwards compatibility. + +### Fixed + +- Fixed a bulk copy bug that incorrectly prepended a UTF-8 Byte-Order-Marker + when processing row data. + ([#3617](https://github.com/dotnet/SqlClient/pull/3617)) + +### Changed + +- Modernized creation of `Microsoft.Identity.Client.PublicClientApplication` + instances to use its builder pattern. + ([#3367](https://github.com/dotnet/SqlClient/pull/3367)) +- Replaced use of undocumented .NET Framework internals when reading + `SqlDecimal` values. + ([#3465](https://github.com/dotnet/SqlClient/pull/3465)) +- Updated the following dependencies + ([#3754](https://github.com/dotnet/SqlClient/pull/3754)): + - Azure.Core 1.41.0 + (Avoids transitive [vulnerability](https://github.com/Azure/azure-sdk-for-net/issues/44817)) + - Azure.Identity 1.12.1 + - Microsoft.Identity.Client 4.76.0 + +## Target Platform Support + +- .NET Framework 4.6.2+ (Windows x86, Windows x64) +- .NET 6.0+ (Windows x86, Windows x64, Windows ARM64, Windows ARM, Linux, macOS) +- .NET Standard 2.0+ (Windows x86, Windows x64, Windows ARM64, Windows ARM, Linux, macOS) + +## Dependencies + +### .NET Framework + +- Azure.Core 1.41.0 +- Azure.Identity 1.12.1 +- Microsoft.Data.SqlClient.SNI 5.1.2 +- Microsoft.Identity.Client 4.76.0 +- Microsoft.IdentityModel.JsonWebTokens 6.35.0 +- Microsoft.IdentityModel.Protocols.OpenIdConnect 6.35.0 +- System.Buffers 4.5.1 +- System.Text.Encoding.Web 6.0.1 +- System.Text.Json 6.0.11 + +### .NET 6.0 + +- Azure.Core 1.41.0 +- Azure.Identity 1.12.1 +- Microsoft.Data.SqlClient.SNI.runtime 5.1.2 +- Microsoft.Identity.Client 4.76.0 +- Microsoft.IdentityModel.JsonWebTokens 6.35.0 +- Microsoft.IdentityModel.Protocols.OpenIdConnect 6.35.0 +- Microsoft.SqlServer.Server 1.0.0 +- System.Configuration.ConfigurationManager 6.0.1 +- System.Diagnostics.DiagnosticSource 6.0.1 +- System.Runtime.Caching 6.0.0 +- System.Security.Permissions 6.0.0 +- System.Security.Principal.Windows 5.0.0 +- System.Text.Encoding.CodePages 6.0.0 +- System.Text.Encodings.Web 6.0.1 + +### .NET Standard 2.0 + +- Azure.Core 1.41.0 +- Azure.Identity 1.12.1 +- Microsoft.Data.SqlClient.SNI.runtime 5.1.2 +- Microsoft.Identity.Client 4.76.0 +- Microsoft.IdentityModel.JsonWebTokens 6.35.0 +- Microsoft.IdentityModel.Protocols.OpenIdConnect 6.35.0 +- Microsoft.SqlServer.Server 1.0.0 +- Microsoft.Win32.Registry 5.0.0 +- System.Buffers 4.5.1 +- System.Configuration.ConfigurationManager 6.0.1 +- System.Runtime.Caching 6.0.0 +- System.Runtime.Loader 4.3.0 +- System.Security.Cryptography.Cng 5.0.0 +- System.Security.Permissions 6.0.0 +- System.Security.Principal.Windows 5.0.0 +- System.Text.Encoding.CodePages 6.0.0 +- System.Text.Encodings.Web 6.0.1 + +### .NET Standard 2.1 + +- Azure.Core 1.41.0 +- Azure.Identity 1.12.1 +- Microsoft.Data.SqlClient.SNI.runtime 5.1.2 +- Microsoft.Identity.Client 4.76.0 +- Microsoft.IdentityModel.JsonWebTokens 6.35.0 +- Microsoft.IdentityModel.Protocols.OpenIdConnect 6.35.0 +- Microsoft.SqlServer.Server 1.0.0 +- Microsoft.Win32.Registry 5.0.0 +- System.Configuration.ConfigurationManager 6.0.1 +- System.Runtime.Caching 6.0.0 +- System.Runtime.Loader 4.3.0 +- System.Security.Cryptography.Cng 5.0.0 +- System.Security.Permissions 6.0.0 +- System.Security.Principal.Windows 5.0.0 +- System.Text.Encoding.CodePages 6.0.0 +- System.Text.Encodings.Web 6.0.1 diff --git a/release-notes/5.1/README.md b/release-notes/5.1/README.md index 27ed889b2a..cfae1a8695 100644 --- a/release-notes/5.1/README.md +++ b/release-notes/5.1/README.md @@ -4,6 +4,7 @@ The following Microsoft.Data.SqlClient 5.1 stable releases have been shipped: | Release Date | Version | Notes | | :-- | :-- | :--: | +| 2025/11/12 | 5.1.8 | [release notes](5.1.8.md) | | 2025/04/25 | 5.1.7 | [release notes](5.1.7.md) | | 2024/08/27 | 5.1.6 | [release notes](5.1.6.md) | | 2024/01/29 | 5.1.5 | [release notes](5.1.5.md) | diff --git a/release-notes/README.md b/release-notes/README.md index f2d7c0b452..c74a1bd0dc 100644 --- a/release-notes/README.md +++ b/release-notes/README.md @@ -1,6 +1,6 @@ # Microsoft.Data.SqlClient Release Notes -The latest stable release is [Microsoft.Data.SqlClient 6.0](6.0). +The latest stable release is [Microsoft.Data.SqlClient 6.1](6.1). ## Release Information