Elephant.Database
1.0.0
dotnet add package Elephant.Database --version 1.0.0
NuGet\Install-Package Elephant.Database -Version 1.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Elephant.Database" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Elephant.Database" Version="1.0.0" />
<PackageReference Include="Elephant.Database" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Elephant.Database --version 1.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Elephant.Database, 1.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package Elephant.Database@1.0.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Elephant.Database&version=1.0.0
#tool nuget:?package=Elephant.Database&version=1.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
About
Contains various EF Core related database helpers.
DbSetExtensions
Clear(): Remove all entities from that DbSet.
GenericCrudRepository
virtual Task<List<TEntity>> AllAsync(CancellationToken cancellationToken);
// Example usage: await myRepository.All(1, QueryTrackingBehavior.NoTracking, CancellationToken.None, x => x.CustomersCrossOrders, x => x.CustomersCrossAddresses);
virtual Task<List<TEntity>> AllAsync(QueryTrackingBehavior queryTrackingBehavior = QueryTrackingBehavior.TrackAll, CancellationToken cancellationToken = default, params Expression<Func<TEntity, object>>[] includes);
virtual Task<TEntity?> ByIdAsync(object id, CancellationToken cancellationToken);
virtual Task<int> CountAsync(CancellationToken cancellationToken);
virtual Task<int> CountAsync(Expression<Func<TEntity, bool>> predicate, CancellationToken cancellationToken);
virtual void Delete(object id);
virtual Task<IResult<int>> DeleteAndSaveAsync(object id, CancellationToken cancellationToken);
virtual Task<bool> HasAnyAsync(CancellationToken cancellationToken);
virtual Task<bool> HasAnyAsync(Expression<Func<TEntity, bool>> predicate, CancellationToken cancellationToken);
virtual Task InsertAsync(TEntity obj, CancellationToken cancellationToken);
virtual Task InsertAsync(ICollection<TEntity> objects, CancellationToken cancellationToken);
virtual Task<IResult<int>> InsertAndSaveAsync(TEntity obj, CancellationToken cancellationToken);
virtual Task<int> SaveAsync(CancellationToken cancellationToken);
virtual void Update(TEntity obj);
virtual void Update(ICollection<TEntity> objects);
virtual Task<IResult<int>> UpdateAndSaveAsync(TEntity obj, CancellationToken cancellationToken);
virtual Task DeleteAllAndResetAutoIncrementAsync(CancellationToken cancellationToken = default, string schema = "dbo");
// Transactions:
virtual Task<IDbContextTransaction> BeginTransactionAsync(CancellationToken cancellationToken);
virtual Task CommitTransactionAsyncAndDisposeAsync(IDbContextTransaction? transaction, CancellationToken cancellationToken);
virtual Task RollbackTransactionAsyncAndDisposeAsync(IDbContextTransaction? transaction, CancellationToken cancellationToken);
Example IContext transaction implementation
// Inside your DbContext or IdentityDbContext class:
/// <inheritdoc/>
public async Task<IDbContextTransaction> BeginTransactionAsync(CancellationToken cancellationToken)
{
return await Database.BeginTransactionAsync(cancellationToken);
}
/// <inheritdoc/>
public async Task CommitTransactionAndDisposeAsync(IDbContextTransaction? transaction, CancellationToken cancellationToken)
{
if (transaction == null)
return;
await Database.CommitTransactionAsync(cancellationToken);
await transaction.DisposeAsync();
}
/// <inheritdoc/>
public async Task RollbackTransactionAndDisposeAsync(IDbContextTransaction? transaction, CancellationToken cancellationToken)
{
if (transaction == null)
return;
await Database.RollbackTransactionAsync(cancellationToken);
await transaction.DisposeAsync();
}
Example transaction in your service
using (IDbContextTransaction transaction = await _customerRepository.BeginTransactionAsync(cancellationToken))
{
try
{
// Your code here.
}
catch (Exception exception)
{
_logger.LogError($"An error occurred. Rolling back changes. Exception: {exception}".);
await _customerRepository.RollbackTransactionAndDisposeAsync(transaction, cancellationToken);
return;
}
// Perform CRUD actions or whatever.
await _customerRepository.SaveAsync(cancellationToken);
await _customerRepository.CommitTransactionAndDisposeAsync(transaction, cancellationToken);
}
GenericCrudIdRepository
All methods as listed in GenericCrudRepository plus:
virtual Task<T?> ByIdAsync(int id, QueryTrackingBehavior queryTrackingBehavior = QueryTrackingBehavior.TrackAll, CancellationToken cancellationToken = default, params Expression<Func<T, object>>[] includes);
virtual async Task<int> DeleteOverflowingEntities(int maxEntities, Func<IQueryable<TEntity>, IOrderedQueryable<TEntity>>? orderBy = null, CancellationToken cancellationToken = default)
virtual Task<bool> HasIdAsync(int id, CancellationToken cancellationToken);
virtual Task<int> HighestIdAsync(CancellationToken cancellationToken);
virtual Task<int> LowestIdAsync(CancellationToken cancellationToken);
virtual Task<int> NextIdAsync(int sourceId, bool cycle, CancellationToken cancellationToken);
virtual async Task<List<int>> OverflowingIds(int maxEntities, Func<IQueryable<TEntity>, IOrderedQueryable<TEntity>>? orderBy = null, QueryTrackingBehavior queryTrackingBehavior = QueryTrackingBehavior.TrackAll, CancellationToken cancellationToken = default)
virtual Task<int> PreviousIdAsync(int sourceId, bool cycle, CancellationToken cancellationToken);
GenericCrudGuidRepository
All methods as listed in GenericCrudRepository plus:
virtual Task<TEntity?> ByIdAsync(Guid id, QueryTrackingBehavior queryTrackingBehavior = QueryTrackingBehavior.TrackAll, CancellationToken cancellationToken = default, params Expression<Func<TEntity, object>>[] includes);
virtual Task<bool> HasIdAsync(Guid id, CancellationToken cancellationToken);
QueryableExtensions
IQueryable<T> AsTracking<T>(this IQueryable<T> source, bool isTracked) { .. }
IQueryable<T> OrderByColumn<T>(this IQueryable<T> source, string columnName, ListSortDirection sortDirection = ListSortDirection.Ascending) { .. }
IQueryable<T> OrderByColumn<T>(this IQueryable<T> source, string columnName, bool isAscending = true) { .. }
Upgrade instructions
0.6.3 → 0.7.0
Implement ExecuteSqlAsync(..) in your DbContext. Example implementation in your DbContext that inherits from IContext:
/// <inheritdoc/>
public async Task<int> ExecuteSqlAsync(FormattableString sql, CancellationToken cancellationToken = default)
{
return await Database.ExecuteSqlAsync(sql, cancellationToken);
}
0.8.1 → 0.9.0
Files have been moved into a different folder and namespace. Update your usings.
Some files have been moved into a different project. You may also need the NuGet Elephant.Database.Abstractions and also the NuGets Elephant.Types.Results and Elephant.Types.Results.Abstractions.
The ResponseWrappers are no longer used.
0.9.0 → 0.10.0
Add the "Async" (without double quotes) to your calls and overrides.
0.10.3 → 1.0.0
Moving to 1.0.0 to mark the project's stability. The transition from 0.10.3 is fully compatible with no breaking changes.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net6.0 is compatible. 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 is compatible. 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 is compatible. 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. net9.0 is compatible. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net10.0
- Elephant.Database.Abstractions (>= 1.0.0)
- Elephant.Types (>= 4.0.4)
- Elephant.Types.Interfaces (>= 4.0.3)
- Elephant.Types.Results (>= 1.0.3)
- Elephant.Types.Results.Abstractions (>= 1.0.1)
- Microsoft.AspNetCore.Http (>= 2.2.2)
- Microsoft.AspNetCore.Http.Features (>= 5.0.17)
- Microsoft.EntityFrameworkCore (>= 10.0.0)
-
net6.0
- Elephant.Database.Abstractions (>= 1.0.0)
- Elephant.Types (>= 4.0.4)
- Elephant.Types.Interfaces (>= 4.0.3)
- Elephant.Types.Results (>= 1.0.3)
- Elephant.Types.Results.Abstractions (>= 1.0.1)
- Microsoft.AspNetCore.Http (>= 2.2.2)
- Microsoft.AspNetCore.Http.Features (>= 5.0.17)
- Microsoft.EntityFrameworkCore (>= 6.0.0)
-
net7.0
- Elephant.Database.Abstractions (>= 1.0.0)
- Elephant.Types (>= 4.0.4)
- Elephant.Types.Interfaces (>= 4.0.3)
- Elephant.Types.Results (>= 1.0.3)
- Elephant.Types.Results.Abstractions (>= 1.0.1)
- Microsoft.AspNetCore.Http (>= 2.2.2)
- Microsoft.AspNetCore.Http.Features (>= 5.0.17)
- Microsoft.EntityFrameworkCore (>= 7.0.0)
-
net8.0
- Elephant.Database.Abstractions (>= 1.0.0)
- Elephant.Types (>= 4.0.4)
- Elephant.Types.Interfaces (>= 4.0.3)
- Elephant.Types.Results (>= 1.0.3)
- Elephant.Types.Results.Abstractions (>= 1.0.1)
- Microsoft.AspNetCore.Http (>= 2.2.2)
- Microsoft.AspNetCore.Http.Features (>= 5.0.17)
- Microsoft.EntityFrameworkCore (>= 8.0.0)
-
net9.0
- Elephant.Database.Abstractions (>= 1.0.0)
- Elephant.Types (>= 4.0.4)
- Elephant.Types.Interfaces (>= 4.0.3)
- Elephant.Types.Results (>= 1.0.3)
- Elephant.Types.Results.Abstractions (>= 1.0.1)
- Microsoft.AspNetCore.Http (>= 2.2.2)
- Microsoft.AspNetCore.Http.Features (>= 5.0.17)
- Microsoft.EntityFrameworkCore (>= 9.0.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Add two new methods.