FluxFlow.Components.Storage.SqlFile 3.3.5

There is a newer version of this package available.
See the version list below for details.
dotnet add package FluxFlow.Components.Storage.SqlFile --version 3.3.5
                    
NuGet\Install-Package FluxFlow.Components.Storage.SqlFile -Version 3.3.5
                    
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="FluxFlow.Components.Storage.SqlFile" Version="3.3.5" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="FluxFlow.Components.Storage.SqlFile" Version="3.3.5" />
                    
Directory.Packages.props
<PackageReference Include="FluxFlow.Components.Storage.SqlFile" />
                    
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 FluxFlow.Components.Storage.SqlFile --version 3.3.5
                    
#r "nuget: FluxFlow.Components.Storage.SqlFile, 3.3.5"
                    
#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.
#:package FluxFlow.Components.Storage.SqlFile@3.3.5
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=FluxFlow.Components.Storage.SqlFile&version=3.3.5
                    
Install as a Cake Addin
#tool nuget:?package=FluxFlow.Components.Storage.SqlFile&version=3.3.5
                    
Install as a Cake Tool

FluxFlow.Components.Storage.SqlFile

Single-file SQL storage adapter for FluxFlow.Components.Storage.

This package does not add workflow nodes. It provides an IStorageStore implementation and registration helpers for the existing storage nodes:

  • storage.put
  • storage.get
  • storage.query
  • storage.delete

Register

var options = new StorageComponentOptions()
    .UseSqlFileStorage(new SqlFileStorageStoreOptions
    {
        DatabasePath = "data/storage.db",
        DefaultCollection = "items"
    });

await using var lease = await options.StoreFactory.OpenAsync(
    new StorageStoreContext
    {
        StoreName = "default",
        Collection = "items",
        Clock = options.Clock
    });

IStorageStore store = lease.Store;

Set StorageComponentOptions.UseClock(...) when node results and adapter records should share a deterministic time source. SqlFileStorageStore also accepts SqlFileStorageStoreOptions.Clock for direct store use or an adapter-specific override.

Hosts that use keyed resources can register the backend factory directly:

services.AddFluxFlowSqlFileStorageStore(
    "items-store",
    new SqlFileStorageStoreOptions
    {
        DatabasePath = "data/storage.db",
        DefaultCollection = "items"
    });

This registers a keyed IStorageStore for hosts that want a fixed opened store owned by DI. Hosts that need per-open context or a factory resource can register the backend factory instead:

services.AddFluxFlowSqlFileStorageStoreFactory(
    "items-store",
    new SqlFileStorageStoreOptions
    {
        DatabasePath = "data/storage.db",
        DefaultCollection = "items"
    });

This registers a keyed IStorageStoreFactory. Storage composition can reference either key through the store resource. Direct keyed stores are treated as shared host-owned stores; keyed factories are opened and released as part of composed node lifetime. The registration helpers reject null service collections, blank keys, null direct options, null options factories, and null options factory results before creating the keyed store or store factory. Keyed DI helper names are trimmed before registration, matching the store-name normalization used by storage contexts and adapter options.

Behavior

  • one record table per database file
  • store, collection, and key primary key
  • create, replace, and upsert write modes
  • unsupported write mode values are rejected
  • optimistic version checks through ExpectedVersion
  • expiration honored by storage.get and storage.query
  • query by collection, key prefix, attributes, stored time bounds, expiration, offset, and limit
  • query expiration checks use one captured clock timestamp for database and in-memory filtering
  • owned store lifetime when opened through UseSqlFileStorage
  • per-open context for store name, default collection, and clock

The adapter is intended for single-machine workflows, service hosts, and desktop apps that need a durable local store with stronger coordination than per-record JSON files.

Options

Option Purpose
DatabasePath Required database file path.
StoreName Optional fallback store name when the node does not set store.
CreateDatabase Allows creating the database file when it does not exist.
CreateDirectory Creates the parent directory when it does not exist.
AllowAbsoluteDatabasePath Allows absolute database path values.
MaxValueBytes Rejects values whose serialized JSON exceeds the limit.
DefaultCollection Optional fallback collection.
BusyTimeoutMilliseconds Wait time for a locked database before failing.
Clock Optional direct-store time source override.

DatabasePath, StoreName, and DefaultCollection are trimmed when assigned; blank store names and default collections are treated as absent. MaxValueBytes and BusyTimeoutMilliseconds must be greater than zero.

The package persists only neutral StorageRecord data. Hosts that need exact payload shaping should compose serialization or payload nodes before storage. Attribute keys and values are trimmed before persistence and query matching. Blank attribute keys/values and duplicate attribute keys after trimming are rejected so attribute filters stay deterministic. Invalid query paging and stored time ranges where StoredFrom is later than StoredTo are rejected through the shared storage query validation.

Composition

This package does not expose FluxFlow.Composition node factories. Use FluxFlow.Components.Storage.Composition for storage.put, storage.get, storage.query, and storage.delete; register either an opened keyed IStorageStore or this package's keyed IStorageStoreFactory as a host-owned resource for those factories.

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.  net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.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
6.0.0-rc.1 87 9/5/2026
5.0.0 140 8/3/2026
3.3.5 118 7/3/2026
3.3.4 116 7/2/2026
3.0.0 122 6/19/2026
2.0.0 144 6/18/2026
1.1.0 127 6/12/2026
1.0.0 130 6/4/2026
0.3.0-alpha.1 75 6/3/2026
0.2.0-alpha.1 80 6/2/2026
0.1.0-alpha.1 83 6/2/2026

Adds the shared FluxFlow package icon. No source, API, or dependency changes.