Winche.Database 1.0.0

Winche.Database

A JSON document database layer built on top of PostgreSQL. Store, query, and subscribe to JSON documents using a structured query language — with PostgreSQL as the storage backend via JSONB.

Supports real-time subscriptions, ACID transactions, aggregation pipelines, and integrates with Winche.Sentinel for access control.

Install

dotnet add package Winche.Database

Add the REST or WebSocket API integrations as needed:

dotnet add package Winche.Database.AspNetCore.Rest
dotnet add package Winche.Database.AspNetCore.WebSockets

Quick Start

1. Configure appsettings.json

{
  "WincheDatabase": {
    "Schema": "public",
    "TableName": "documents",
    "TransactionConfig": {
      "TotalTimeoutSpan": "00:05:00",
      "IdleTimeoutSpan": "00:05:00",
      "CleanupInterval": "00:00:01"
    }
  }
}

2. Register services

builder.Services.AddWincheDatabase(connectionString, builder.Configuration);

// Add REST API (optional)
builder.Services.AddWincheDatabaseRestApi();

// Add WebSocket API (optional)
builder.Services.AddWincheDatabaseWsApi();

3. Initialize schema and map endpoints

// Ensures the documents table and indexes exist
app.UseWincheDatabase();

// Map REST routes (default prefix: "documents")
app.UseWincheDatabaseRestApi();

// Map WebSocket route (connects at /documents/ws)
app.UseWincheDatabaseWsApi();

See samples/WebApi for a complete working example.

Features

• Document storage — Store arbitrary JSON documents with automatic metadata (id, version, timestamps)
• Querying — Filter with 19+ conditional operators, sort, limit, offset, and cursor-based pagination
• Real-time subscriptions — Subscribe to queries and receive live updates over WebSocket when documents change
• Transactions — ACID transactions with commit/rollback, idle timeout, and automatic cleanup
• Aggregation pipelines — MongoDB-style pipeline stages: match, lookup, unwind, group, project, sort, limit, skip
• Batch operations — Atomic commit of multiple operations in a single request
• Sync mutations — Conflict-free document mutations (Set, Update, Delete) via mutation batches
• Access control — Document-level access rules via Winche.Sentinel integration
• PostgreSQL backend — All data stored as JSONB; queries translated to native PostgreSQL SQL

Packages

Requirements

• .NET 10.0
• PostgreSQL (any recent version with JSONB support)

License

Elastic License 2.0