diff --git a/doc/snippets/Microsoft.Data.SqlClient/SqlCommand.xml b/doc/snippets/Microsoft.Data.SqlClient/SqlCommand.xml index 1bc3c94f48..76833928db 100644 --- a/doc/snippets/Microsoft.Data.SqlClient/SqlCommand.xml +++ b/doc/snippets/Microsoft.Data.SqlClient/SqlCommand.xml @@ -2818,12 +2818,12 @@ The built-in column master key store providers that are available for the Window You must set the value for this property before the command is executed for it to take effect. To apply the retry logic, do the following steps before executing the command: -1. Define the configuration parameters by using or . +1. Define the configuration parameters by using type. 2. Create a by using one of the following static methods of the class: - - - - - - - - + - + - + - + - 3. Assign the object to the `RetryLogicProvider` property. > [!NOTE] @@ -2851,8 +2851,9 @@ The blocking connection simulates a situation like a command still running in th ### How to use with legacy asynchronous commands Besides assigning the provider to the command and executing the command, it's possible to run it directly using the following methods: -- -- +- +- +- [!code-csharp[SqlConfigurableRetryLogic_SqlCommand#4](~/../sqlclient/doc/samples/SqlConfigurableRetryLogic_SqlCommand.cs#4)] diff --git a/doc/snippets/Microsoft.Data.SqlClient/SqlConfigurableRetryFactory.xml b/doc/snippets/Microsoft.Data.SqlClient/SqlConfigurableRetryFactory.xml index 69420194e8..cbeb9de0b1 100644 --- a/doc/snippets/Microsoft.Data.SqlClient/SqlConfigurableRetryFactory.xml +++ b/doc/snippets/Microsoft.Data.SqlClient/SqlConfigurableRetryFactory.xml @@ -37,7 +37,7 @@ The following table shows the inner transient error list. - An object of containing the configuration for the object. + An object of containing the configuration for the object. Provides an exponential time interval retry logic provider. A object. @@ -58,7 +58,7 @@ The following table shows the inner transient error list. - An object of containing the configuration for the object. + An object of containing the configuration for the object. Provides an incremental time interval retry logic provider. A object. @@ -79,7 +79,7 @@ The following table shows the inner transient error list. - An object of containing the configuration for the object. + An object of containing the configuration for the object. Provides a fixed interval time retry logic provider. A object. diff --git a/doc/snippets/Microsoft.Data.SqlClient/SqlConnection.xml b/doc/snippets/Microsoft.Data.SqlClient/SqlConnection.xml index 81b4e407fe..1e08bc23d2 100644 --- a/doc/snippets/Microsoft.Data.SqlClient/SqlConnection.xml +++ b/doc/snippets/Microsoft.Data.SqlClient/SqlConnection.xml @@ -1104,12 +1104,12 @@ The built-in column master key store providers that are available for the Window You must set the value for this property before opening the connection to take effect. To apply the retry logic, do the following steps before opening the connection: -1. Define the configuration parameters by using or . +1. Define the configuration parameters by using type. 2. Create a by using one of the following static methods of the class: - - - - - - - - + - + - + - + - 3. Assign the object to the `RetryLogicProvider` property. > [!NOTE] diff --git a/doc/snippets/Microsoft.Data.SqlClient/SqlRetryIntervalBaseEnumerator.xml b/doc/snippets/Microsoft.Data.SqlClient/SqlRetryIntervalBaseEnumerator.xml index cd079b95bd..8856f2fe22 100644 --- a/doc/snippets/Microsoft.Data.SqlClient/SqlRetryIntervalBaseEnumerator.xml +++ b/doc/snippets/Microsoft.Data.SqlClient/SqlRetryIntervalBaseEnumerator.xml @@ -12,7 +12,7 @@ The maximum time allowed as a gap time. The minimum time allowed as a gap time. Initializes a new instance of the class. - The supplied arguments failed validation. + The supplied arguments failed validation. The default gap time of each interval. diff --git a/doc/snippets/Microsoft.Data.SqlClient/SqlRetryLogicBase.xml b/doc/snippets/Microsoft.Data.SqlClient/SqlRetryLogicBase.xml index 0a02389a76..3766fa205e 100644 --- a/doc/snippets/Microsoft.Data.SqlClient/SqlRetryLogicBase.xml +++ b/doc/snippets/Microsoft.Data.SqlClient/SqlRetryLogicBase.xml @@ -22,7 +22,7 @@ Delegate to a transient condition predicate. The function that this delegate points to must return a true value when an expected transient exception happens. - value that delegates to a function that receives a input parameter. + value that delegates to a function that receives a input parameter. The sender object. diff --git a/doc/snippets/Microsoft.Data.SqlClient/SqlRetryLogicBaseProvider.xml b/doc/snippets/Microsoft.Data.SqlClient/SqlRetryLogicBaseProvider.xml index 59085c3e6d..9828d34437 100644 --- a/doc/snippets/Microsoft.Data.SqlClient/SqlRetryLogicBaseProvider.xml +++ b/doc/snippets/Microsoft.Data.SqlClient/SqlRetryLogicBaseProvider.xml @@ -34,9 +34,7 @@ The object that the `function` returns when executed. The source of the event. The operation to re-execute if a transient condition occurs. - Executes a function and applies retry logic, if enabled. - - Exceptions will be reported via an aggregate exception if the execution isn't successful via retry attempts. + Executes a function and applies retry logic, if enabled. **Note:** Exceptions will be reported via an aggregate exception if the execution isn't successful via retry attempts. The return value of the `function` if it runs without exception. @@ -56,9 +54,7 @@ The source of the event. The operation to re-execute if a transient condition occurs. The cancellation instruction. - Executes a function and applies retry logic, if enabled. The cancellation token can be used to request that the operation be abandoned before the execution attempts are exceeded. - - Exceptions will be reported via the returned Task object, which will contain an aggregate exception if execution fails for all retry attempts. + Executes a function and applies retry logic, if enabled. The cancellation token can be used to request that the operation be abandoned before the execution attempts are exceeded. **Note:** Exceptions will be reported via the returned Task object, which will contain an aggregate exception if execution fails for all retry attempts. A task representing the asynchronous operation. The results of the task will be the return value of the `function`, if it runs without exception. The source of the event. The operation to re-execute if a transient condition occurs. The cancellation instruction. - Executes a function and applies retry logic, if enabled. The cancellation token can be used to request that the operation be abandoned before the execution attempts are exceeded. - - Exceptions will be reported via the returned Task object, which will contain an aggregate exception if execution fails for all retry attempts. + Executes a function and applies retry logic, if enabled. The cancellation token can be used to request that the operation be abandoned before the execution attempts are exceeded. **Note:** Exceptions will be reported via the returned Task object, which will contain an aggregate exception if execution fails for all retry attempts. A Task or an exception. Sets a pre-retry validation function on the to only include specific SQL statements. - The pre-retry validation delegate function; if the `CommandText` is authorized to retry the operation. + The pre-retry validation delegate function; if the `CommandText` is authorized to retry the operation.