Skip to content

Commit 2999f31

Browse files
author
electricessence
authored
Update README.md
1 parent cf64f98 commit 2999f31

1 file changed

Lines changed: 8 additions & 4 deletions

File tree

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49,10 +49,14 @@ var myResult = await cmd.ToListAsync(transform);
4949

5050
In order to keep connection open time to a minimum, some methods cache data before closing the connection and then subsequently applying the transformations as needed.
5151

52-
#### `Results<T>` &amp; `ResultsAsync<T>`
52+
#### `Results<T>()`
5353

54-
Using the provided type `T` entity, the data is coerced by which properties intersect with the ones available to the ```IDataReader```.
54+
Synchronously queries (pulls all the data). Then using the provided type `T` entity, the data is coerced by which properties intersect with the ones available to the ```IDataReader```.
5555

56-
#### `Retrieve` &amp; `RetrieveAsync`
56+
#### `Retrieve()`
5757

58-
Returns a `List<Dictionary<string, object>>` containing the requested data. Takes parameters to isolate the desired columns.
58+
Synchronously queries (pulls all the data). Returns a `QueryResult<Queue<object[]>>` containing the requested data and column mappings. The `.AsDequeueingMappedEnumerable()` extension will iteratively convert the results to dictionaries for ease of access.
59+
60+
#### `AsSourceBlockAsync()`
61+
62+
Retuns a Dataflow source block. Then asynchronously buffers and transforms the results allowing for any possible Dataflow configuration. The source block is marked as complete when there are no more results. If the block is somehow marked as complete externally, the flow of data will stop and the connection will close.

0 commit comments

Comments
 (0)