https://github.com/adamfoneil/dapper.cx
A Crud library based on Dapper
https://github.com/adamfoneil/dapper.cx
crud-generator crud-operation crud-operations dapper dapper-extensions
Last synced: 12 months ago
JSON representation
A Crud library based on Dapper
- Host: GitHub
- URL: https://github.com/adamfoneil/dapper.cx
- Owner: adamfoneil
- License: mit
- Created: 2019-11-16T18:16:48.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-01-24T00:55:29.000Z (over 2 years ago)
- Last Synced: 2024-11-14T19:52:04.623Z (over 1 year ago)
- Topics: crud-generator, crud-operation, crud-operations, dapper, dapper-extensions
- Language: C#
- Homepage:
- Size: 1.17 MB
- Stars: 8
- Watchers: 1
- Forks: 1
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://ci.appveyor.com/project/adamosoftware/dapper-cx)
[](https://www.nuget.org/packages/Dapper.CX.SqlServer/)
[](https://www.nuget.org/packages/Dapper.CX.SqlServer.AspNetCore/)
**Note:** I'm no longer updating this. Please see [Dapper.Repository](https://github.com/adamfoneil/Dapper.Repository).
Dapper.CX is a CRUD library for SQL Server made with Dapper. It works with POCO classes, where the only model class requirement is that they have a property called `Id` or an [Identity](https://github.com/adamosoftware/DbSchema.Attributes/blob/master/DbSchema.Attributes/Attributes/IdentityAttribute.cs) attribute on the class that indicates what its identity property is. `int` and `long` identity types are supported. You can use Dapper.CX in two ways:
- as an injected service, [learn more](https://github.com/adamfoneil/Dapper.CX/wiki/Using-Dapper.CX-with-Dependency-Injection). This is intended for .NET Core apps to use dependency injection along with user profile integration.
- as `IDbConnection` extension methods, [learn more](https://github.com/adamfoneil/Dapper.CX/wiki/Using-Dapper.CX-Extension-Methods). This is simpler to use than the service, but is not as elegant from a dependency standpoint.
Wiki links: [Why Dapper.CX?](https://github.com/adamosoftware/Dapper.CX/wiki), [Reference](https://github.com/adamosoftware/Dapper.CX/wiki/Crud-method-reference). Note that Dapper.CX doesn't create tables. Please see my [ModelSync](https://github.com/adamosoftware/ModelSync) project for info on that.
Please see my [BlazorAO](https://github.com/adamfoneil/BlazorAO) project to see Dapper.CX in action. If you're not familiar with Dapper, I have a [PowerPoint](https://1drv.ms/v/s!AvguHRnyJtWMmugqfwkiWSa0ZWlqUg?e=8rSid8) **Why I Use Dapper for .NET Data Access** that's an intro and also shows where Dapper.CX builds upon it.
## In a Nutshell
When using the injected service, you'd write CRUD code that looks like this. This example assumes a fictional `Employee` model class. There are several advantages of using the injected service. One, it integrates nicely with the authenticated user to check permissions or perform audit and change tracking. Two, you can omit the `using` block that you otherwise need when interacting with a connection. Three, there are some handy overloads that bundle exception handling and more. Here's [how to implement the injected service](https://github.com/adamfoneil/Dapper.CX/wiki/Using-Dapper.CX-with-Dependency-Injection) along with a CRUD [method reference](https://github.com/adamfoneil/Dapper.CX/wiki/SqlCrudService-reference).
```csharp
public EmployeesModel(DapperCX data)
{
Data = data;
}
public DapperCX Data { get; }
public Employee ViewRecord { get; set; }
public async Task OnGetAsync(int id)
{
ViewRecord = await Data.GetAsync(id);
}
public async Task OnPostSaveAsync(Employee employee)
{
await Data.SaveAsync(employee);
return Redirect("/Employees");
}
public async Task OnPostDeleteAsync(int id)
{
await Data.DeleteAsync(id);
return Redirect("/Employees");
}
```
When using the extension methods, it's almost the same thing, but you must open a database connection first. This example assumes a fictional `GetConnection` method that opens a SQL Server connection.
```csharp
public Employee ViewRecord { get; set; }
public async Task OnGetAsync(int id)
{
using (var cn = GetConnection())
{
ViewRecord = await cn.GetAsync(id);
}
}
public async Task OnPostSaveAsync(Employee employee)
{
using (var cn = GetConnection())
{
await cn.SaveAsync(employee);
return Redirect("/Employees");
}
}
public async Task OnPostDeleteAsync(int id)
{
using (var cn = GetConnection())
{
await cn.DeleteAsync(id);
return Redirect("/Employees");
}
}
```
## Customizing behaviors with interfaces
There's a lot of functionality you can opt into by implementing interfaces on your model classes from the [AO.Models](https://github.com/adamfoneil/Models) project. See [Extending Dapper.CX with Interfaces](https://github.com/adamfoneil/Dapper.CX/wiki/Extending-Dapper.CX-with-Opt-in-Interfaces). Available interfaces are [here](https://github.com/adamfoneil/Models/tree/master/Models/Interfaces).
## And one other thing...
In addition to the more common strong-typed CRUD operations, Dapper.CX also offers a [SqlCmdDictionary](https://github.com/adamosoftware/Dapper.CX/wiki/Using-SqlCmdDictionary) feature that gives you a clean way to build INSERT and UPDATE statements dynamically.
## One other thing...
If you need a `Dictionary`-like object to persist in a database, you can implement the abstract class [DbDictionary](https://github.com/adamfoneil/Dapper.CX/blob/master/Dapper.CX.Base/Abstract/DbDictionary.cs). Use this to store any object with a key, using these [supported key types](https://github.com/adamfoneil/Dapper.CX/blob/master/Dapper.CX.Base/Abstract/DbDictionary.cs#L29-L35). This can save you the effort of adding a single-use dedicated model class for a more generic storage need. Note that, unlike a `Dictinoary`, you can use different `TValue`s with different keys, so this is very flexible and still type-safe. The abstract methods [Serialize](https://github.com/adamfoneil/Dapper.CX/blob/master/Dapper.CX.Base/Abstract/DbDictionary.cs#L65) and [Deserialize](https://github.com/adamfoneil/Dapper.CX/blob/master/Dapper.CX.Base/Abstract/DbDictionary.cs#L63) let you provide your Json serialization. See the [integration test](https://github.com/adamfoneil/Dapper.CX/blob/master/Tests.Base/SqlIntegration.cs#L116) to see in action, along with the [sample implementation](https://github.com/adamfoneil/Dapper.CX/blob/master/Tests.Base/SampleDbDictionary.cs).
---
Please see also [Dapper.QX](https://github.com/adamosoftware/Dapper.QX), Dapper.CX's companion library.