Release Notes for Microsoft.Data.SqlClient 1.1.0 GA (#320)

cheenamalhotra · web-flow · commit d4d621c67617 · 2019-11-20T14:44:28.000-08:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,38 +4,53 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 
-## [Preview Release 1.1.0-preview1.19309.1] - 2019-11-04
+## [Stable Release 1.1.0] - 2019-11-20
 
 ### Added
+- Added support for |DataDirectory| macro in `AttachDBFilename` for .NET Core client [#284](https://github.com/dotnet/SqlClient/pull/284)
 
+### Fixed
+- Fixed connection resiliency check [#310](https://github.com/dotnet/SqlClient/pull/310)
+- Fixed `SNIPacket.ReadFromStreamAsync` to not consume same `ValueTask` twice [#295](https://github.com/dotnet/SqlClient/pull/295)
+- Fixed driver behavior to not send Attention signal for successful Bulk Copy operation [#308](https://github.com/dotnet/SqlClient/pull/308)
+- Fixed driver behavior to abort connection when encountering `SqlException` on `SqlTransaction.Commit` [#299](https://github.com/dotnet/SqlClient/pull/299)
+- Fixed driver behavior to not throw exception on invalid *app.config* files [#319](https://github.com/dotnet/SqlClient/pull/319)
+
+### Changes
+- Improved async read performance by adding multi-packet target buffer caching [#285](https://github.com/dotnet/SqlClient/pull/285)
+- Improved performance of `TdsParserStateObject` and `SqlDataReader` snapshot mechanisms [#198](https://github.com/dotnet/SqlClient/pull/198)
+- Updated `SqlDataReader.Close` documentation [#314](https://github.com/dotnet/SqlClient/pull/314)
+
+
+## [Preview Release 1.1.0-preview2.19309.1] - 2019-11-04
+
+### Added
 - Add support for secure enclaves with Always Encrypted [#293](https://github.com/dotnet/SqlClient/pull/293)
 
 ### Fixed
-
-- Setting the value DbParameter.DbType to DbType.Time property fails after setting the Value property [#5](https://github.com/dotnet/SqlClient/issues/5)
-- SQLDataAdapter.FillSchema doesn't mark computed columns as readonly [#275](https://github.com/dotnet/SqlClient/issues/275)
-- SqlDependency.Start throws FileNotFoundException [#260](https://github.com/dotnet/SqlClient/issues/260)
-- Misleading ADP_OpenReaderExists exception message on MARS-disabled Sql Connection when incorrectly doing parallel requests [#82](https://github.com/dotnet/SqlClient/issues/82)
-- SqlClient ManualTest MARSSyncTimeoutTest fails in managed mode [#108](https://github.com/dotnet/SqlClient/issues/108)
-- System.Data.SqlClient.SqlInternalConnectionTds constructor purges original call stack when re-throwing an exception [#100](https://github.com/dotnet/SqlClient/issues/100)
-- InvalidOperationException(SqlException) on SqlBulkCopy [#221](https://github.com/dotnet/SqlClient/issues/221)
-- Exception message grammar: "An SqlParameter [...] is not contained by this SqlParameterCollection" [#159](https://github.com/dotnet/SqlClient/issues/159)
-- Fixing incorrect event id and opcode for the SqlEventSource [#241](https://github.com/dotnet/SqlClient/pull/241)
+- Setting the value `DbParameter.DbType` to `DbType.Time` property fails after setting the Value property [#5](https://github.com/dotnet/SqlClient/issues/5)
+- `SQLDataAdapter.FillSchema` doesn't mark computed columns as readonly [#275](https://github.com/dotnet/SqlClient/issues/275)
+- `SqlDependency.Start` throws `FileNotFoundException` [#260](https://github.com/dotnet/SqlClient/issues/260)
+- Misleading `ADP_OpenReaderExists` exception message on MARS-disabled Sql Connection when incorrectly doing parallel requests [#82](https://github.com/dotnet/SqlClient/issues/82)
+- SqlClient ManualTest `MARSSyncTimeoutTest` fails in managed mode [#108](https://github.com/dotnet/SqlClient/issues/108)
+- `System.Data.SqlClient.SqlInternalConnectionTds` constructor purges original call stack when re-throwing an exception [#100](https://github.com/dotnet/SqlClient/issues/100)
+- `InvalidOperationException(SqlException)` on `SqlBulkCopy` [#221](https://github.com/dotnet/SqlClient/issues/221)
+- Exception message grammar: "An SqlParameter [...] is not contained by this `SqlParameterCollection`" [#159](https://github.com/dotnet/SqlClient/issues/159)
+- Fixing incorrect event id and opcode for the `SqlEventSource` [#241](https://github.com/dotnet/SqlClient/pull/241)
 
 ### Changes
-
 - Update dependency to Microsoft.Data.SqlClient.SNI v1.1.0 [#276](https://github.com/dotnet/SqlClient/pull/276)
 - Correct timeout remarks for async command methods [#264](https://github.com/dotnet/SqlClient/pull/264)
-- Improve SqlBulkCopy truncation error message [#256](https://github.com/dotnet/SqlClient/issues/256)
-- Intellisense tooltip for SqlCommand's CommandTimeout doesn't describe units [#33](https://github.com/dotnet/SqlClient/issues/33)
+- Improve `SqlBulkCopy` truncation error message [#256](https://github.com/dotnet/SqlClient/issues/256)
+- Intellisense tooltip for `SqlCommand`'s `CommandTimeout` doesn't describe units [#33](https://github.com/dotnet/SqlClient/issues/33)
 - Enable SQL Command text for non-stored procs in EventSource events for .NET Framework [242](https://github.com/dotnet/SqlClient/pull/242)
 - Many test changes to support a public CI
 
 
 ## [Preview Release 1.1.0-preview1.19275.1] - 2019-10-02
 
 ### Added
-- Added SqlFileStream support for .NET Framework with `Microsoft.Data.SqlTypes.SqlFileStream` class introduced. [#210](https://github.com/dotnet/SqlClient/pull/210)
+- Added `SqlFileStream` support for .NET Framework with `Microsoft.Data.SqlTypes.SqlFileStream` class introduced. [#210](https://github.com/dotnet/SqlClient/pull/210)
 - Added support for Visual Studio Intellisense with XML Documentation. [#210](https://github.com/dotnet/SqlClient/pull/210)
 
 ### Changes
diff --git a/README.md b/README.md
@@ -24,9 +24,13 @@ The Microsoft.Data.SqlClient NuGet package is available on [NuGet.org](https://w
 
 ## SNI Package References
 
-For the .NET Framework driver on Windows, a package reference to [Microsoft.Data.SqlClient.SNI](https://www.nuget.org/packages/Microsoft.Data.SqlClient.SNI/) loads `x64` and `x86` platform specific `SNI.dll` libraries into the client's build directories.
+For the .NET Framework driver on Windows, a package reference to [Microsoft.Data.SqlClient.SNI](https://www.nuget.org/packages/Microsoft.Data.SqlClient.SNI/) loads `x64` and `x86` native `SNI.dll` libraries into the client's build directories.
+
+For the .NET Core driver on Windows, a package reference to [runtime.native.System.Data.SqlClient.sni](https://www.nuget.org/packages/runtime.native.System.Data.SqlClient.sni/) loads `arm64`, `x64` and `x86` native `SNI.dll` libraries into the client's build directories.
+
+**Note**
+When referencing the native `SNI.dll` on Windows, the Microsoft Visual C++ Redistributable is required to be installed: [The latest supported Visual C++ downloads](https://support.microsoft.com/en-us/help/2977003/the-latest-supported-visual-c-downloads)
 
-For the .NET Core driver on Windows, a package reference to [runtime.native.System.Data.SqlClient.sni](https://www.nuget.org/packages/runtime.native.System.Data.SqlClient.sni/) loads `arm64`, `x64` and `x86` platform specific `SNI.dll` libraries into the client's build directories.
 
 ## Helpful Links
 
diff --git a/release-notes/1.1/1.1.0-preview2.md b/release-notes/1.1/1.1.0-preview2.md
@@ -78,10 +78,9 @@ New features over the 1.0 release of Microsoft.Data.SqlClient.
 
 In general, existing documentation which uses System.Data.SqlClient on .NET Framework should now work with .NET Core, too.
 
-- [Develop using Always Encrypted with .NET Framework Data Provider](https://docs.microsoft.com/sql/relational-databases/security/encryption/develop-using-always-encrypted-with-net-framework-data-provider?view=sql-server-2017)
+- [Develop using Always Encrypted with .NET Framework Data Provider](https://docs.microsoft.com/sql/relational-databases/security/encryption/develop-using-always-encrypted-with-net-framework-data-provider)
 - [Always Encrypted: Protect sensitive data and store encryption keys in the Windows certificate store](https://docs.microsoft.com/azure/sql-database/sql-database-always-encrypted)
 
 In order to use the enclave feature, connection strings should include the required attestation protocol and attestation URL. Examples:
 
 - `Attestation Protocol=HGS;Enclave Attestation Url=<attestation_url_for_HGS>`
-- `Attestation Protocol=AAS;Enclave Attestation Url=<attestation_url_for_AAS>`
diff --git a/release-notes/1.1/1.1.0.md b/release-notes/1.1/1.1.0.md
@@ -0,0 +1,81 @@
+# Release Notes
+
+## General Availability of Microsoft.Data.SqlClient 1.1.0 released 20 November 2019
+
+This update brings the below changes over the previous release:
+
+### Added
+- Added support for |DataDirectory| macro in `AttachDBFilename` for .NET Core client [#284](https://github.com/dotnet/SqlClient/pull/284)
+
+### Fixed
+- Fixed connection resiliency check [#310](https://github.com/dotnet/SqlClient/pull/310)
+- Fixed `SNIPacket.ReadFromStreamAsync` to not consume same `ValueTask` twice [#295](https://github.com/dotnet/SqlClient/pull/295)
+- Fixed driver behavior to not send Attention signal for successful Bulk Copy operation [#308](https://github.com/dotnet/SqlClient/pull/308)
+- Fixed driver behavior to abort connection when encountering `SqlException` on `SqlTransaction.Commit` [#299](https://github.com/dotnet/SqlClient/pull/299)
+- Fixed driver behavior to not throw exception on invalid *app.config* files [#319](https://github.com/dotnet/SqlClient/pull/319)
+
+### Changes
+- Improved async read performance by adding multi-packet target buffer caching [#285](https://github.com/dotnet/SqlClient/pull/285)
+- Improved performance of `TdsParserStateObject` and `SqlDataReader` snapshot mechanisms [#198](https://github.com/dotnet/SqlClient/pull/198)
+- Updated `SqlDataReader.Close` documentation [#314](https://github.com/dotnet/SqlClient/pull/314)
+
+### New Features
+
+New features over the 1.0 release of Microsoft.Data.SqlClient.
+
+- [Always Encrypted with secure enclaves](#always-encrypted-with-secure-enclaves) - Always Encrypted is available starting in Microsoft SQL Server 2016. Secure enclaves are available starting in Microsoft SQL Server 2019.
+
+## Target Platform Support
+
+- .NET Framework 4.6+
+- .NET Core 2.1+ (Windows x86, Windows x64, Linux, macOS)
+- .NET Standard 2.0+ (Windows x86, Windows x64, Linux, macOS)
+
+### Dependencies
+
+#### .NET Framework
+
+- System.Data.Common 4.3.0
+- Microsoft.Data.SqlClient.SNI 1.1.0
+- Microsoft.Identity.Client 3.0.8
+- Microsoft.IdentityModel.Protocols.OpenIdConnect 5.5.0
+- Microsoft.IdentityModel.JsonWebTokens 5.5.0
+
+#### .NET Core
+
+- Microsoft.Win32.Registry 4.5.0
+- runtime.native.System.Data.SqlClient.sni 4.4.0
+- System.Security.Principal.Windows 4.5.0
+- System.Text.Encoding.CodePages 4.5.0
+- System.Configuration.ConfigurationManager 4.5.0
+- Microsoft.Identity.Client 3.0.8
+- Microsoft.IdentityModel.Protocols.OpenIdConnect 5.5.0
+- Microsoft.IdentityModel.JsonWebTokens 5.5.0
+
+#### .NET Standard
+
+- Microsoft.Win32.Registry 4.5.0
+- runtime.native.System.Data.SqlClient.sni 4.4.0
+- System.Buffers 4.4.0
+- System.Diagnostics.DiagnosticSource 4.5.0
+- System.Memory 4.5.1
+- System.Security.Principal.Windows 4.5.0
+- System.Text.Encoding.CodePages 4.5.0
+- System.Configuration.ConfigurationManager 4.5.0
+- Microsoft.Identity.Client 3.0.8
+
+**C++ Runtime Required on Windows**
+
+When running on Windows, this library has a dependency on Microsoft.Data.SqlClient.SNI on .NET Framework and runtime.native.System.Data.SqlClient.sni on .NET Core, which requires the Microsoft Visual C++ Redistributable to be installed:
+https://support.microsoft.com/en-us/help/2977003/the-latest-supported-visual-c-downloads
+
+### Always Encrypted with secure enclaves
+
+In general, existing documentation which uses System.Data.SqlClient on .NET Framework should now work with .NET Core, too.
+
+- [Develop using Always Encrypted with .NET Framework Data Provider](https://docs.microsoft.com/sql/relational-databases/security/encryption/develop-using-always-encrypted-with-net-framework-data-provider)
+- [Always Encrypted: Protect sensitive data and store encryption keys in the Windows certificate store](https://docs.microsoft.com/azure/sql-database/sql-database-always-encrypted)
+
+In order to use the enclave feature, connection strings should include the required attestation protocol and attestation URL. Examples:
+
+- `Attestation Protocol=HGS;Enclave Attestation Url=<attestation_url_for_HGS>`
diff --git a/release-notes/1.1/1.1.md b/release-notes/1.1/1.1.md
@@ -1,5 +1,11 @@
 # Microsoft.Data.SqlClient 1.1 Releases
 
+The following Microsoft.Data.SqlClient 1.1 stable releases have been shipped:
+
+| Release Date | Version | Notes |
+| :-- | :-- | :--: |
+| 2019/11/20 | 1.1.0 | [release notes](1.1.0.md) |
+
 The following Microsoft.Data.SqlClient 1.1 preview releases have been shipped:
 
 | Release Date | Version | Notes |
diff --git a/release-notes/1.1/README.md b/release-notes/1.1/README.md
@@ -1,5 +1,11 @@
 # Microsoft.Data.SqlClient 1.1 Releases
 
+The following Microsoft.Data.SqlClient 1.1 stable releases have been shipped:
+
+| Release Date | Version | Notes |
+| :-- | :-- | :--: |
+| 2019/11/20 | 1.1.0 | [release notes](1.1.0.md) |
+
 The following Microsoft.Data.SqlClient 1.1 preview releases have been shipped:
 
 | Release Date | Version | Notes |
diff --git 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 1.0](1.0).
+The latest stable release is [Microsoft.Data.SqlClient 1.1](1.1).
 
 ## Release Information
 
@@ -9,7 +9,7 @@ The latest stable release is [Microsoft.Data.SqlClient 1.0](1.0).
 
 # Microsoft.Data.SqlClient.AlwaysEncrypted.AzureKeyVaultProvider Release Notes
 
-The latest preview release is [Microsoft.Data.SqlClient.AlwaysEncrypted.AzureKeyVaultProvider 1.0](add-ons/AzureKeyVaultProvider/1.0).
+The latest stable release is [Microsoft.Data.SqlClient.AlwaysEncrypted.AzureKeyVaultProvider 1.0](add-ons/AzureKeyVaultProvider/1.0).
 
 ## Release Information
 
diff --git a/roadmap.md b/roadmap.md
@@ -11,8 +11,9 @@ The Microsoft.Data.SqlClient roadmap communicates project priorities for evolvin
 
 | Milestone                 | Release Date | Project Board |
 |---------------------------|--------------|---------------|
-| Microsoft.Data.SqlClient 1.0 (servicing) | As needed (see also [releases](https://github.com/dotnet/sqlclient/blob/master/release-notes/1.0)) | [SqlClient 1.0.0](https://github.com/dotnet/SqlClient/projects/3)|
-| Microsoft.Data.SqlClient 1.1 | GA (General Availability) scheduled for November 2019 | [SqlClient 1.1.0](https://github.com/dotnet/SqlClient/projects/4)|
+| Microsoft.Data.SqlClient v1.0 (servicing) | As needed (see also [1.0 releases](https://github.com/dotnet/sqlclient/blob/master/release-notes/1.0)) | Closed |
+| Microsoft.Data.SqlClient v1.1 (servicing) | As needed (see also [1.1 releases](https://github.com/dotnet/sqlclient/blob/master/release-notes/1.1)) | Closed |
+| Microsoft.Data.SqlClient v1.2 | GA (General Availability) estimated for May 2020 | [SqlClient 1.2.0](https://github.com/dotnet/SqlClient/projects/5) |
 
 > Note: Dates are calendar year (as opposed to fiscal year).
 
