Skip to content

Commit 67b0f8c

Browse files
update docs
1 parent 19b501b commit 67b0f8c

File tree

3 files changed

+22
-2
lines changed

3 files changed

+22
-2
lines changed

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,6 @@ internal async ValueTask OpenAsync(
135135
ConnectionState = ConnectionState.Open;
136136
}
137137

138-
/// <inheritdoc/>
139138
public override async Task CloseAsync()
140139
{
141140
// ReSharper disable once SwitchStatementHandlesSomeKnownEnumValuesWithDefault

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -249,7 +249,7 @@ public int SessionIdleTimeout
249249
/// </summary>
250250
/// <remarks>
251251
/// When true, the connection uses TLS encryption (grpcs://).
252-
/// <para>When false, the connection uses plain text (grpc://).</para>
252+
/// When false, the connection uses plain text (grpc://).
253253
/// <para>Default value: false.</para>
254254
/// </remarks>
255255
public bool UseTls

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

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -797,6 +797,13 @@ public override IEnumerator<YdbDataRecord> GetEnumerator()
797797
/// <remarks>
798798
/// This method closes the reader and releases any resources associated with it.
799799
/// If the reader is closed during a transaction, the transaction will be marked as failed.
800+
///
801+
/// <para>
802+
/// Important: If the stream is not fully read to the end, the session associated with this stream
803+
/// and the corresponding <see cref="YdbConnection"/> will be marked as invalid to avoid
804+
/// <see cref="StatusCode.SessionBusy"/> errors. Because the session may be returned to the pool
805+
/// and immediately reused for a new request while the previous one is still not completed.
806+
/// </para>
800807
/// </remarks>
801808
public override async Task CloseAsync()
802809
{
@@ -831,6 +838,13 @@ public override async Task CloseAsync()
831838
/// <remarks>
832839
/// This method closes the reader and releases any resources associated with it.
833840
/// If the reader is closed during a transaction, the transaction will be marked as failed.
841+
///
842+
/// <para>
843+
/// Important: If the stream is not fully read to the end, the session associated with this stream
844+
/// and the corresponding <see cref="YdbConnection"/> will be marked as invalid to avoid
845+
/// <see cref="StatusCode.SessionBusy"/> errors. Because the session may be returned to the pool
846+
/// and immediately reused for a new request while the previous one is still not completed.
847+
/// </para>
834848
/// </remarks>
835849
public override void Close() => CloseAsync().GetAwaiter().GetResult();
836850

@@ -922,6 +936,13 @@ private void OnFailReadStream()
922936
/// <returns>A ValueTask representing the asynchronous disposal operation.</returns>
923937
/// <remarks>
924938
/// This method closes the reader and releases any resources associated with it.
939+
///
940+
/// <para>
941+
/// Important: If the stream is not fully read to the end, the session associated with this stream
942+
/// and the corresponding <see cref="YdbConnection"/> will be marked as invalid to avoid
943+
/// <see cref="StatusCode.SessionBusy"/> errors. Because the session may be returned to the pool
944+
/// and immediately reused for a new request while the previous one is still not completed.
945+
/// </para>
925946
/// </remarks>
926947
public override async ValueTask DisposeAsync() => await CloseAsync();
927948

0 commit comments

Comments
 (0)