Hydrogen.Repo 2.7.0-preview.2

Hydrogen Repo

This package uses SqlKata as query builder, if you have doubts check its documentation.

Installation

dotnet add package Hydrogen.Repo
dotnet add package Hydrogen.Repo.Abstractions

Models

Create a model

[DeletedAt] //The deletion will be soft and not logical.
[Table("Users")] // Table name in the database.
public class User
{
    [PrimaryKey] // Mark the property as the primary key.
    [AutoGenerateGuid] // Indicate that it will be an auto-generated GUID field.
    public Guid Id { get; set; }    
    public Guid RoleId { get; set; }
    public string Email { get; set; } = string.Empty;
    public string Password { get; set; } = string.Empty;
    public bool TwoFactor { get; set; }
    [CreatedAt] // Indicate that the property functions as a timestamp of when the element was created.
    public DateTime CreatedAt { get; set; }
    [UpdatedAt] // Indicate that the property functions as a timestamp of when the element was updated.
    public DateTime UpdatedAt { get; set; }
    
}

Database context

Create a database context interface

public interface IDatabaseContext : IHydrogenContext
{

}

Create a class that implements the database context interface

public class DatabaseContext : HydrogenContext, IDatabaseContext
{
    public DatabaseContext(IDbConnection connection, DbConnectionType connectionType, bool debug = false, Action<SqlResult>? action = null) 
            : base(connection, connectionType, debug, action)
        {
        }
}

Unit of work (optional)

Create an interface for the unit of work

public interface IDatabaseUnitOfWork : IHydrogenUnitOfWork
{
}

Create a class that implements the unit of work interface

class DatabaseUnitOfWork : HydrogenUnitOfWork, IDatabaseUnitOfWork
{
    public DatabaseUnitOfWork(IDatabaseContext DatabaseContext) : base(DatabaseContext)
    {
    }
}

Repositories

Create the repository interface

public interface IUserRepository : IHydrogenRepository<User, Guid>
{
    // Add your functions
}

Create a class that implements the repository interface

The repository already implements the basic functions.

public class UserRepository : HydrogenRepository<User, Guid>, IUserRepository
{
    public UserRepository(IDatabaseContext databaseContext) : base(databaseContext)
    {
    }
}

Add the implementations to the service collection

var connectionBuilder = new SqliteConnectionStringBuilder()
{
    DataSource = Path.Join(Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData), "test.db"),
};

        
var connection = new SqliteConnection(connectionBuilder.ConnectionString);

collection.AddScoped<IDatabaseContext>(_ => new DatabaseContext(connection, DbConnectionType.SQLite, true));
collection.AddScoped<IDatabaseUnitOfWork, DatabaseUnitOfWork>();
collection.AddScoped<IUserRepository, UserRepository>();

Use it in a service

private readonly IUserRepository _userRepository;

public OptionService(IUserRepository userRepository)
{
    _userRepository = userRepository;
}

public async Task<IEnumerable<UserDto>> GetAllAsync(CancellationToken ct)
{
    return _userRepository.GetAsync<UserDto>(ct);
}

Available functions

• Any
• Count
• Insert
• Bulk insert
• Bulk update
• Update
• Delete
• Get
• Pagination
• First
• First or default