LSL.EfCore.SettingsTable
1.0.6
See the version list below for details.
dotnet add package LSL.EfCore.SettingsTable --version 1.0.6
NuGet\Install-Package LSL.EfCore.SettingsTable -Version 1.0.6
<PackageReference Include="LSL.EfCore.SettingsTable" Version="1.0.6" />
paket add LSL.EfCore.SettingsTable --version 1.0.6
#r "nuget: LSL.EfCore.SettingsTable, 1.0.6"
// Install LSL.EfCore.SettingsTable as a Cake Addin #addin nuget:?package=LSL.EfCore.SettingsTable&version=1.0.6 // Install LSL.EfCore.SettingsTable as a Cake Tool #tool nuget:?package=LSL.EfCore.SettingsTable&version=1.0.6
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
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. 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 was computed. 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 was computed. 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. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.0
- Microsoft.EntityFrameworkCore (>= 3.1.0)
- Microsoft.EntityFrameworkCore.Relational (>= 3.1.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.