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 135 2/8/2025
14.5.246 82 2/8/2025
14.5.245 90 2/7/2025
14.5.244 83 1/29/2025
14.5.242 77 1/29/2025
14.5.241 78 1/29/2025
14.4.240 172 11/2/2024
14.4.239 173 10/18/2024
14.4.237 105 9/19/2024
14.4.236 156 8/11/2024
14.3.235 122 8/10/2024
14.3.234 82 8/5/2024
14.3.233 90 7/29/2024
14.3.232 103 7/23/2024
14.3.231 102 7/22/2024
14.3.230 119 7/17/2024
14.3.229 90 7/17/2024
14.3.228 101 7/11/2024
14.3.227 106 7/10/2024
14.3.226 133 7/3/2024
14.3.225 125 6/14/2024
14.3.224 95 6/7/2024
14.3.223 113 6/6/2024
14.3.222 120 5/17/2024
14.3.221 147 4/12/2024
14.2.219 112 4/11/2024
14.2.218 110 4/10/2024
14.2.217 205 3/29/2024
14.2.216 126 3/27/2024
14.2.215 122 3/22/2024
14.1.212 126 3/11/2024
14.1.211 114 3/11/2024
14.1.210 116 3/6/2024
14.1.208 124 3/6/2024
14.1.206 128 3/2/2024
14.1.205 130 3/1/2024
14.0.204 136 2/19/2024
14.0.203 120 2/16/2024
14.0.201 132 2/15/2024
13.0.200 143 2/10/2024
13.0.199 123 2/10/2024
13.0.198 120 2/10/2024
13.0.197 303 12/10/2023
13.0.196 132 12/10/2023
13.0.195 131 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 158 11/14/2023
13.0.180 156 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 183 9/7/2023
12.1.165 210 8/28/2023
12.1.164 239 8/15/2023
12.1.163 200 8/14/2023
12.1.162 173 8/14/2023
12.1.161 213 6/20/2023
12.1.160 215 6/10/2023
12.1.158 182 5/31/2023
12.1.157 180 5/22/2023
12.1.7 179 5/21/2023
12.1.0 176 5/19/2023
12.0.21 183 5/18/2023
12.0.20 165 5/18/2023
12.0.19 186 5/10/2023
12.0.18 166 5/4/2023
12.0.17 192 5/3/2023
12.0.16 210 4/30/2023
12.0.15 199 4/30/2023
12.0.13 208 4/27/2023
12.0.12 215 4/27/2023
12.0.10 277 4/15/2023
12.0.9 263 4/6/2023
12.0.8 263 3/27/2023
12.0.7 258 3/27/2023
12.0.3 252 3/22/2023
12.0.2 253 3/22/2023
12.0.1 285 3/1/2023
12.0.0 320 2/11/2023
11.1.10 304 2/11/2023
11.1.9 306 2/10/2023
11.1.8 308 2/6/2023
11.1.7 306 2/5/2023
11.1.6 317 2/4/2023
11.1.5 314 2/4/2023
11.1.4 351 12/30/2022
11.1.3 386 12/26/2022
11.1.2 332 12/26/2022
11.1.1 344 12/25/2022
11.0.0 340 12/24/2022
1.0.0 367 12/24/2022