Skip to content

Commit 1a6ba3f

Browse files
committed
Add compatibility note on ResetConnectionAsync.
1 parent 0ac5dde commit 1a6ba3f

File tree

2 files changed

+7
-0
lines changed

2 files changed

+7
-0
lines changed

docs/content/api/MySqlConnector/MySqlConnection/ResetConnectionAsync.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,10 @@ public ValueTask ResetConnectionAsync(
1919

2020
A `ValueTask` representing the asynchronous operation.
2121

22+
## Remarks
23+
24+
This is an optional feature of the MySQL protocol and may not be supported by all servers. It's known to be supported by MySQL Server 5.7.3 (and later) and MariaDB 10.2.4 (and later). Other MySQL-compatible servers or proxies may not support this command.
25+
2226
## See Also
2327

2428
* class [MySqlConnection](../../MySqlConnectionType/)

src/MySqlConnector/MySqlConnection.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -423,6 +423,9 @@ internal async Task OpenAsync(IOBehavior? ioBehavior, CancellationToken cancella
423423
/// </summary>
424424
/// <param name="cancellationToken">A token to cancel the asynchronous operation.</param>
425425
/// <returns>A <c>ValueTask</c> representing the asynchronous operation.</returns>
426+
/// <remarks>This is an optional feature of the MySQL protocol and may not be supported by all servers.
427+
/// It's known to be supported by MySQL Server 5.7.3 (and later) and MariaDB 10.2.4 (and later).
428+
/// Other MySQL-compatible servers or proxies may not support this command.</remarks>
426429
#if NET45 || NET461 || NET471 || NETSTANDARD1_3 || NETSTANDARD2_0
427430
public async Task ResetConnectionAsync(CancellationToken cancellationToken = default)
428431
#else

0 commit comments

Comments
 (0)