Skip to content

Commit 862b51a

Browse files
author
electricessence
authored
Update README.md
1 parent 21e8021 commit 862b51a

1 file changed

Lines changed: 10 additions & 10 deletions

File tree

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Useful set of utilities and abstractions for simplifying modern database operati
44

55
## Connection Factories
66

7-
Connection factories facilitate creation and disposal of connections without the concern of a connection reference or need for awareness of a connection string. A ```SqlConnectionFactory``` is provided and can be overriden to provide more specific dependency injection configurations.
7+
Connection factories facilitate creation and disposal of connections without the concern of a connection reference or need for awareness of a connection string. A `SqlConnectionFactory` is provided and can be overriden to provide more specific dependency injection configurations.
88

99
## Expressive Commands
1010

@@ -28,7 +28,7 @@ var result = connectionFactory
2828

2929
End-to-end asynchronous methods suffixed with `Async`.
3030

31-
When using the SQL Client, asychronous methods are available as well as ```.ToTargetBlockAsync<T>(target)``` and ``.AsSourceBlockAsync&lt;T&gt;()`` Dataflow methods.
31+
When using the SQL Client, asychronous methods are available as well as `.ToTargetBlockAsync<T>(target)` and `.AsSourceBlockAsync<T>()` Dataflow methods.
3232

3333
## Extensions
3434

@@ -51,9 +51,9 @@ var myResult = await cmd.ToListAsync(transform);
5151

5252
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.
5353

54-
#### ```Results<T>()``` and ```ResultsAsync<T>()```
54+
#### `Results<T>()` and `ResultsAsync<T>()`
5555

56-
Queues 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```.
56+
Queues 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`.
5757

5858
Optionally a field to column override map can be passed as a parameter. If a column is set as `null` then that field is ignored (not applied to the model).
5959

@@ -86,18 +86,18 @@ var people = cmd.Results<Person>(new Dictionary<string,string>{
8686

8787
#### `Retrieve()` and `RetrieveAsync()`
8888

89-
Queues all the data. Returns a ```QueryResult<Queue<object[]>>``` containing the requested data and column information. The `.AsDequeueingMappedEnumerable()` extension will iteratively convert the results to dictionaries for ease of access.
89+
Queues all the data. Returns a `QueryResult<Queue<object[]>>` containing the requested data and column information. The `.AsDequeueingMappedEnumerable()` extension will iteratively convert the results to dictionaries for ease of access.
9090

91-
#### ```AsSourceBlockAsync<T>()```
91+
#### `AsSourceBlockAsync<T>()`
9292

9393
(Fully asynchronous.) 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.
9494

95-
### ```AsSourceBlockAsync<T>()``` versus ```ResultsAsync<T>```
95+
### `AsSourceBlockAsync<T>()` versus `ResultsAsync<T>`
9696

9797
Depending on the level of asynchrony in your application, you may want to avoid too much buffering of data.
9898

99-
```AsSourceBlockAsync<T>()``` is fully asynchronous from end-to-end and can keep total buffering to a minimum by consuming (receiving) results as fast as possible, but may incur additional latency between reads.
99+
`AsSourceBlockAsync<T>()` is fully asynchronous from end-to-end and can keep total buffering to a minimum by consuming (receiving) results as fast as possible, but may incur additional latency between reads.
100100

101-
```ResultsAsync<T>()``` is fully asynchronous from end-to-end but returns an `IEnumerable<T>` that although has fully buffered the all the data into memory, has deferred the transformation until enumerated. This way, the asynchronous data pipeline is fully complete before synchronously transforming the data.
101+
`ResultsAsync<T>()` is fully asynchronous from end-to-end but returns an `IEnumerable<T>` that although has fully buffered the all the data into memory, has deferred the transformation until enumerated. This way, the asynchronous data pipeline is fully complete before synchronously transforming the data.
102102

103-
Both methods ultimately are using a ```Queue<object[]>``` or ```ConcurrentQueue<object[]>``` (Dataflow) to buffer the data, but ```ResultsAsync<T>()``` buffers the entire data set before dequeuing and transforming the results.
103+
Both methods ultimately are using a `Queue<object[]>` or `ConcurrentQueue<object[]>` (Dataflow) to buffer the data, but `ResultsAsync<T>()` buffers the entire data set before dequeuing and transforming the results.

0 commit comments

Comments
 (0)