Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/simplesoft-pt/database
Library with helper interfaces and classes for database access.
https://github.com/simplesoft-pt/database
Last synced: 26 days ago
JSON representation
Library with helper interfaces and classes for database access.
- Host: GitHub
- URL: https://github.com/simplesoft-pt/database
- Owner: simplesoft-pt
- License: mit
- Created: 2021-02-26T12:38:44.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-09-29T13:22:32.000Z (over 1 year ago)
- Last Synced: 2024-12-02T03:48:29.359Z (about 2 months ago)
- Language: C#
- Size: 108 KB
- Stars: 4
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Database
Small .NET library that helps to decouple database and business layers by exposing a wide range of interfaces that can be implemented using your favorite ORM, micro-ORM, ADO.NET or even all since everything is plugable and implementation can be swapped per entity.
## Installation
The library is available via [NuGet](https://www.nuget.org/packages?q=simplesoft.database) packages:
| NuGet | Description | Version |
| --- | --- | --- |
| [SimpleSoft.Database.Contracts](https://www.nuget.org/packages/simplesoft.database.contracts) | database contracts (IReadById, ICreate, IDelete, ...) | [](https://www.nuget.org/packages/simplesoft.database.contracts) |
| [SimpleSoft.Database.EFCore](https://www.nuget.org/packages/simplesoft.database.efcore) | Entity Framework Core implementation | [](https://www.nuget.org/packages/simplesoft.database.efcore) |
| [SimpleSoft.Database.NH](https://www.nuget.org/packages/simplesoft.database.nh) | NHibernate implementation | [](https://www.nuget.org/packages/simplesoft.database.nh) |
## Compatibility
This library is compatible with the following frameworks:
* `SimpleSoft.Database.Contracts`
* .NET Framework 4.0+;
* .NET Standard 1.0+;
* `SimpleSoft.Database.EFCore`
* .NET Standard 1.3+;
* `SimpleSoft.Database.NH`
* .NET Framework 4.6.1+;
* .NET Standard 2.0+;
* .NET Core App 2.0+;
## Usage
Here is a simple example how to setup and use within an ASP.NET Core application:
```csharp
public class Startup
{
public void ConfigureServices(IServiceCollection services)
{
services
.AddDbContext(o => o.UseInMemoryDatabase("ExampleDatabase"))
.AddDbContextOperations(); // this line here
services.AddMvc();
}
// ...
}
public class ExampleContext : DbContext
{
public ExampleContext(DbContextOptions options) : base(options) { }
protected override void OnModelCreating(ModelBuilder builder)
{
builder.Entity(cfg =>
{
cfg.MapPrimaryKey();
cfg.MapExternalId();
cfg.HasIndex(e => e.Code).IsUnique();
cfg.Property(e => e.Code)
.IsRequired()
.HasMaxLength(8);
cfg.Property(e => e.Name)
.IsRequired()
.HasMaxLength(256);
cfg.Property(e => e.Price)
.IsRequired();
});
}
}
[Route("products")]
public class ProductsController : Controller
{
// either inject by constructor
//private readonly IQueryable _productQuery;
//private readonly IReadByExternalId _productByExternalId;
//private readonly ICreate _productCreate;
//public ProductsController(
// IQueryable productQuery,
// IReadByExternalId productByExternalId,
// ICreate productCreate
//)
//{
// _productQuery = productQuery;
// _productByExternalId = productByExternalId;
// _productCreate = productCreate;
//}
// or inject directly into each method
[HttpGet("")]
public async Task> GetAll(
[FromServices] IQueryable productQuery,
CancellationToken ct
)
{
return await productQuery.Select(p => new ProductModel
{
Id = p.ExternalId,
Code = p.Code,
Name = p.Name,
Price = p.Price
}).ToListAsync(ct);
}
[HttpGet("{id:guid}")]
public async Task GetById(
[FromServices] IReadByExternalId productByExternalId,
[FromRoute] Guid id,
CancellationToken ct
)
{
var product = await productByExternalId.ReadAsync(id, ct);
if (product == null)
{
return NotFound(new ErrorModel
{
Message = $"Product {id} not found"
});
}
return Ok(new ProductModel
{
Id = product.ExternalId,
Code = product.Code,
Name = product.Name,
Price = product.Price
});
}
[HttpPost]
public async Task Create(
[FromServices] IQueryable productQuery,
[FromServices] ICreate productCreate,
[FromBody] CreateProductModel model,
CancellationToken ct
)
{
if (await productQuery.AnyAsync(p => p.Code == model.Code, ct))
{
return Conflict(new ErrorModel
{
Message = "Duplicated product code"
});
}
var product = await productCreate.CreateAsync(new ProductEntity
{
ExternalId = Guid.NewGuid(),
Code = model.Code,
Name = model.Name,
Price = model.Price
}, ct);
return CreatedAtAction(nameof(GetById), new {id = product.ExternalId}, new ProductModel
{
Id = product.ExternalId,
Code = product.Code,
Name = product.Name,
Price = product.Price
});
}
}
```