decaf-orm.services 0.1.236

decaf.services

This package provides additional services or wrappers which may be useful. Primarily it provides services split using the CQRS pattern:

• Query<T>
• Command<T>
• or combined Service<T>

There are several variants of these, that allow for multiple composite keys on entities. This is supplied through the IEntity interface, which has four variants:

1. IEntity - no primary key defined
2. IEntity<TKey> - a single primary key of the type TKey
3. IEntity<TKeyOne, TKeyTwo> - a composite primay key of the type <TKeyOne, TKeyTwo>
4. IEntity<TKeyOne, TKeyTwo, TKeyThree> - a composite primary key of the type <TKeyOne, TKeyTwo, TKeyThree>

Each of these exist for the Command, Query and Service variants.

Each IEntity has a KeyMetadata property, which represents the primary key information for that object.
This is either just an IKeyMetadata instance, or it is a ICompositeKey corresponding to the primary key as defined.

To use services, your entities should inherit from one of the Entity classes as they provide the base structures necessary for the services to operate.
You will need to provide the key metadata at this point.
An example of a simple entity is below:

public class Person : Entity<int>
{
    public Person() : base(nameof(Id)) { }

    public int Id { get; set; }
    public string FirstName { get; set; }
    public string LastName { get; set; }
}

Note that the key name is passed into the base constructor to provide the key metadata.

To add a Query, Command or Service to your DI container, use the following as a template:

services.AddDecafService<Person>().AsScoped();

You can also use AsSingleton() or AsTransient() depending on your requirements. The above method registers the following:

• IQuery<Person>
• ICommand<Person>
• IService<Person>

Status:

Build

Sonar Cloud

Documentation

Documentation can be found here: README.