mirror of https://github.com/abpframework/abp
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
67 lines
2.2 KiB
67 lines
2.2 KiB
# Dapper Integration
|
|
|
|
Dapper is a light-weight and simple database provider. The major benefit of using Dapper is writing T-SQL queries. It provides some extension methods for `IDbConnection` interface.
|
|
|
|
ABP does not encapsulate many functions for Dapper. ABP Dapper library provides a `DapperRepository<TDbContext>` base class based on ABP EntityFrameworkCore module, which provides the `IDbConnection` and `IDbTransaction` properties required by Dapper.
|
|
|
|
`IDbConnection` and `IDbTransaction` works well with the [ABP Unit-Of-Work](Unit-Of-Work.md).
|
|
|
|
## Installation
|
|
|
|
Install and configure EF Core according to [EF Core's integrated documentation](Entity-Framework-Core.md).
|
|
|
|
`Volo.Abp.Dapper` is the main nuget package for the Dapper integration.
|
|
|
|
You can find it on NuGet Gallery: https://www.nuget.org/packages/Volo.Abp.Dapper
|
|
|
|
Install it to your project (for a layered application, to your data/infrastructure layer):
|
|
|
|
```shell
|
|
Install-Package Volo.Abp.Dapper
|
|
```
|
|
|
|
Then add `AbpDapperModule` module dependency (with `DependsOn` attribute) to your [module](Module-Development-Basics.md):
|
|
|
|
````C#
|
|
using Volo.Abp.Dapper;
|
|
using Volo.Abp.Modularity;
|
|
|
|
namespace MyCompany.MyProject
|
|
{
|
|
[DependsOn(typeof(AbpDapperModule))]
|
|
public class MyModule : AbpModule
|
|
{
|
|
//...
|
|
}
|
|
}
|
|
````
|
|
|
|
## Implement Dapper Repository
|
|
|
|
The following code creates the `PersonRepository`, which requires EF Core's `DbContext` (MyAppDbContext).
|
|
You can inject `PersonDapperRepository` to your services for your database operations.
|
|
|
|
`DbConnection` and `DbTransaction` comes from the `DapperRepository` base class.
|
|
|
|
```C#
|
|
public class PersonDapperRepository : DapperRepository<MyAppDbContext>, ITransientDependency
|
|
{
|
|
public PersonDapperRepository(IDbContextProvider<MyAppDbContext> dbContextProvider)
|
|
: base(dbContextProvider)
|
|
{
|
|
}
|
|
|
|
public virtual async Task<List<string>> GetAllPersonNames()
|
|
{
|
|
return (await DbConnection.QueryAsync<string>("select Name from People", transaction: DbTransaction))
|
|
.ToList();
|
|
}
|
|
|
|
public virtual async Task<int> UpdatePersonNames(string name)
|
|
{
|
|
return await DbConnection.ExecuteAsync("update People set Name = @NewName", new { NewName = name },
|
|
DbTransaction);
|
|
}
|
|
}
|
|
```
|