WalFlow.Signals.File 0.1.0-alpha.alpha.20260708090623

This is a prerelease version of WalFlow.Signals.File.

dotnet add package WalFlow.Signals.File --version 0.1.0-alpha.alpha.20260708090623

NuGet\Install-Package WalFlow.Signals.File -Version 0.1.0-alpha.alpha.20260708090623

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="WalFlow.Signals.File" Version="0.1.0-alpha.alpha.20260708090623" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="WalFlow.Signals.File" Version="0.1.0-alpha.alpha.20260708090623" />
                    

                            Directory.Packages.props

<PackageReference Include="WalFlow.Signals.File" />
                    

                            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 WalFlow.Signals.File --version 0.1.0-alpha.alpha.20260708090623

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: WalFlow.Signals.File, 0.1.0-alpha.alpha.20260708090623"

#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 WalFlow.Signals.File@0.1.0-alpha.alpha.20260708090623

#: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=WalFlow.Signals.File&version=0.1.0-alpha.alpha.20260708090623&prerelease
                    

                            Install as a Cake Addin

#tool nuget:?package=WalFlow.Signals.File&version=0.1.0-alpha.alpha.20260708090623&prerelease
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

WalFlow.Signals.File

File-based incremental snapshot signaling channel plugin for WalFlow.

Adds SignalChannel.File support by registering IIncrementalSnapshotSignalChannelProvider and plugin-local option validation.

Install

dotnet add package WalFlow.Signals.File

Configuration

services.AddWalFlowFileSignalChannel(options =>
{
    options.Path = "/var/run/walflow/signals.json";
});

FileSignalChannelOptions:

Property	Type	Default	Description
`Path`	`string?`	`null`	Signal file path (required when `SignalChannel.File` is enabled)

Usage

services.AddWalFlowFileSignalChannel(options =>
{
    options.Path = "/var/run/walflow/signals.json";
});

services.Configure<CdcProcessorOptions>(opt =>
{
    opt.Signaling.EnabledChannels = [SignalChannel.Source, SignalChannel.File];
});

Signal Payload Format

File content accepts:

one JSON object
JSON array of objects
newline-delimited JSON objects

Each object uses Debezium-style fields:

{
  "id": "sig-1",
  "type": "execute-snapshot",
  "data": { "data-collections": ["public.users"], "type": "incremental" }
}

Notes

File channel truncates successfully parsed signal files to avoid replay; malformed or partial payloads remain for correction.
Validation fails startup if SignalChannel.File is enabled but FileSignalChannelOptions.Path is empty.

Product	Compatible and additional computed target framework versions.
.NET	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.

net10.0
- Microsoft.Extensions.DependencyInjection (>= 10.0.9)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 10.0.9)
- Microsoft.Extensions.Logging (>= 10.0.9)
- Microsoft.Extensions.Logging.Abstractions (>= 10.0.9)
- Microsoft.Extensions.Options (>= 10.0.9)
- Npgsql (>= 10.0.3)
- WalFlow.Abstractions (>= 0.1.0-alpha.alpha.20260708090623)
- WalFlow.Sources.Postgres (>= 0.1.0-alpha.alpha.20260708090623)

NuGet packages (1)

Showing the top 1 NuGet packages that depend on WalFlow.Signals.File:

Package	Downloads
WalFlow Meta-package that pulls in the full WalFlow CDC stack for consumers who want the default everything-included setup.	83

GitHub repositories

This package is not used by any popular GitHub repositories.

Version	Downloads	Last Updated
0.1.0-alpha.alpha...	90	7/8/2026
0.1.0-alpha.alpha...	96	3/30/2026