Documentation on Dotnet Data

Architecture

Mon, 01 Jan 0001 00:00:00 +0000

ArturRios.Data is a family of small, focused NuGet packages. This page shows how they fit together, the key types in each, and the design principles they share.

Package dependencies

flowchart TB
 Output["ArturRios.Output<br/><i>DataOutput / ProcessOutput envelopes</i>"]

 subgraph Relational["Relational stack — EF Core"]
 direction TB
 Core["ArturRios.Data.Relational.Core<br/><i>interfaces, EfRepository, EfUnitOfWork,<br/>BaseDbContext, IDatabaseProvider seam</i>"]
 Sqlite["ArturRios.Data.Sqlite<br/><i>AddSqliteProvider()</i>"]
 Postgres["ArturRios.Data.PostgreSql<br/><i>AddPostgreSqlProvider()</i>"]
 MySql["ArturRios.Data.MySql"]
 Dapper["ArturRios.Data.Dapper<br/><i>read-only raw SQL</i>"]
 end

 subgraph NoSQL["NoSQL stores — standalone"]
 direction TB
 Mongo["ArturRios.Data.MongoDb<br/><i>document repository + transactions</i>"]
 Dynamo["ArturRios.Data.DynamoDb<br/><i>async repository over IDynamoDBContext</i>"]
 end

 subgraph Export["File export — standalone"]
 direction TB
 ExportCore["ArturRios.Data.Export<br/><i>exporter factory, column map,<br/>CSV / JSON / TXT / MessagePack</i>"]
 ExportExcel["ArturRios.Data.Export.Excel<br/><i>.xlsx add-on</i>"]
 end

 Sqlite --> Core
 Postgres --> Core
 MySql --> Core
 Dapper --> Core
 Core --> Output
 Mongo --> Output
 Dynamo --> Output
 ExportExcel --> ExportCore
 ExportCore --> Output

 EF["Microsoft.EntityFrameworkCore"]:::ext
 EfProviders["Npgsql / Microting (Pomelo fork) / Sqlite EF provider"]:::ext
 DapperLib["Dapper"]:::ext
 MongoLib["MongoDB.Driver"]:::ext
 Aws["AWSSDK.DynamoDBv2"]:::ext
 MsgPack["MessagePack"]:::ext
 ClosedXml["ClosedXML"]:::ext
 Core --> EF
 Sqlite --> EfProviders
 Postgres --> EfProviders
 MySql --> EfProviders
 Dapper --> DapperLib
 Mongo --> MongoLib
 Dynamo --> Aws
 ExportCore --> MsgPack
 ExportExcel --> ClosedXml

 classDef ext fill:#8882,stroke-dasharray:3 3;

The families are deliberately separate. The relational providers and the Dapper read path build on ArturRios.Data.Relational.Core (EF Core). The NoSQL packages do not depend on the relational core — pulling EF Core into a MongoDB or DynamoDB app would be wasteful — so they depend only on ArturRios.Output and their native driver. MongoDB and DynamoDB are also separate from each other: their data models diverge too much (composite keys and a key/scan access model in DynamoDB vs. documents with LINQ/predicate queries in MongoDB) to share one interface without becoming leaky. The export packages are independent of all of it — they take any IEnumerable<T>, so they need no store at all.

Relational

Mon, 01 Jan 0001 00:00:00 +0000

The relational stack is a provider-agnostic data-access layer over Entity Framework Core. You install the core plus a provider for your engine; the core gives you enveloped repositories, a unit of work, optimistic concurrency, and DI wiring, while the provider teaches it how to talk to PostgreSQL, SQLite, or MySQL.

Install

dotnet add package ArturRios.Data.Relational.Core
dotnet add package ArturRios.Data.Sqlite # or ArturRios.Data.PostgreSql / ArturRios.Data.MySql

Provider package	`DatabaseType`	Status
`ArturRios.Data.Sqlite`	`SqLite`	Available
`ArturRios.Data.PostgreSql`	`PostgreSql`	Available
`ArturRios.Data.MySql`	`MySql`	Available — see MySQL and MariaDB

1. Define entities

Derive from Entity (an int Id mapped as the first column), or VersionedEntity to opt into optimistic concurrency (adds a Guid ConcurrencyStamp).

MongoDB

Mon, 01 Jan 0001 00:00:00 +0000

ArturRios.Data.MongoDb is a standalone document-repository package over MongoDB.Driver — it does not depend on the relational core, so it pulls in no EF Core. It keeps the same enveloped style: every method returns a DataOutput / ProcessOutput.

Install

dotnet add package ArturRios.Data.MongoDb

1. Define a document

Derive from Document (a string Id mapped to Mongo’s _id as an ObjectId), or VersionedDocument to opt into optimistic concurrency (adds a long Version).

DynamoDB

Mon, 01 Jan 0001 00:00:00 +0000

ArturRios.Data.DynamoDb is a standalone, async-only repository over the AWS SDK’s high-level object-persistence model (IDynamoDBContext). It does not depend on the relational core. Every method returns a DataOutput / ProcessOutput envelope.

Install

dotnet add package ArturRios.Data.DynamoDb

1. Define an item

There’s no base class — annotate a POCO with the AWS attributes. Keys are a partition (hash) key plus an optional sort (range) key; add [DynamoDBVersion] to opt into optimistic concurrency.

Export

Mon, 01 Jan 0001 00:00:00 +0000

ArturRios.Data.Export turns any IEnumerable<T> into CSV, JSON, TXT, or MessagePack, over a stream or straight to a file. ArturRios.Data.Export.Excel adds .xlsx as a separate add-on.

Both are standalone — they work with plain POCOs and depend on neither the relational core nor a database driver. They keep the same enveloped style as the rest of the family: every write returns a ProcessOutput, so a locked file or a serialization failure comes back as an error on the result rather than an unhandled exception.