Skip to content

Commit 26e9bb6

Browse files
Documentation/release notes updates
1 parent 5053515 commit 26e9bb6

File tree

3 files changed

+34
-12
lines changed

3 files changed

+34
-12
lines changed

doc/snippets/Microsoft.Data.SqlClient/SqlConnectionStringBuilder.xml

Lines changed: 30 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -210,10 +210,30 @@ Modified: Data Source=(local);Initial Catalog=AdventureWorks;Integrated Security
210210
<ConnectRetryCount>
211211
<summary>The number of reconnections attempted after identifying that there was an idle connection failure. This must be an integer between 0 and 255. Default is 1. Set to 0 to disable reconnecting on idle connection failures. An <see cref="T:System.ArgumentException" /> will be thrown if set to a value outside of the allowed range.</summary>
212212
<value>The number of reconnections attempted after identifying that there was an idle connection failure.</value>
213+
<remarks>
214+
<format type="text/markdown">
215+
<![CDATA[
216+
217+
## Remarks
218+
This property corresponds to the "Connect Retry Count" key within the <xref:Microsoft.Data.SqlClient.SqlConnection> connection string.
219+
220+
]]>
221+
</format>
222+
</remarks>
213223
</ConnectRetryCount>
214224
<ConnectRetryInterval>
215225
<summary>Amount of time (in seconds) between each reconnection attempt after identifying that there was an idle connection failure. This must be an integer between 1 and 60. The default is 10 seconds. An <see cref="T:System.ArgumentException" /> will be thrown if set to a value outside of the allowed range.</summary>
216226
<value>Amount of time (in seconds) between each reconnection attempt after identifying that there was an idle connection failure.</value>
227+
<remarks>
228+
<format type="text/markdown">
229+
<![CDATA[
230+
231+
## Remarks
232+
This property corresponds to the "Connect Retry Interval" key within the <xref:Microsoft.Data.SqlClient.SqlConnection> connection string.
233+
234+
]]>
235+
</format>
236+
</remarks>
217237
</ConnectRetryInterval>
218238
<ConnectTimeout>
219239
<summary>Gets or sets the length of time (in seconds) to wait for a connection to the server before terminating the attempt and generating an error.</summary>
@@ -500,7 +520,7 @@ False
500520
<format type="text/markdown"><![CDATA[
501521
502522
## Remarks
503-
This property corresponds to the "MultipleActiveResultSets" key within the connection string.
523+
This property corresponds to the "Multiple Active Result Sets" key within the connection string.
504524
505525
506526
@@ -582,10 +602,13 @@ False
582602
<summary>The blocking period behavior for a connection pool.</summary>
583603
<value>The available blocking period settings.</value>
584604
<remarks>
585-
<format type="text/markdown"><![CDATA[
605+
<format type="text/markdown">
606+
<![CDATA[
586607
587608
## Remarks
588-
When connection pooling is enabled and a timeout error or other login error occurs, an exception will be thrown and subsequent connection attempts will fail for the next five seconds, the "blocking period". If the application attempts to connect within the blocking period, the first exception will be thrown again. Subsequent failures after a blocking period ends will result in a new blocking period that is twice as long as the previous blocking period, up to a maximum of one minute.
609+
This property corresponds to the "Pool Blocking Period" key within the connection string.
610+
611+
When connection pooling is enabled and a timeout error or other login error occurs, an exception will be thrown and subsequent connection attempts will fail for the next five seconds, the "blocking period". If the application attempts to connect within the blocking period, the first exception will be thrown again. Subsequent failures after a blocking period ends will result in a new blocking period that is twice as long as the previous blocking period, up to a maximum of one minute.
589612
590613
Attempting to connect to Azure SQL databases can fail with transient errors which are typically recovered within a few seconds. However, with the connection pool blocking period behavior, you may not be able to reach your database for extensive periods even though the database is available. This is especially problematic for apps that need to render fast. The **PoolBlockingPeriod** enables you to select the blocking period best suited for your app. See the <xref:Microsoft.Data.SqlClient.PoolBlockingPeriod> enumeration for available settings.
591614
@@ -721,9 +744,9 @@ Database = AdventureWorks
721744
<format type="text/markdown"><![CDATA[
722745
723746
## Remarks
724-
If the `MultiSubnetFailover` key is set to `true`, `TransparentNetworkIPResolution` is ignored.
747+
If the `Multi Subnet Failover` key is set to `true`, `Transparent Network IP Resolution` is ignored.
725748
726-
If the `Failover Partner` key is set, `TransparentNetworkIPResolution` is ignored.
749+
If the `Failover Partner` key is set, `Transparent Network IP Resolution` is ignored.
727750
728751
The value of this key must be `true`, `false`, `yes`, or `no`.
729752
@@ -757,7 +780,7 @@ Database = AdventureWorks
757780
<format type="text/markdown"><![CDATA[
758781
759782
## Remarks
760-
When `TrustServerCertificate` is set to `true`, the transport layer will use SSL to encrypt the channel and bypass walking the certificate chain to validate trust. If `TrustServerCertificate` is set to `true` and encryption is turned on, the encryption level specified on the server will be used even if `Encrypt` is set to `false`. The connection will fail otherwise.
783+
When `Trust Server Certificate` is set to `true`, the transport layer will use SSL to encrypt the channel and bypass walking the certificate chain to validate trust. If `Trust Server Certificate` is set to `true` and encryption is enforced by target server, the encryption level specified on the server will be used even if `Encrypt` is set to `false`. The connection will fail otherwise.
761784
762785
For more information, see [Encryption Hierarchy](/sql/relational-databases/security/encryption/encryption-hierarchy) and [Using Encryption Without Validation](/sql/relational-databases/native-client/features/using-encryption-without-validation).
763786
@@ -774,9 +797,7 @@ Database = AdventureWorks
774797
<format type="text/markdown"><![CDATA[
775798
776799
## Remarks
777-
The <xref:Microsoft.Data.SqlClient.SqlConnectionStringBuilder.TryGetValue%2A> method lets developers safely retrieve a value from a <xref:Microsoft.Data.SqlClient.SqlConnectionStringBuilder> without needing to verify that the supplied key name is a valid key name. Because **TryGetValue** does not raise an exception when you call it, passing in a nonexistent key, you do not have to look for a key before retrieving its value. Calling **TryGetValue** with a nonexistent key will place the value null (`Nothing` in Visual Basic) in the `value` parameter.
778-
779-
800+
The <xref:Microsoft.Data.SqlClient.SqlConnectionStringBuilder.TryGetValue%2A> method lets developers safely retrieve a value from a <xref:Microsoft.Data.SqlClient.SqlConnectionStringBuilder> without needing to verify that the supplied key name is a valid key name. Because **TryGetValue** does not raise an exception when you call it, passing in a nonexistent key, you do not have to look for a key before retrieving its value. Calling **TryGetValue** with a nonexistent key will place the value null (`Nothing` in Visual Basic) in the `value` parameter.
780801
781802
## Examples
782803
The following example demonstrates the behavior of the **TryGetValue** method.

release-notes/2.0/2.0.0-preview4.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ This update brings the below changes over the previous release:
2020

2121
### Breaking Changes
2222
- For .NET Framework applications consuming **Microsoft.Data.SqlClient**, the `SNI.dll` files previously downloaded to the `bin\x64` and `bin\x86` folders are now named `Microsoft.Data.SqlClient.SNI.x64.dll` and `Microsoft.Data.SqlClient.SNI.x86.dll` and will be downloaded to the `bin` directory, to support auto-loading in the application process [#570](https://github.com/dotnet/SqlClient/pull/570). This change is not going to impact client applications unless a direct reference has been made to `SNI.dll` or the x86 and x64 folders.
23-
23+
- New connection string property synonyms will replace old properties when fetching connection string from `SqlConnectionStringBuilder` for consistency. [Read More](#new-connection-string-property-synonyms)
2424

2525
## New Connection string property synonyms
2626

@@ -37,7 +37,7 @@ The below connection properties can be interchangeably used with the new synonym
3737
| TransparentNetworkIPResolution | Transparent Network IP Resolution |
3838
| TrustServerCertificate | Trust Server Certificate |
3939

40-
> Note: This is not a breaking change. Old properties will continue to be supported for backwards compatibility.
40+
> Old properties will continue to be supported for backwards compatibility, but the new connection string properties will now be included when fetching connection string from [SqlConnectionStringBuilder](https://docs.microsoft.com/dotnet/api/microsoft.data.sqlclient.sqlconnectionstringbuilder).
4141
4242
## Target Platform Support
4343

release-notes/2.0/2.0.0.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,7 @@ All changes in Microsoft.Data.SqlClient v2.0 over v1.1:
102102
- For .NET Framework applications consuming **Microsoft.Data.SqlClient**, the `SNI.dll` files previously downloaded to the `bin\x64` and `bin\x86` folders are now named `Microsoft.Data.SqlClient.SNI.x64.dll` and `Microsoft.Data.SqlClient.SNI.x86.dll` and will be downloaded to the `bin` directory, to support auto-loading in the application process [#570](https://github.com/dotnet/SqlClient/pull/570). _This change is not going to impact client applications unless a direct reference has been made to `SNI.dll` or the x86 and x64 folders._
103103
- Modified enclave provider interface `SqlColumnEncryptionEnclaveProvider` to be internal along with related classes `SqlEnclaveAttestationParameters` and `SqlEnclaveSession` [#602](https://github.com/dotnet/SqlClient/pull/602) - _This change is not likely to impact customer applications since secure enclaves is a relatively new feature and they would have had to implement their own enclave provider, which is not a trivial task_.
104104
- Updated `SqlClientMetaDataCollectionNames` exposed constants by removing non-existing constants and adding new to the metadata collection [#580](https://github.com/dotnet/SqlClient/pull/580)
105+
- New connection string property synonyms will replace old properties when fetching connection string from `SqlConnectionStringBuilder` for consistency. [Read More](#new-connection-string-property-synonyms)
105106

106107

107108
### Additional Active Directory authentication modes
@@ -182,7 +183,7 @@ The below connection properties can be interchangeably used with the new synonym
182183
| TransparentNetworkIPResolution | Transparent Network IP Resolution |
183184
| TrustServerCertificate | Trust Server Certificate |
184185

185-
> [Note] This is not a breaking change. Old properties will continue to be supported for backwards compatibility.
186+
> Old properties will continue to be supported for backwards compatibility, but the new connection string properties will now be included when fetching connection string from [SqlConnectionStringBuilder](https://docs.microsoft.com/dotnet/api/microsoft.data.sqlclient.sqlconnectionstringbuilder).
186187
187188

188189
#### SqlBulkCopy.RowsCopied property

0 commit comments

Comments
 (0)