Skip to content

Commit e4c851d

Browse files
committed
Implement async schema APIs. Fixes #835
1 parent 8c49746 commit e4c851d

File tree

10 files changed

+245
-73
lines changed

10 files changed

+245
-73
lines changed
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
title: GetSchemaAsync
3+
---
4+
5+
# MySqlConnection.GetSchemaAsync method
6+
7+
Asynchronously returns schema information for the data source of this [`MySqlConnection`](../../MySqlConnectionType/).
8+
9+
```csharp
10+
public Task<DataTable> GetSchemaAsync(string collectionName = null, string[] restrictions = null,
11+
CancellationToken cancellationToken = default(CancellationToken))
12+
```
13+
14+
| parameter | description |
15+
| --- | --- |
16+
| collectionName | The schema name of data to be returned; if `null`, the `MetaDataCollections` schema is returned. |
17+
| restrictions | The restrictions to apply to the schema; this parameter is currently ignored. |
18+
| cancellationToken | A token to cancel the asynchronous operation. |
19+
20+
## See Also
21+
22+
* class [MySqlConnection](../../MySqlConnectionType/)
23+
* namespace [MySqlConnector](../../MySqlConnectionType/)
24+
* assembly [MySqlConnector](../../../MySqlConnectorAssembly/)
25+
26+
<!-- DO NOT EDIT: generated by xmldocmd for MySqlConnector.dll -->

docs/content/api/MySqlConnector/MySqlConnectionType.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ public sealed class MySqlConnection : DbConnection, ICloneable
4141
| override [EnlistTransaction](../MySqlConnection/EnlistTransaction/)(…) | |
4242
| override [GetSchema](../MySqlConnection/GetSchema/)() | |
4343
| override [GetSchema](../MySqlConnection/GetSchema/)(…) | (2 methods) |
44+
| [GetSchemaAsync](../MySqlConnection/GetSchemaAsync/)(…) | Asynchronously returns schema information for the data source of this [`MySqlConnection`](../MySqlConnectionType/). |
4445
| override [Open](../MySqlConnection/Open/)() | |
4546
| override [OpenAsync](../MySqlConnection/OpenAsync/)(…) | |
4647
| [Ping](../MySqlConnection/Ping/)() | |
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
title: GetColumnSchemaAsync
3+
---
4+
5+
# MySqlDataReader.GetColumnSchemaAsync method
6+
7+
Returns metadata about the columns in the result set.
8+
9+
```csharp
10+
public Task<ReadOnlyCollection<DbColumn>> GetColumnSchemaAsync(
11+
CancellationToken cancellationToken = default(CancellationToken))
12+
```
13+
14+
| parameter | description |
15+
| --- | --- |
16+
| cancellationToken | A token to cancel the operation. |
17+
18+
## Return Value
19+
20+
A Task containing ReadOnlyCollection containing metadata about the result set.
21+
22+
## Remarks
23+
24+
This method runs synchronously; prefer to call [`GetColumnSchema`](../GetColumnSchema/) to avoid the overhead of allocating an unnecessary `Task`.
25+
26+
## See Also
27+
28+
* class [MySqlDataReader](../../MySqlDataReaderType/)
29+
* namespace [MySqlConnector](../../MySqlDataReaderType/)
30+
* assembly [MySqlConnector](../../../MySqlConnectorAssembly/)
31+
32+
<!-- DO NOT EDIT: generated by xmldocmd for MySqlConnector.dll -->

docs/content/api/MySqlConnector/MySqlDataReader/GetSchemaTable.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,16 @@ title: GetSchemaTable
44

55
# MySqlDataReader.GetSchemaTable method
66

7+
Returns a DataTable that contains metadata about the columns in the result set.
8+
79
```csharp
810
public override DataTable GetSchemaTable()
911
```
1012

13+
## Return Value
14+
15+
A DataTable containing metadata about the columns in the result set.
16+
1117
## See Also
1218

1319
* class [MySqlDataReader](../../MySqlDataReaderType/)
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
title: GetSchemaTableAsync
3+
---
4+
5+
# MySqlDataReader.GetSchemaTableAsync method
6+
7+
Returns a DataTable that contains metadata about the columns in the result set.
8+
9+
```csharp
10+
public Task<DataTable> GetSchemaTableAsync(
11+
CancellationToken cancellationToken = default(CancellationToken))
12+
```
13+
14+
| parameter | description |
15+
| --- | --- |
16+
| cancellationToken | A token to cancel the operation. |
17+
18+
## Return Value
19+
20+
A DataTable containing metadata about the columns in the result set.
21+
22+
## Remarks
23+
24+
This method runs synchronously; prefer to call [`GetSchemaTable`](../GetSchemaTable/) to avoid the overhead of allocating an unnecessary `Task`.
25+
26+
## See Also
27+
28+
* class [MySqlDataReader](../../MySqlDataReaderType/)
29+
* namespace [MySqlConnector](../../MySqlDataReaderType/)
30+
* assembly [MySqlConnector](../../../MySqlConnectorAssembly/)
31+
32+
<!-- DO NOT EDIT: generated by xmldocmd for MySqlConnector.dll -->

docs/content/api/MySqlConnector/MySqlDataReaderType.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ public sealed class MySqlDataReader : DbDataReader, IDbColumnSchemaGenerator
3030
| [GetChar](../MySqlDataReader/GetChar/)(…) | |
3131
| override [GetChars](../MySqlDataReader/GetChars/)(…) | |
3232
| [GetColumnSchema](../MySqlDataReader/GetColumnSchema/)() | Returns metadata about the columns in the result set. |
33+
| [GetColumnSchemaAsync](../MySqlDataReader/GetColumnSchemaAsync/)(…) | Returns metadata about the columns in the result set. |
3334
| override [GetDataTypeName](../MySqlDataReader/GetDataTypeName/)(…) | |
3435
| override [GetDateTime](../MySqlDataReader/GetDateTime/)(…) | |
3536
| [GetDateTime](../MySqlDataReader/GetDateTime/)(…) | |
@@ -57,7 +58,8 @@ public sealed class MySqlDataReader : DbDataReader, IDbColumnSchemaGenerator
5758
| override [GetName](../MySqlDataReader/GetName/)(…) | |
5859
| override [GetOrdinal](../MySqlDataReader/GetOrdinal/)(…) | |
5960
| [GetSByte](../MySqlDataReader/GetSByte/)(…) | (2 methods) |
60-
| override [GetSchemaTable](../MySqlDataReader/GetSchemaTable/)() | |
61+
| override [GetSchemaTable](../MySqlDataReader/GetSchemaTable/)() | Returns a DataTable that contains metadata about the columns in the result set. |
62+
| [GetSchemaTableAsync](../MySqlDataReader/GetSchemaTableAsync/)(…) | Returns a DataTable that contains metadata about the columns in the result set. |
6163
| override [GetStream](../MySqlDataReader/GetStream/)(…) | |
6264
| [GetStream](../MySqlDataReader/GetStream/)(…) | |
6365
| override [GetString](../MySqlDataReader/GetString/)(…) | |

0 commit comments

Comments
 (0)