IceCoffee.Db4Net.Core 1.2.3

IceCoffee.Db4Net

Package	NuGet Stable	Downloads
IceCoffee.Db4Net
IceCoffee.Db4Net.DependencyInjection

Description

A simple and performant SQL builder and runner for Dapper, using a fluent API and string interpolation to build safe and dynamic SQL queries.

Quick Start

Below are a few common ways to configure and use IceCoffee.Db4Net. For more detailed examples, see the project documentation.

1) Quick (static facade)

using IceCoffee.Db4Net;
using IceCoffee.Db4Net.Core;

// register default database (convenience API)
Db.Register(DatabaseProvider.SQLite, "Data Source=sample.db");

// configure global options (parameter name prefix, reuse flags, etc.)
Db.Configure(new Db4NetSettings { ParameterNamePrefix = "p_", ReuseParameters = true });

// use static facade builders
var foo = Db.Query<Foo>(1).GetSingleOrDefault();

2) Recommended (Dependency Injection)

// Program.cs / Startup.cs
builder.Services.AddDbConnection<MyRepository>(options =>
{
	options.DatabaseProvider = DatabaseProvider.SQLite;
	options.ConnectionString = configuration.GetConnectionString("Default");
});

// later: inject `MyRepository` where needed

3) Tests or isolated scenarios (local registry)

// create an isolated registry (useful for tests)
var registry = Db.CreateDatabaseRegistry();
registry.Configure(Db.Registry.Settings);
registry.Register(DatabaseProvider.SQLite, "Data Source=InMemorySample;Mode=Memory;Cache=Shared");

var repo = new Repository(registry, string.Empty);

Note: The library exposes a global Db.Registry for convenience, but DI or local registries are recommended for applications and tests to avoid shared mutable state.

Execution Behavior

Db4Net owns and disposes connections that it creates internally after buffered query or command execution completes. Connections supplied through an external transaction remain owned by the caller.

Unbuffered queries (buffered: false) require an external connection or transaction so enumeration happens while the caller still controls the connection lifetime.

Paged queries can also be executed through ISqlQueryPagedBuilder and ISqlQueryPagedBuilder<TEntity> when repository code needs to depend on an abstraction instead of the concrete fluent builder type.

Share Your Feedback

If you like the library, use it, share it, and give it a ⭐️. For any suggestions, feature requests, or issues feel free to create an issue to help improve the library.

License

This project is licensed under the MIT License. See the LICENSE file for details.