CardboardBox.Database
2.0.7
dotnet add package CardboardBox.Database --version 2.0.7
NuGet\Install-Package CardboardBox.Database -Version 2.0.7
<PackageReference Include="CardboardBox.Database" Version="2.0.7" />
paket add CardboardBox.Database --version 2.0.7
#r "nuget: CardboardBox.Database, 2.0.7"
// Install CardboardBox.Database as a Cake Addin #addin nuget:?package=CardboardBox.Database&version=2.0.7 // Install CardboardBox.Database as a Cake Tool #tool nuget:?package=CardboardBox.Database&version=2.0.7
CardboardBox.Database
A wrapper around Dapper and various ADO.Net providers to connect to different SQL Engines with built in basic query generation.
Installation
You will probably want to install one of the ADO.net provider specific packages:
Install Postgres via Nuget:
PM> Install-Package CardboardBox.Database.Postgres
Install SQLite via Nuget:
PM> Install-Package CardboardBox.Database.SQLite
Install MSSQL / SQL Server via Nuget: (Coming soon)
PM> Install-Package CardboardBox.Database.MSSQL
Setup
This package is designed to work with Microsoft.Extensions.DependencyInjection
:
using CardboardBox.Database;
using Microsoft.Extensions.DependencyInjection;
var services = new ServiceCollection();
services.AddSqlService(c =>
{
//Configure the SQL engines you want to use
c.AddPostgres("<connection string>");
c.AddSqlite("<connection string>");
});
Querying
To use the database engine, you can inject the ISqlService
interface into any of your services:
public class SomeService
{
private readonly ISqlService _sql;
public SomeService(ISqlService sql) { _sql = sql; }
public Task<User> Fetch(long id) => _sql.Fetch<User>("SELECT * FROM users WHERE id = @id", new { id });
public Task<User[]> Get() => _sql.Get<User>("SELECT * FROM users");
public async Task DoSomethingComplex()
{
using var con = await _sql.CreateConnection();
//Do something with the active connection
}
}
Query Generation
Query Generation is centered around the IQueryService
that generates queries based on your POCOs.
Said generation uses property names, Dapper Fluent, and optional attributes to generate SQL queries.
Basic Usage - Attributes
There are 2 primary attributes within the generation scheme: TableAttribute
and ColumnAttribute
.
You can use them like so:
[Table("Users")]
public class User
{
[Column(PrimaryKey = true, ExcludeInserts = true, ExcludeUpdates = true)]
public int Id { get; set; }
[Column(Unique = true)]
public string UserName { get; set; } = string.Empty;
public string FirstName { get; set; } = string.Empty;
public string LastName { get; set; } = string.Empty;
}
This will create the following queries when used against the IQueryService
:
--IQueryService.Select<User>(t => t.With(a => a.FirstName));
SELECT * FROM [Users] WHERE [FirstName] = @FirstName;
--IQueryService.Fetch<User>();
SELECT * FROM [Users] WHERE [Id] = @Id;
--IQueryService.Insert<User>();
INSERT INTO [Users] ([UserName], [FirstName], [LastName]) VALUES (@UserName, @FirstName, @LastName);
Basic Usage - Changing Column Case Convention
You can also change the case convention during configuration and it will automatically change the case of the column names:
services.AddSqlService(c =>
{
//Configure the SQL engines you want to use
c.AddPostgres("<connection string>")
//This tells the query generation system to use camel_case names
.ConfigureGeneration(c => c.WithCamelCaseChange())
//This tells Dapper Fluent to use camel_case for resolving property names for the `User` class
.ConfigureTypes(c =>
c.CamelCase()
.Entity<User>());
});
This will create the following queries when used against the IQueryService
:
--IQueryService.Select<User>(t => t.With(a => a.FirstName));
SELECT * FROM "users" WHERE "first_name" = :FirstName;
--IQueryService.Fetch<User>();
SELECT * FROM "users" WHERE "id" = :Id;
--IQueryService.Insert<User>();
INSERT INTO "users" ("user_name", "first_name", "last_name") VALUES (:UserName, :FirstName, :LastName);
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
.NET Core | netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.1 is compatible. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.1
- Dapper (>= 2.1.35)
- Dapper.FluentMap (>= 2.0.0)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 9.0.0)
- System.Text.Json (>= 9.0.0)
NuGet packages (2)
Showing the top 2 NuGet packages that depend on CardboardBox.Database:
Package | Downloads |
---|---|
CardboardBox.Database.Postgres
A wrapper around Dapper and Npgsql that provides easy of use when using Postgres Also contains a few useful extensions to Dapper to increase productivity and enable SQL query generation. Works as a progressive replacement to EF. |
|
CardboardBox.Database.Sqlite
A wrapper around Dapper and Sqlite that provides easy of use when using Sqlite Also contains a few useful extensions to Dapper to increase productivity and enable SQL query generation. Works as a progressive replacement to EF. |
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
2.0.7 | 156 | 12/9/2024 |
2.0.6 | 92 | 5/3/2024 |
2.0.5 | 486 | 10/9/2023 |
2.0.4 | 379 | 7/13/2023 |
2.0.3 | 191 | 6/2/2023 |
2.0.2 | 288 | 3/25/2023 |
2.0.1 | 276 | 3/24/2023 |
2.0.0 | 397 | 3/24/2023 |
1.0.6 | 1,384 | 10/20/2022 |
1.0.5 | 421 | 10/14/2022 |
1.0.4 | 830 | 1/15/2022 |
1.0.3 | 460 | 1/15/2022 |
1.0.2 | 453 | 1/15/2022 |
1.0.1 | 285 | 1/15/2022 |
1.0.0 | 281 | 1/15/2022 |
Version 2.0 contains breaking changes compared to 1.0.
* CreateConnection is now asynchronous to allow for tasks to be run on first load of the connection.