Skip to content

Commit cf97d3e

Browse files
update docs
1 parent be8a321 commit cf97d3e

File tree

6 files changed

+90
-80
lines changed

6 files changed

+90
-80
lines changed

src/Ydb.Sdk/src/Ado/RetryPolicy/YdbRetryPolicy.cs

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -69,14 +69,14 @@ internal YdbRetryPolicy(YdbRetryPolicyConfig config, IRandom random) : this(conf
6969

7070
/// <inheritdoc/>
7171
/// <remarks>
72-
/// This method implements different retry strategies based on the error type:
73-
/// - BadSession/SessionBusy: Immediate retry (TimeSpan.Zero)
74-
/// - Aborted/Undetermined: Fast backoff with full jitter
75-
/// - Unavailable/Transport errors: Fast backoff with equal jitter
76-
/// - Overloaded/Resource exhausted: Slow backoff with equal jitter
77-
/// - Other errors: No retry (null)
72+
/// <para>This method implements different retry strategies based on the YDB status code:</para>
73+
/// <para>- BadSession/SessionBusy: Immediate retry (TimeSpan.Zero)</para>
74+
/// <para>- Aborted/Undetermined: Fast backoff with full jitter</para>
75+
/// <para>- Unavailable/Transport errors: Fast backoff with equal jitter</para>
76+
/// <para>- Overloaded/Resource exhausted: Slow backoff with equal jitter</para>
77+
/// <para>- Other errors: No retry (null)</para>
7878
///
79-
/// The policy respects the maximum attempt limit and idempotence settings.
79+
/// <para>The policy respects the maximum attempt limit and idempotence settings.</para>
8080
/// </remarks>
8181
public TimeSpan? GetNextDelay(YdbException ydbException, int attempt)
8282
{

src/Ydb.Sdk/src/Ado/RetryPolicy/YdbRetryPolicyConfig.cs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ public class YdbRetryPolicyConfig
2525
/// <remarks>
2626
/// The total number of attempts will be MaxAttempts (including the initial attempt).
2727
/// Setting this to 1 disables retries entirely.
28-
/// Default value: 10.
28+
/// <para>Default value: 10.</para>
2929
/// </remarks>
3030
public int MaxAttempts { get; init; } = 10;
3131

@@ -36,7 +36,7 @@ public class YdbRetryPolicyConfig
3636
/// This is used for errors that typically resolve quickly, such as temporary
3737
/// unavailability or TLI (Transaction Lock Invalidated).
3838
/// The actual delay will be calculated using exponential backoff with jitter.
39-
/// Default value: 5 ms.
39+
/// <para>Default value: 5 ms.</para>
4040
/// </remarks>
4141
public int FastBackoffBaseMs { get; init; } = 5;
4242

@@ -47,7 +47,7 @@ public class YdbRetryPolicyConfig
4747
/// This is used for errors that may take longer to resolve, such as overload
4848
/// or resource exhaustion. The actual delay will be calculated using
4949
/// exponential backoff with jitter.
50-
/// Default value: 50 ms.
50+
/// <para>Default value: 50 ms.</para>
5151
/// </remarks>
5252
public int SlowBackoffBaseMs { get; init; } = 50;
5353

@@ -57,7 +57,7 @@ public class YdbRetryPolicyConfig
5757
/// <remarks>
5858
/// This caps the maximum delay for fast backoff to prevent excessively long waits.
5959
/// The exponential backoff will not exceed this value.
60-
/// Default value: 500 ms.
60+
/// <para>Default value: 500 ms.</para>
6161
/// </remarks>
6262
public int FastCapBackoffMs { get; init; } = 500;
6363

@@ -67,7 +67,7 @@ public class YdbRetryPolicyConfig
6767
/// <remarks>
6868
/// This caps the maximum delay for slow backoff to prevent excessively long waits.
6969
/// The exponential backoff will not exceed this value.
70-
/// Default value: 5000 ms.
70+
/// <para>Default value: 5000 ms.</para>
7171
/// </remarks>
7272
public int SlowCapBackoffMs { get; init; } = 5_000;
7373

@@ -80,7 +80,7 @@ public class YdbRetryPolicyConfig
8080
/// some statuses (like unavailable) don't indicate whether the server processed the
8181
/// operation - the connection might have been lost during the response. Enable this
8282
/// only if you are certain that the operations being retried are idempotent.
83-
/// Default value: false.
83+
/// <para>Default value: false.</para>
8484
/// </remarks>
8585
public bool EnableRetryIdempotence { get; init; } = false;
8686

src/Ydb.Sdk/src/Ado/YdbConnection.cs

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,21 +47,27 @@ internal ISession Session
4747
private ISession _session = null!;
4848

4949
/// <summary>
50-
/// Initializes a new instance of the YdbConnection class.
50+
/// Initializes a new instance of the <see cref="YdbConnection"/> class.
5151
/// </summary>
5252
public YdbConnection()
5353
{
5454
}
5555

5656
/// <summary>
57-
/// Initializes a new instance of the YdbConnection class with the specified connection string.
57+
/// Initializes a new instance of the <see cref="YdbConnection"/> class with the specified connection string.
5858
/// </summary>
5959
/// <param name="connectionString">The connection string used to establish the connection.</param>
6060
public YdbConnection(string connectionString)
6161
{
6262
ConnectionStringBuilder = new YdbConnectionStringBuilder(connectionString);
6363
}
6464

65+
/// <summary>
66+
/// Initializes a new instance of the <see cref="YdbConnection"/> class with the specified connection string builder.
67+
/// </summary>
68+
/// <param name="connectionStringBuilder">
69+
/// The <see cref="YdbConnectionStringBuilder"/> used to establish the connection.
70+
/// </param>
6571
public YdbConnection(YdbConnectionStringBuilder connectionStringBuilder)
6672
{
6773
ConnectionStringBuilder = connectionStringBuilder;
@@ -129,6 +135,7 @@ internal async ValueTask OpenAsync(
129135
ConnectionState = ConnectionState.Open;
130136
}
131137

138+
/// <inheritdoc/>
132139
public override async Task CloseAsync()
133140
{
134141
// ReSharper disable once SwitchStatementHandlesSomeKnownEnumValuesWithDefault

src/Ydb.Sdk/src/Ado/YdbDataReader.cs

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -464,11 +464,6 @@ public override int GetInt32(int ordinal)
464464
/// </summary>
465465
/// <param name="ordinal">The zero-based column ordinal.</param>
466466
/// <returns>The value of the specified column.</returns>
467-
/// <summary>
468-
/// Gets the value of the specified column as a 32-bit unsigned integer.
469-
/// </summary>
470-
/// <param name="ordinal">The zero-based column ordinal.</param>
471-
/// <returns>The value of the specified column as a 32-bit unsigned integer.</returns>
472467
public uint GetUint32(int ordinal)
473468
{
474469
var type = UnwrapColumnType(ordinal);

0 commit comments

Comments
 (0)