diff --git a/README.md b/README.md index 55c77f77..f9da79db 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Open.Database.Extensions (ODX) -![Open.Database.Extensions: You write the SQL. The library writes the other twenty lines.](https://raw.githubusercontent.com/Open-NET-Libraries/Open.Database.Extensions/master/docsite/images/hero-core.svg) +![Open.Database.Extensions: You write the SQL. ODX writes the other twenty lines.](https://raw.githubusercontent.com/Open-NET-Libraries/Open.Database.Extensions/master/docsite/images/hero-core.svg) [![NuGet](https://img.shields.io/nuget/vpre/Open.Database.Extensions.Core.svg?style=flat)](https://www.nuget.org/packages/Open.Database.Extensions.Core/) [![Docs](https://github.com/Open-NET-Libraries/Open.Database.Extensions/actions/workflows/docs.yml/badge.svg)](https://github.com/Open-NET-Libraries/Open.Database.Extensions/actions/workflows/docs.yml) diff --git a/Source/Channel/README.md b/Source/Channel/README.md index cf6c027a..7b4184a6 100644 --- a/Source/Channel/README.md +++ b/Source/Channel/README.md @@ -1,6 +1,6 @@ # Open.Database.Extensions.Channel -![Open.Database.Extensions.Channel: You write the SQL. The library writes the other twenty lines.](https://raw.githubusercontent.com/Open-NET-Libraries/Open.Database.Extensions/master/docsite/images/hero-channel.svg) +![Open.Database.Extensions.Channel: You write the SQL. ODX writes the other twenty lines.](https://raw.githubusercontent.com/Open-NET-Libraries/Open.Database.Extensions/master/docsite/images/hero-channel.svg) Read query results straight into a `System.Threading.Channels` channel instead of a collection. `ToChannel()` returns a `ChannelReader` immediately; rows are produced in the background, and the channel completes when every row has been written (or completes with the exception if reading fails). **Use it when** another task consumes the rows while they are still being read. It includes [Open.Database.Extensions.Core](https://www.nuget.org/packages/Open.Database.Extensions.Core/), and rows are mapped the same way as `Map()`. diff --git a/Source/Core/README.md b/Source/Core/README.md index 34eb1f4e..db1e8a13 100644 --- a/Source/Core/README.md +++ b/Source/Core/README.md @@ -1,6 +1,6 @@ # Open.Database.Extensions.Core -![Open.Database.Extensions.Core: You write the SQL. The library writes the other twenty lines.](https://raw.githubusercontent.com/Open-NET-Libraries/Open.Database.Extensions/master/docsite/images/hero-core.svg) +![Open.Database.Extensions.Core: You write the SQL. ODX writes the other twenty lines.](https://raw.githubusercontent.com/Open-NET-Libraries/Open.Database.Extensions/master/docsite/images/hero-core.svg) Core is the foundation of Open.Database.Extensions: ADO.NET extension methods with best-practice defaults, expressive commands that open, run and dispose their own connection, and `Map()` to turn rows into objects. It has no database dependency of its own. **Use it for any ADO.NET database;** most applications need only this package. diff --git a/Source/Dataflow/README.md b/Source/Dataflow/README.md index 506dc803..929647c1 100644 --- a/Source/Dataflow/README.md +++ b/Source/Dataflow/README.md @@ -1,6 +1,6 @@ # Open.Database.Extensions.Dataflow -![Open.Database.Extensions.Dataflow: You write the SQL. The library writes the other twenty lines.](https://raw.githubusercontent.com/Open-NET-Libraries/Open.Database.Extensions/master/docsite/images/hero-dataflow.svg) +![Open.Database.Extensions.Dataflow: You write the SQL. ODX writes the other twenty lines.](https://raw.githubusercontent.com/Open-NET-Libraries/Open.Database.Extensions/master/docsite/images/hero-dataflow.svg) Read query results straight into a TPL Dataflow pipeline. `ToTargetBlock()` posts each row to a block, and `AsSourceBlock()` exposes the results as a source block. **Use it when** your processing is already built from dataflow blocks. It includes [Open.Database.Extensions.Core](https://www.nuget.org/packages/Open.Database.Extensions.Core/), and rows are mapped the same way as `Map()`. diff --git a/Source/MSSqlClient/README.md b/Source/MSSqlClient/README.md index a4934cd8..dba86ba6 100644 --- a/Source/MSSqlClient/README.md +++ b/Source/MSSqlClient/README.md @@ -1,6 +1,6 @@ # Open.Database.Extensions.MSSqlClient -![Open.Database.Extensions.MSSqlClient: You write the SQL. The library writes the other twenty lines.](https://raw.githubusercontent.com/Open-NET-Libraries/Open.Database.Extensions/master/docsite/images/hero-mssqlclient.svg) +![Open.Database.Extensions.MSSqlClient: You write the SQL. ODX writes the other twenty lines.](https://raw.githubusercontent.com/Open-NET-Libraries/Open.Database.Extensions/master/docsite/images/hero-mssqlclient.svg) SQL Server for Open.Database.Extensions: `SqlConnectionFactory`, SQL-specific commands, and stored procedures on `Microsoft.Data.SqlClient`. **Use it when** your database is SQL Server. It includes [Open.Database.Extensions.Core](https://www.nuget.org/packages/Open.Database.Extensions.Core/) and the `Microsoft.Data.SqlClient` provider, so there is nothing else to install. diff --git a/Source/SqlClient/README.md b/Source/SqlClient/README.md index cf31fdb6..d566d1fe 100644 --- a/Source/SqlClient/README.md +++ b/Source/SqlClient/README.md @@ -1,6 +1,6 @@ # Open.Database.Extensions.SqlClient -![Open.Database.Extensions.SqlClient: You write the SQL. The library writes the other twenty lines.](https://raw.githubusercontent.com/Open-NET-Libraries/Open.Database.Extensions/master/docsite/images/hero-sqlclient.svg) +![Open.Database.Extensions.SqlClient: You write the SQL. ODX writes the other twenty lines.](https://raw.githubusercontent.com/Open-NET-Libraries/Open.Database.Extensions/master/docsite/images/hero-sqlclient.svg) **This package is deprecated in favor of [Open.Database.Extensions.MSSqlClient](https://www.nuget.org/packages/Open.Database.Extensions.MSSqlClient/)**, which uses the actively maintained `Microsoft.Data.SqlClient` and has the same API. Use this package only if your project still needs the older `System.Data.SqlClient`; otherwise install MSSqlClient. It includes [Open.Database.Extensions.Core](https://www.nuget.org/packages/Open.Database.Extensions.Core/). diff --git a/docsite/articles/channels-and-dataflow.md b/docsite/articles/channels-and-dataflow.md index 5e922865..9ba65ac2 100644 --- a/docsite/articles/channels-and-dataflow.md +++ b/docsite/articles/channels-and-dataflow.md @@ -11,7 +11,7 @@ They work on expressive commands, on `IDbCommand` and on readers, and map rows t ## Channels -![Open.Database.Extensions.Channel: You write the SQL. The library writes the other twenty lines.](../images/hero-channel.svg) +![Open.Database.Extensions.Channel: You write the SQL. ODX writes the other twenty lines.](../images/hero-channel.svg) `ToChannel` returns a `ChannelReader` immediately. The channel is completed when every row has been written, or completed with the exception if reading fails: @@ -21,7 +21,7 @@ The overloads that take a `ChannelWriter` as the target return the number of row ## Dataflow -![Open.Database.Extensions.Dataflow: You write the SQL. The library writes the other twenty lines.](../images/hero-dataflow.svg) +![Open.Database.Extensions.Dataflow: You write the SQL. ODX writes the other twenty lines.](../images/hero-dataflow.svg) `ToTargetBlock` posts each row to a block. The `complete` argument controls the target: with `true`, the block is completed after every row has been delivered and the reader has been released, or faulted with the exception if reading or mapping failed. With `false`, the block is left open and is never completed or faulted by the call. The number `ToTargetBlock` returns counts the rows read and handed to the internal buffer; delivery to the target can still be in progress. diff --git a/docsite/articles/getting-started.md b/docsite/articles/getting-started.md index 334c4d81..511472fc 100644 --- a/docsite/articles/getting-started.md +++ b/docsite/articles/getting-started.md @@ -91,7 +91,7 @@ What is different: ## With SQL Server -![Open.Database.Extensions.MSSqlClient: You write the SQL. The library writes the other twenty lines.](../images/hero-mssqlclient.svg) +![Open.Database.Extensions.MSSqlClient: You write the SQL. ODX writes the other twenty lines.](../images/hero-mssqlclient.svg) `Open.Database.Extensions.MSSqlClient` provides `SqlConnectionFactory`. Everything above works the same way, and stored procedures are one call away: diff --git a/docsite/images/hero-channel.svg b/docsite/images/hero-channel.svg index 7f128867..96df531f 100644 --- a/docsite/images/hero-channel.svg +++ b/docsite/images/hero-channel.svg @@ -1,6 +1,6 @@ ODX Channel - You write the SQL. The library writes the other twenty lines. Rows drift through a glass pipe into an open channel, where they queue for the reader. + You write the SQL. ODX writes the other twenty lines. Rows drift through a glass pipe into an open channel, where they queue for the reader. \ No newline at end of file diff --git a/docsite/images/hero-core.svg b/docsite/images/hero-core.svg index 823fe50e..988e5bbd 100644 --- a/docsite/images/hero-core.svg +++ b/docsite/images/hero-core.svg @@ -1,6 +1,6 @@ ODX Core - You write the SQL. The library writes the other twenty lines. Four stacked layers, Performance at the base, then Foundation, Expressive commands and Mapping on top, beside the fluent line db.Command(sql).AddParam("author", 42).Map of Post. + You write the SQL. ODX writes the other twenty lines. Four stacked layers, Performance at the base, then Foundation, Expressive commands and Mapping on top, beside the fluent line db.Command(sql).AddParam("author", 42).Map of Post. \ No newline at end of file diff --git a/docsite/images/hero-dataflow.svg b/docsite/images/hero-dataflow.svg index e3cc98d2..57603418 100644 --- a/docsite/images/hero-dataflow.svg +++ b/docsite/images/hero-dataflow.svg @@ -1,6 +1,6 @@ ODX Dataflow - You write the SQL. The library writes the other twenty lines. Rows travel from a database into a glass dataflow block, which passes them on to two more blocks. + You write the SQL. ODX writes the other twenty lines. Rows travel from a database into a glass dataflow block, which passes them on to two more blocks. \ No newline at end of file diff --git a/docsite/images/hero-mssqlclient.svg b/docsite/images/hero-mssqlclient.svg index ac4662cd..d7ad19b8 100644 --- a/docsite/images/hero-mssqlclient.svg +++ b/docsite/images/hero-mssqlclient.svg @@ -1,6 +1,6 @@ ODX MSSqlClient - You write the SQL. The library writes the other twenty lines. A stored procedure beside a database; each parameter finds the socket that matches its shape. + You write the SQL. ODX writes the other twenty lines. A stored procedure beside a database; each parameter finds the socket that matches its shape. \ No newline at end of file diff --git a/docsite/images/hero-sqlclient.svg b/docsite/images/hero-sqlclient.svg index b0f10810..14cd258c 100644 --- a/docsite/images/hero-sqlclient.svg +++ b/docsite/images/hero-sqlclient.svg @@ -1,6 +1,6 @@ ODX SqlClient - You write the SQL. The library writes the other twenty lines. Deprecated: a faded database points toward the brighter MSSqlClient database, which replaces it. + You write the SQL. ODX writes the other twenty lines. Deprecated: a faded database points toward the brighter MSSqlClient database, which replaces it. \ No newline at end of file diff --git a/docsite/index.md b/docsite/index.md index 2a8d961e..630bc29b 100644 --- a/docsite/index.md +++ b/docsite/index.md @@ -2,7 +2,7 @@ title: Open.Database.Extensions (ODX) --- -![Open.Database.Extensions: You write the SQL. The library writes the other twenty lines.](images/hero-core.svg) +![Open.Database.Extensions: You write the SQL. ODX writes the other twenty lines.](images/hero-core.svg) Extensions on the standard ADO.NET types that make everyday database work short to write and robust by default. Version 11 is a release candidate.