Skip to content

Commit 120d91a

Browse files
update docs
1 parent cf97d3e commit 120d91a

File tree

7 files changed

+45
-31
lines changed

7 files changed

+45
-31
lines changed

src/Ydb.Sdk/src/Ado/Transaction/TransactionMode.cs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,11 @@ namespace Ydb.Sdk.Ado;
88
/// <remarks>
99
/// TransactionMode defines the isolation level and consistency guarantees
1010
/// for database operations within a transaction.
11-
///
11+
///
12+
/// <para>
1213
/// For more information about YDB transaction modes, see:
1314
/// <see href="https://ydb.tech/docs/en/concepts/transactions">YDB Transactions Documentation</see>.
15+
/// </para>
1416
/// </remarks>
1517
public enum TransactionMode
1618
{

src/Ydb.Sdk/src/Ado/YdbConnectionStringBuilder.cs

Lines changed: 26 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,10 @@ namespace Ydb.Sdk.Ado;
1616
/// YdbConnectionStringBuilder provides strongly-typed properties for building YDB connection strings.
1717
/// It supports all standard ADO.NET connection string parameters plus YDB-specific options.
1818
///
19+
/// <para>
1920
/// For more information about YDB, see:
2021
/// <see href="https://ydb.tech/docs">YDB Documentation</see>.
22+
/// </para>
2123
/// </remarks>
2224
public sealed class YdbConnectionStringBuilder : DbConnectionStringBuilder
2325
{
@@ -69,7 +71,7 @@ private void InitDefaultValues()
6971
/// </summary>
7072
/// <remarks>
7173
/// Specifies the hostname or IP address where the YDB server is running.
72-
/// Default value: localhost.
74+
/// <para>Default value: localhost.</para>
7375
/// </remarks>
7476
public string Host
7577
{
@@ -89,7 +91,7 @@ public string Host
8991
/// <remarks>
9092
/// Specifies the port number where the YDB server is listening.
9193
/// Must be between 1 and 65535.
92-
/// Default value: 2136.
94+
/// <para>Default value: 2136.</para>
9395
/// </remarks>
9496
public int Port
9597
{
@@ -113,7 +115,7 @@ public int Port
113115
/// </summary>
114116
/// <remarks>
115117
/// Specifies the path to the YDB database to connect to.
116-
/// Default value: /local.
118+
/// <para>Default value: /local.</para>
117119
/// </remarks>
118120
public string Database
119121
{
@@ -133,7 +135,7 @@ public string Database
133135
/// <remarks>
134136
/// Specifies the username used for authenticating with the YDB server.
135137
/// If not specified, authentication using a username and password is disabled.
136-
/// Default value: null.
138+
/// <para>Default value: null.</para>
137139
/// </remarks>
138140
public string? User
139141
{
@@ -153,7 +155,7 @@ public string? User
153155
/// <remarks>
154156
/// Specifies the password used for authentication with the YDB server.
155157
/// If not specified, a password is not used.
156-
/// Default value: null.
158+
/// <para>Default value: null.</para>
157159
/// </remarks>
158160
public string? Password
159161
{
@@ -173,7 +175,7 @@ public string? Password
173175
/// <remarks>
174176
/// Specifies the maximum number of sessions that can be created and maintained
175177
/// in the session pool. Must be greater than 0.
176-
/// Default value: 100.
178+
/// <para>Default value: 100.</para>
177179
/// </remarks>
178180
public int MaxSessionPool
179181
{
@@ -198,7 +200,7 @@ public int MaxSessionPool
198200
/// <remarks>
199201
/// Specifies the minimum number of sessions to maintain in the session pool.
200202
/// Must be greater than or equal to 0.
201-
/// Default value: 0.
203+
/// <para>Default value: 0.</para>
202204
/// </remarks>
203205
public int MinSessionPool
204206
{
@@ -223,7 +225,7 @@ public int MinSessionPool
223225
/// <remarks>
224226
/// Specifies how long a session can remain idle before being closed.
225227
/// Must be greater than or equal to 0.
226-
/// Default value: 300 seconds (5 minutes).
228+
/// <para>Default value: 300 seconds (5 minutes).</para>
227229
/// </remarks>
228230
public int SessionIdleTimeout
229231
{
@@ -247,8 +249,8 @@ public int SessionIdleTimeout
247249
/// </summary>
248250
/// <remarks>
249251
/// When true, the connection uses TLS encryption (grpcs://).
250-
/// When false, the connection uses plain text (grpc://).
251-
/// Default value: false.
252+
/// <para>When false, the connection uses plain text (grpc://).</para>
253+
/// <para>Default value: false.</para>
252254
/// </remarks>
253255
public bool UseTls
254256
{
@@ -268,7 +270,7 @@ public bool UseTls
268270
/// <remarks>
269271
/// Specifies the path to a PEM-encoded root certificate file for TLS verification.
270272
/// Setting this property automatically enables TLS (UseTls = true).
271-
/// Default value: null.
273+
/// <para>Default value: null.</para>
272274
/// </remarks>
273275
public string? RootCertificate
274276
{
@@ -290,7 +292,7 @@ public string? RootCertificate
290292
/// <remarks>
291293
/// Specifies the maximum time to wait when establishing a connection to the server.
292294
/// Must be greater than or equal to 0. Set to 0 for infinite timeout.
293-
/// Default value: 10 seconds.
295+
/// <para>Default value: 10 seconds.</para>
294296
/// </remarks>
295297
public int ConnectTimeout
296298
{
@@ -315,7 +317,7 @@ public int ConnectTimeout
315317
/// <remarks>
316318
/// Specifies the interval between keep-alive ping messages to detect broken connections.
317319
/// Must be greater than or equal to 0. Set to 0 to disable keep-alive pings.
318-
/// Default value: 10 seconds.
320+
/// <para>Default value: 10 seconds.</para>
319321
/// </remarks>
320322
public int KeepAlivePingDelay
321323
{
@@ -341,7 +343,7 @@ public int KeepAlivePingDelay
341343
/// Specifies the maximum time to wait for a keep-alive ping response before
342344
/// considering the connection broken. Must be greater than or equal to 0.
343345
/// Set to 0 for infinite timeout.
344-
/// Default value: 5 seconds.
346+
/// <para>Default value: 5 seconds.</para>
345347
/// </remarks>
346348
public int KeepAlivePingTimeout
347349
{
@@ -369,7 +371,7 @@ public int KeepAlivePingTimeout
369371
/// to one node of the cluster. This is rarely needed but can improve performance for
370372
/// high-load scenarios with a single node.
371373
/// When false, uses a single HTTP/2 connection per node.
372-
/// Default value: false.
374+
/// <para>Default value: false.</para>
373375
/// </remarks>
374376
public bool EnableMultipleHttp2Connections
375377
{
@@ -390,7 +392,7 @@ public bool EnableMultipleHttp2Connections
390392
/// Specifies the maximum size of messages that can be sent to the server.
391393
/// Note: server-side limit is 64 MB. Exceeding this limit may result in
392394
/// "resource exhausted" errors or unpredictable behavior.
393-
/// Default value: 4194304 bytes (4 MB).
395+
/// <para>Default value: 4194304 bytes (4 MB).</para>
394396
/// </remarks>
395397
public int MaxSendMessageSize
396398
{
@@ -409,7 +411,7 @@ public int MaxSendMessageSize
409411
/// </summary>
410412
/// <remarks>
411413
/// Specifies the maximum size of messages that can be received from the server.
412-
/// Default value: 4194304 bytes (4 MB).
414+
/// <para>Default value: 4194304 bytes (4 MB).</para>
413415
/// </remarks>
414416
public int MaxReceiveMessageSize
415417
{
@@ -429,7 +431,7 @@ public int MaxReceiveMessageSize
429431
/// <remarks>
430432
/// When true, disables server load balancing and uses direct connections.
431433
/// When false, enables server load balancing for better performance.
432-
/// Default value: false.
434+
/// <para>Default value: false.</para>
433435
/// </remarks>
434436
public bool DisableServerBalancer
435437
{
@@ -449,7 +451,7 @@ public bool DisableServerBalancer
449451
/// <remarks>
450452
/// When true, disables automatic service discovery and uses direct gRPC connections.
451453
/// When false, enables service discovery for automatic endpoint resolution.
452-
/// Default value: false.
454+
/// <para>Default value: false.</para>
453455
/// </remarks>
454456
public bool DisableDiscovery
455457
{
@@ -469,7 +471,7 @@ public bool DisableDiscovery
469471
/// <remarks>
470472
/// Specifies the maximum time to wait when creating a new session.
471473
/// Must be greater than or equal to 0. Set to 0 for infinite timeout.
472-
/// Default value: 5 seconds.
474+
/// <para>Default value: 5 seconds.</para>
473475
/// </remarks>
474476
public int CreateSessionTimeout
475477
{
@@ -498,7 +500,7 @@ public int CreateSessionTimeout
498500
/// and sessions are not stored on the client side. Interactive client transactions are
499501
/// not supported in this mode.
500502
/// When false, the standard YDB sessions for tables (YDB has topics, coordination service, etc.) are used.
501-
/// Default value: false.
503+
/// <para>Default value: false.</para>
502504
/// </remarks>
503505
public bool EnableImplicitSession
504506
{
@@ -517,7 +519,7 @@ public bool EnableImplicitSession
517519
/// </summary>
518520
/// <remarks>
519521
/// Specifies the logger factory used for creating loggers throughout the SDK.
520-
/// Default value: NullLoggerFactory.Instance (no logging).
522+
/// <para>Default value: NullLoggerFactory.Instance (no logging).</para>
521523
/// </remarks>
522524
public ILoggerFactory LoggerFactory { get; init; } = NullLoggerFactory.Instance;
523525

@@ -527,7 +529,7 @@ public bool EnableImplicitSession
527529
/// <remarks>
528530
/// Specifies the credentials provider used for authenticating with the YDB server.
529531
/// If not provided, authentication is not used.
530-
/// Default value: null.
532+
/// <para>Default value: null.</para>
531533
/// </remarks>
532534
public ICredentialsProvider? CredentialsProvider { get; init; }
533535

@@ -537,7 +539,7 @@ public bool EnableImplicitSession
537539
/// <remarks>
538540
/// Specifies additional server certificates to trust for TLS verification.
539541
/// If not provided, the system certificate store is used.
540-
/// Default value: null.
542+
/// <para>Default value: null.</para>
541543
/// </remarks>
542544
public X509Certificate2Collection? ServerCertificates { get; init; }
543545

src/Ydb.Sdk/src/Ado/YdbDataSource.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,10 @@ namespace Ydb.Sdk.Ado;
1515
/// for handling transient failures. The data source can execute operations with automatic
1616
/// retry logic and transaction management.
1717
///
18+
/// <para>
1819
/// For more information about YDB, see:
1920
/// <see href="https://ydb.tech/docs">YDB Documentation</see>.
21+
/// </para>
2022
/// </remarks>
2123
public class YdbDataSource
2224
#if NET7_0_OR_GREATER

src/Ydb.Sdk/src/Ado/YdbDataSourceBuilder.cs

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,11 @@ namespace Ydb.Sdk.Ado;
99
/// YdbDataSourceBuilder provides a fluent interface for configuring connection strings
1010
/// and retry policies before building a YdbDataSource instance. It supports both
1111
/// string-based and strongly-typed connection string configuration.
12-
///
12+
///
13+
/// <para>
1314
/// For more information about YDB, see:
1415
/// <see href="https://ydb.tech/docs">YDB Documentation</see>.
16+
/// </para>
1517
/// </remarks>
1618
public class YdbDataSourceBuilder
1719
{
@@ -68,11 +70,11 @@ public YdbDataSourceBuilder(YdbConnectionStringBuilder connectionStringBuilder)
6870
public string ConnectionString => ConnectionStringBuilder.ConnectionString;
6971

7072
/// <summary>
71-
/// Gets or sets the retry policy for the data source.
73+
/// Gets or sets the default retry policy for the data source.
7274
/// </summary>
7375
/// <remarks>
7476
/// Specifies the retry policy to use for handling transient failures.
75-
/// Default value is a YdbRetryPolicy with default configuration.
77+
/// <para>Default value: <see cref="YdbRetryPolicy"/> with default configuration <see cref="YdbRetryPolicyConfig.Default"/>.</para>
7678
/// </remarks>
7779
public IRetryPolicy RetryPolicy { get; set; } = new YdbRetryPolicy(YdbRetryPolicyConfig.Default);
7880

src/Ydb.Sdk/src/Ado/YdbProviderFactory.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,10 @@ namespace Ydb.Sdk.Ado;
1010
/// It provides methods to create connections, commands, parameters, and other ADO.NET objects
1111
/// that are specific to the YDB database provider.
1212
///
13+
/// <para>
1314
/// For more information about YDB, see:
1415
/// <see href="https://ydb.tech/docs">YDB Documentation</see>.
16+
/// </para>
1517
/// </remarks>
1618
public class YdbProviderFactory : DbProviderFactory
1719
{

src/Ydb.Sdk/src/Ado/YdbTransaction.cs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,10 @@ namespace Ydb.Sdk.Ado;
1313
/// changes made within the transaction. The transaction mode determines the isolation level and
1414
/// consistency guarantees.
1515
///
16-
/// For more information about YDB transactions, see:
16+
/// <para>
17+
/// For more information about YDB transaction modes, see:
1718
/// <see href="https://ydb.tech/docs/en/concepts/transactions">YDB Transactions Documentation</see>.
19+
/// </para>
1820
/// </remarks>
1921
public sealed class YdbTransaction : DbTransaction
2022
{

src/Ydb.Sdk/src/Ado/YdbType/YdbDbType.cs

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,11 @@ namespace Ydb.Sdk.Ado.YdbType;
77
/// </summary>
88
/// <remarks>
99
/// YdbDbType represents the primitive data types supported by YDB.
10-
///
10+
///
11+
/// <para>
1112
/// For more information about YDB primitive types, see:
12-
/// <see href="https://ydb.tech/docs/en/yql/reference/types/primitive">YDB Primitive Types Documentation</see>
13+
/// <see href="https://ydb.tech/docs/en/yql/reference/types/primitive">YDB Primitive Types Documentation</see>.
14+
/// </para>
1315
/// </remarks>
1416
public enum YdbDbType
1517
{

0 commit comments

Comments
 (0)