Ax.Fw.Storage 14.5.247

dotnet add package Ax.Fw.Storage --version 14.5.247
                    
NuGet\Install-Package Ax.Fw.Storage -Version 14.5.247
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Ax.Fw.Storage" Version="14.5.247" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Ax.Fw.Storage" Version="14.5.247" />
                    
Directory.Packages.props
<PackageReference Include="Ax.Fw.Storage" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Ax.Fw.Storage --version 14.5.247
                    
#r "nuget: Ax.Fw.Storage, 14.5.247"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#addin nuget:?package=Ax.Fw.Storage&version=14.5.247
                    
Install Ax.Fw.Storage as a Cake Addin
#tool nuget:?package=Ax.Fw.Storage&version=14.5.247
                    
Install Ax.Fw.Storage as a Cake Tool

Ax.Fw.Storage

Simple document database; based on SQLite

Why?

I just wanted to create an instance of class and be able to write to database, read from database, enumerate elements in database by key without thinking about "this database's BSON don't support ImmutableDictionary, meh", "that database doesn't support numeric keys, meh", "ah, I can't search for values of integer column using unsigned integer variable, meh" and so on. Why not "key-value" storage? I also wanted to filter my objects by last changed time. That's it. This document storage engine is not as fast as more "strongly-typed" databases (I think it's 1.1 - 1.5x slower in some scenarios), but it is reliable as any SQLite database.

Usage example:

// we need CancellationToken
var ct = default(CancellationToken);

// path to database file
var dbFile = "/home/user/data.db"

try
{
    // create database or open existing
    using var storage = new SqliteDocumentStorage(dbFile);

    // create document; pair 'namespace - key' is unique; any json serializable data can be stored
    var doc = await storage.WriteDocumentAsync(_namespace: "default", _key: "test-key", _data: "test-data-0", ct);

    // retrieve data
    var readDoc = await storage.ReadDocumentAsync(_namespace: "default", _key: "test-key", ct);

    Assert.Equal("test-data-0", readDoc?.Data.ToObject<string>());

    // there are also 'simple' documents; 
    // namespace of simple documents is automatically determined by data type or by `SimpleDocumentAttribute`
    var simpleDoc = await storage.WriteSimpleDocumentAsync(_entryId: 123, _data: "test_data", ct);

    var readSimpleDoc = await storage.ReadSimpleDocumentAsync<string>(_entryId: 123, ct);

    Assert.Equal("test_data", readSimpleDoc?.Data);

    // you also can attach in-memory cache to document storage
    // cache makes read operations significantly faster
    using var cachedStorage = storage.WithCache(_maxValuesCached: 1000, _cacheTtl: TimeSpan.FromSeconds(60));

    // you also can attach retention rules to document storage
    // documents older than certain age will be automatically deleted
    using var storageWithRules = storage
      .WithRetentionRules(TimeSpan.FromHours(1), TimeSpan.FromHours(1), TimeSpan.FromMinutes(10));
}
finally
{
    new FileInfo(dbFile).TryDelete();
}
Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  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.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
14.5.247 166 2/8/2025
14.5.246 88 2/8/2025
14.5.245 97 2/7/2025
14.5.244 89 1/29/2025
14.5.242 83 1/29/2025
14.5.241 84 1/29/2025
14.4.240 178 11/2/2024
14.4.239 178 10/18/2024
14.4.237 110 9/19/2024
14.4.236 161 8/11/2024
14.3.235 127 8/10/2024
14.3.234 87 8/5/2024
14.3.233 95 7/29/2024
14.3.232 108 7/23/2024
14.3.231 107 7/22/2024
14.3.230 124 7/17/2024
14.3.229 95 7/17/2024
14.3.228 106 7/11/2024
14.3.227 111 7/10/2024
14.3.226 138 7/3/2024
14.3.225 130 6/14/2024
14.3.224 99 6/7/2024
14.3.223 117 6/6/2024
14.3.222 124 5/17/2024
14.3.221 151 4/12/2024
14.2.219 116 4/11/2024
14.2.218 114 4/10/2024
14.2.217 209 3/29/2024
14.2.216 130 3/27/2024
14.2.215 126 3/22/2024
14.1.212 130 3/11/2024
14.1.211 118 3/11/2024
14.1.210 120 3/6/2024
14.1.208 128 3/6/2024
14.1.206 132 3/2/2024
14.1.205 134 3/1/2024
14.0.204 140 2/19/2024
14.0.203 124 2/16/2024
14.0.201 138 2/15/2024
13.0.200 147 2/10/2024
13.0.199 127 2/10/2024
13.0.198 124 2/10/2024
13.0.197 308 12/10/2023
13.0.196 136 12/10/2023
13.0.195 135 12/9/2023
13.0.194 115 12/6/2023
13.0.192 131 12/5/2023
13.0.191 161 11/26/2023
13.0.189 139 11/24/2023
13.0.186 134 11/23/2023
13.0.185 139 11/22/2023
13.0.182 136 11/18/2023
13.0.181 162 11/14/2023
13.0.180 235 11/12/2023
13.0.179 129 11/10/2023
12.1.178 158 10/25/2023
12.1.177 151 10/24/2023
12.1.176 148 10/21/2023
12.1.175 151 10/21/2023
12.1.173 144 10/16/2023
12.1.172 170 10/15/2023
12.1.171 146 10/15/2023
12.1.170 137 10/15/2023
12.1.168 162 10/15/2023
12.1.167 122 10/14/2023
12.1.166 184 9/7/2023
12.1.165 211 8/28/2023
12.1.164 242 8/15/2023
12.1.163 201 8/14/2023
12.1.162 174 8/14/2023
12.1.161 215 6/20/2023
12.1.160 218 6/10/2023
12.1.158 186 5/31/2023
12.1.157 183 5/22/2023
12.1.7 182 5/21/2023
12.1.0 179 5/19/2023
12.0.21 186 5/18/2023
12.0.20 168 5/18/2023
12.0.19 189 5/10/2023
12.0.18 169 5/4/2023
12.0.17 195 5/3/2023
12.0.16 213 4/30/2023
12.0.15 202 4/30/2023
12.0.13 212 4/27/2023
12.0.12 218 4/27/2023
12.0.10 280 4/15/2023
12.0.9 266 4/6/2023
12.0.8 266 3/27/2023
12.0.7 261 3/27/2023
12.0.3 255 3/22/2023
12.0.2 256 3/22/2023
12.0.1 288 3/1/2023
12.0.0 323 2/11/2023
11.1.10 307 2/11/2023
11.1.9 309 2/10/2023
11.1.8 311 2/6/2023
11.1.7 309 2/5/2023
11.1.6 320 2/4/2023
11.1.5 318 2/4/2023
11.1.4 354 12/30/2022
11.1.3 389 12/26/2022
11.1.2 335 12/26/2022
11.1.1 347 12/25/2022
11.0.0 343 12/24/2022
1.0.0 370 12/24/2022