LSL.EfCore.SettingsTable 1.0.7

LSL.EfCore.SettingsTable

This package provides ModelBuilder extension methods to allow you to produce a settings table.

NOTE: You will still need to create migrations to ensure the table gets created. Please see here for further details.

Quickstart

To add the required entities to your DbContext then following should be added to OnModelCreating as below:

    using LSL.EfCore.SettingsTable;
    ...
    protected override void OnModelCreating(ModelBuilder modelBuilder)
    {
        ...
        modelBuilder.AddSettingsTable();
        ...
    }

The default table name is Settings with a Key field called Key and a value field called Value. Each value can be customised by overriding the defaults as below:

    using LSL.EfCore.SettingsTable;
    ...
    protected override void OnModelCreating(ModelBuilder modelBuilder)
    {
        ...
        modelBuilder.AddSettingsTable("CustomSettingsTable", "CustomKeyField", "CustomValueField");
        ...
    }

Using a custom entity

If you want more fields in your entity then create your own class and have it implement the ISetting interface to get the benefit of index generation.

...
// This lives in an entity class file
using LSL.EfCore.SettingsTable.Entities;

namespace YourEntityNamespace;

public class MySetting : ISetting
{
    public string Key { get; set; }
    public string Value { get; set; }
    public DateTime CreatedAt { get; set; }
}

...
// This is put in your DbContext
using LSL.EfCore.SettingsTable;
using YourEntityNamespace;
...
protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    ...
    // as per the previous examples for the non-generic AddSettingsTable method, all parameters here are optional
    modelBuilder.AddSettingsTable<MySetting>("CustomSettingsTable", "CustomKeyField", "CustomValueField");
    ...
}

Finer grained control

Another extension method exists that allows for finer-grained control over the entity used and its EF Core configuration:

using LSL.EfCore.SettingsTable;
...
protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    ...
    modelBuilder.AddSettingsTable<OtherSettings>(c => c.ConfigureEntity(e => e.HasKey(ee => ee.MyKey)));
    ...
}

In the example above the delegate passed into ConfigureEntity receives an EntityTypeBuilder<OtherSettings> to configure the EF Core entity