NexumNovus.AppSettings.Sqlite
0.1.1
See the version list below for details.
dotnet add package NexumNovus.AppSettings.Sqlite --version 0.1.1
NuGet\Install-Package NexumNovus.AppSettings.Sqlite -Version 0.1.1
<PackageReference Include="NexumNovus.AppSettings.Sqlite" Version="0.1.1" />
paket add NexumNovus.AppSettings.Sqlite --version 0.1.1
#r "nuget: NexumNovus.AppSettings.Sqlite, 0.1.1"
// Install NexumNovus.AppSettings.Sqlite as a Cake Addin #addin nuget:?package=NexumNovus.AppSettings.Sqlite&version=0.1.1 // Install NexumNovus.AppSettings.Sqlite as a Cake Tool #tool nuget:?package=NexumNovus.AppSettings.Sqlite&version=0.1.1
NexumNovus.AppSettings.Sqlite
This package enables you to load and persist settings into sqlite database, and encrypt/decrypt settings marked with SecretSetting attribute.
About
Sqlite configuration provider implementation for Microsoft.Extensions.Configuration. This package enables you to
- read application settings from Sqlite database.
- update application settings and save changes to Sqlite database.
- cryptographically protect selected application settings
Use SqliteHostBuilderExtensions.AddSQLiteConfig
extension method on IHostBuilder
to add the Sqlite configuration provider to the configuration builder and register SqliteSettingsRepository
with service collection.
Use ISettingsRepository.UpdateSettingsAsync
to update Sqlite settings.
Mark properties with SecretSetting
attribute to cryptographically protect them.
Example
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Options;
using NexumNovus.AppSettings.Common;
using NexumNovus.AppSettings.Common.Secure;
using NexumNovus.AppSettings.Sqlite;
var builder = WebApplication.CreateBuilder(args);
// Load settings from sqlite database and register settings repository with service collection
builder.Host.AddSQLiteConfig("Data Source=demo.data.db");
// Use of options pattern to register configuration elements is optional.
builder.Services.AddOptions<EmailSettings>().BindConfiguration(EmailSettings.ConfigElement);
var app = builder.Build();
// Api's to get and update EmailSettings
app.MapGet("/emailSettings", (IOptionsMonitor<EmailSettings> emailSettings) => emailSettings.CurrentValue);
app.MapPost("/emailSettings", async (EmailSettings emailSettings, ISettingsRepository settingsRepo)
=> await settingsRepo.UpdateSettingsAsync(EmailSettings.ConfigElement, emailSettings)
);
// Api's to get and update a setting
app.MapGet("/settings", (string section, IConfiguration settings) => settings.GetSection(section));
app.MapPost("/settings", async (string section, string value, ISettingsRepository settingsRepo)
=> await settingsRepo.UpdateSettingsAsync(section, value)
);
app.Run();
public record EmailSettings
{
public static string ConfigElement = "Email";
public string Host { get; set; }
public string Username { get; set; }
[SecretSetting]
public string Password { get; set; } //this setting will be cryptographically protected
}
If a setting is not found in the database, then it's created.
Note that password is marked with [SecretSetting]
and it will be protected. After update Sqlite database will have a table __AppSettings
with data:
Key | Value |
---|---|
Email:Host | "example.com" |
Email:Username | "my_username" |
Email:Password | "CfDJ8IBGRtcA2S1Ji7VPVwaKmLYnTN6skE_2RQqvNZ8_CN5y3Xvk3LkFC6GXCe8EY7AicxH5...." |
Default implementation for ISecretProtector
uses Microsoft.AspNetCore.DataProtection.
You can also provide your own implementation.
By default settings are reloaded if updated using ISettingsRepository
. If you need to reload them on external database changes set CheckForChangesPeriod
to a timespan value larger that zero.
builder.Host.AddSQLiteConfig(x =>
{
x.ConnectionString = "Data Source=demo.data.db",
x.TableName = "MyCustomNameForAppSettingsTable",
x.CheckForChangesPeriod = TimeSpan.FromSeconds(60),
x.Protector = <your implementation of ISecretProtector>
});
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 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. |
-
net6.0
- Microsoft.Data.Sqlite (>= 7.0.5)
- NexumNovus.AppSettings.Common (>= 0.3.1)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.