Skip to content

Commit 2fa239c

Browse files
author
Oren (electricessence)
committed
Updated docs.
1 parent d6f93a1 commit 2fa239c

50 files changed

Lines changed: 4191 additions & 2052 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

Core/Open.Database.Extensions.Core.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050
</ItemGroup>
5151

5252
<ItemGroup>
53-
<!--<PackageReference Include="docfx.console" Version="2.47.0">
53+
<!--<PackageReference Include="docfx.console" Version="2.56.1">
5454
<PrivateAssets>all</PrivateAssets>
5555
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
5656
</PackageReference>-->

Core/README.md

Lines changed: 0 additions & 121 deletions
This file was deleted.

Core/index.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
11
# Open.Database.Extensions
22

3-
[Full API Documentation](https://electricessence.github.io/Open.Database.Extensions/api/index.html)
3+
[![NuGet](https://img.shields.io/nuget/v/Open.Database.Extensions.Core.svg?style=flat)](https://www.nuget.org/packages/Open.Database.Extensions.Core/)
4+
5+
[Full API Documentation](https://open-net-libraries.github.io/Open.Database.Extensions/api/index.html)
46

57
Useful set of utilities and abstractions for simplifying modern database operations and ensuring dependency injection compatibility.
68

79
## Connection Factories
810

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

1114
## Expressive Commands
1215

@@ -34,14 +37,14 @@ var myResult = new List<T>();
3437
using(var reader = await mySqlCommand.ExecuteReaderAsync(CommandBehavior.CloseConnection))
3538
{
3639
while(await reader.ReadAsync())
37-
list.Add(transform(reader));
40+
myResult.Add(transform(reader));
3841
}
3942
```
4043

4144
Is now simplified to this:
4245

4346
```cs
44-
var myResult = await cmd.ToListAsync(transform);
47+
var myResult = await mySqlCommand.ToListAsync(transform);
4548
```
4649

4750
## Deferred Transformation

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
11
# Open.Database.Extensions
22

3-
[Full API Documentation](https://electricessence.github.io/Open.Database.Extensions/api/index.html)
3+
[![NuGet](https://img.shields.io/nuget/v/Open.Database.Extensions.Core.svg?style=flat)](https://www.nuget.org/packages/Open.Database.Extensions.Core/)
4+
5+
[Full API Documentation](https://open-net-libraries.github.io/Open.Database.Extensions/api/index.html)
46

57
Useful set of utilities and abstractions for simplifying modern database operations and ensuring dependency injection compatibility.
68

79
## Connection Factories
810

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

1114
## Expressive Commands
1215

@@ -86,7 +89,7 @@ var people = cmd.Results<Person>(new Dictionary<string,string>{
8689
{"LastName", "last_name"});
8790
```
8891

89-
#### `Retrieve()` and `RetrieveAsync()`
92+
### `Retrieve()` and `RetrieveAsync()`
9093

9194
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.
9295

docs/README.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@
6262
<article class="content wrap" id="_content" data-uid="">
6363
<h1 id="opendatabaseextensions">Open.Database.Extensions</h1>
6464

65-
<p><a href="https://electricessence.github.io/Open.Database.Extensions/api/index.html">Full API Documentation</a></p>
65+
<p><a href="https://open-net-libraries.github.io/Open.Database.Extensions/api/index.html">Full API Documentation</a></p>
6666
<p>Useful set of utilities and abstractions for simplifying modern database operations and ensuring dependency injection compatibility.</p>
6767
<h2 id="connection-factories">Connection Factories</h2>
6868
<p>Connection factories facilitate creation and disposal of connections without the concern of a connection reference or need for awareness of a connection string.</p>
@@ -147,7 +147,7 @@ <h2 id="transactions">Transactions</h2>
147147
<div class="contribution">
148148
<ul class="nav">
149149
<li>
150-
<a href="https://github.com/electricessence/Open.Database.Extensions/blob/development/Core/README.md/#L1" class="contribution-link">Improve this Doc</a>
150+
<a href="https://github.com/Open-NET-Libraries/Open.Database.Extensions/blob/development/Core/README.md/#L1" class="contribution-link">Improve this Doc</a>
151151
</li>
152152
</ul>
153153
</div>

0 commit comments

Comments
 (0)