SharpCoreDB

A lightweight, encrypted, file-based database engine written in C# .Net

Generate Convert Improve

Install / Use

/learn @MPCoreDeveloper/SharpCoreDB

About this skill

Quality Score

0/100

README

SharpCoreDB

High-Performance Embedded & Network Database for .NET 10

</div>

📌 Current Status — v1.6.0 (March 20, 2026)

✅ Production-Ready: ALL Phase 1-12 Features Complete (100%)

SharpCoreDB v1.6.0 is the synchronized package release for the current feature and fix set: all NuGet packages now ship on the same version, the package documentation has been refreshed, and the optional Event Sourcing, Projections, and CQRS packages are documented as first-class companions to the core engine.

🎉 Major Milestone: All Core Features + Server Complete

Phase 1-12 (100% Complete): SharpCoreDB is now a fully-featured, production-ready embedded AND networked database with advanced analytics, vector search, graph algorithms, GraphRAG analytics, distributed capabilities, and server mode.

Latest Achievement: 🚀 Phase 12 - SharpCoreDB.Graph.Advanced COMPLETE (100%)
SharpCoreDB now includes a dedicated advanced graph analytics and GraphRAG package with community detection, centrality metrics, subgraph analysis, and graph-aware semantic ranking.

Latest Package Delivered:

✅ SharpCoreDB.Graph.Advanced
✅ GraphRAG ranking and vector integration
✅ SQL graph analytics helpers
✅ Community detection and centrality metrics
✅ Subgraph analysis and profiling utilities

Server Features Delivered:

✅ gRPC protocol (HTTP/2 + HTTP/3, primary protocol)
✅ Binary TCP protocol handler
✅ HTTPS REST API (DatabaseController)
✅ WebSocket streaming protocol (real-time query streaming)
✅ JWT authentication + Role-Based Access Control
✅ Mutual TLS (certificate-based authentication)
✅ Multi-database registry with system databases
✅ Connection pooling (1000+ concurrent connections)
✅ Health checks & metrics (Prometheus-compatible)
✅ .NET Client library (ADO.NET-style)
✅ Python client (PySharpDB - published to PyPI)
✅ JavaScript/TypeScript SDK (published to npm)
✅ Docker + Docker Compose deployment
✅ Cross-platform installers (Windows Service, Linux systemd)
✅ Complete server documentation and examples

See documentation: docs/INDEX.md

✅ Previously Known Limitation — Resolved

SingleFileDatabase.ExecuteCompiled with parameterized plans previously hung due to an infinite loop in the SQL lexer (? parameter placeholder). Fixed: FastSqlLexer, EnhancedSqlParser, QueryCompiler. Full IAsyncDisposable lifecycle also implemented.

📈 Performance Improvements (March 20, 2026)

After the IAsyncDisposable lifecycle refactor and SQL lexer/parser fixes, benchmarks show zero regressions and significant gains:

| Benchmark | Before | After | Improvement | |-----------|-------:|------:|:------------| | Single-File SELECT (Unencrypted) | 4.01 ms | 1.81 ms | 55% faster | | Single-File SELECT (Encrypted) | 2.74 ms | 1.57 ms | 43% faster | | AppendOnly UPDATE | 143.42 ms | 70.36 ms | 51% faster | | Dir Encrypted UPDATE | 9.16 ms | 7.91 ms | 14% faster |

All other benchmarks (25 total) remain stable. Full results: docs/BENCHMARK_RESULTS.md

📚 Documentation Policy

Canonical documentation entry points are docs/INDEX.md and docs/README.md.
Topic-level canonical entry points are maintained under:
- docs/server/README.md
- docs/scdb/README_INDEX.md
- docs/graphrag/00_START_HERE.md
Obsolete phase-status, kickoff, completion, and superseded planning documents are periodically removed.
Historical snapshots are not treated as canonical product documentation.

🎯 Latest Release (v1.5.0 → v1.6.0)

New in v1.6.0 compared to v1.5.0

Functional package family introduced
- SharpCoreDB.Functional adds a functional façade over Database / IDatabase
- SharpCoreDB.Functional.Dapper adds modular Dapper adapters with Option<T>, Fin<Unit>, and Seq<T>-based APIs
- SharpCoreDB.Functional.EntityFrameworkCore adds modular EF Core adapters with the same functional programming model
- All functional packages are designed as optional modules and keep production dependencies flowing through transitive NuGet references
Advanced graph analytics and GraphRAG package delivered
- New SharpCoreDB.Graph.Advanced package
- Community detection, centrality metrics, subgraph analysis, graph-aware ranking, and profiling helpers
Event Sourcing / Projections / CQRS package maturity improvements
- Optional package guidance now clearly documents durable snapshots, projection checkpointing, persistent outbox workflows, retry handling, dead-letter support, and hosted background workers
- These capabilities are now presented as first-class companion modules in the documentation and package ecosystem
Core engine and packaging improvements
- Synchronized 1.6.0 package versioning across the SharpCoreDB ecosystem
- Refreshed package documentation for the core engine and companion packages
- Brotli compression for metadata with backward-compatible format detection
- Immediate metadata flush and reopen-path fixes for improved durability and startup reliability
- SQL lexer / parser fixes for parameterized compiled-query execution paths
Quality and validation
- New functional module tests added for core, Dapper, and EF Core adapters
- Zero breaking changes intended from 1.5.0 to 1.6.0
- Workspace and targeted adapter test suites validate the new modules successfully
📊 Quality Metrics
- 1,490+ tests (was 850+ in v1.3.5)
- 100% backward compatible
- All 12 phases production-ready

🚀 Complete Feature Set (Phases 1-12)

Phase 12: Advanced Graph Analytics & GraphRAG ✅

SharpCoreDB.Graph.Advanced package for advanced graph analytics
GraphRAG search with semantic + graph-aware ranking
Community detection: Louvain, Label Propagation, Connected Components
Centrality metrics: Degree, Betweenness, Closeness, Eigenvector, Clustering
Subgraph queries: K-core, clique detection, triangle detection
SQL integration, result caching, and profiling utilities

Phase 11: SharpCoreDB.Server (Network Database Server) ✅

gRPC protocol (HTTP/2 + HTTP/3) - primary, high-performance protocol
Binary TCP protocol - PostgreSQL wire protocol compatibility
HTTPS REST API - web browser and simple integration support
WebSocket streaming - real-time query streaming
JWT + Mutual TLS authentication
Role-Based Access Control (Admin/Writer/Reader)
Multi-database support with system databases
Connection pooling (1000+ concurrent connections)
Health checks & Prometheus metrics
.NET, Python, JavaScript/TypeScript client libraries
Docker + cross-platform installers (Windows/Linux)
Complete documentation and examples

Phase 10: Enterprise Distributed Features ✅

Multi-master replication with vector clocks (Phase 10.2)
Distributed transactions with 2PC protocol (Phase 10.3)
Dotmim.Sync integration for cloud sync (Phase 10.1)

Phase 9: Advanced Analytics ✅

100+ aggregate functions (COUNT, SUM, AVG, STDDEV, VARIANCE, PERCENTILE, CORRELATION)
Window functions (ROW_NUMBER, RANK, DENSE_RANK, LAG, LEAD)
150-680x faster than SQLite

Phase 8: Vector Search ✅

HNSW indexing with SIMD acceleration
50-100x faster than SQLite
Production-tested with 10M+ vectors

Phase 6: Graph Algorithms ✅

A* pathfinding (30-50% improvement)
Graph traversal (BFS, DFS, bidirectional search)
ROWREF data type for graph edges
GRAPH_TRAVERSE() SQL function

Phases 1-5: Core Engine ✅

Single-file encrypted database (AES-256-GCM)
SQL support with advanced query optimization
ACID transactions with WAL
B-tree and hash indexing
Full-text search
SIMD-accelerated operations
Memory pooling and JIT optimizations

📦 Installation

# Core database
dotnet add package SharpCoreDB --version 1.6.0

# Server mode (network database server)
dotnet add package SharpCoreDB.Server --version 1.6.0
dotnet add package SharpCoreDB.Client --version 1.6.0

# Distributed features
dotnet add package SharpCoreDB.Distributed --version 1.6.0

# Analytics engine
dotnet add package SharpCoreDB.Analytics --version 1.6.0

# Vector search
dotnet add package SharpCoreDB.VectorSearch --version 1.6.0

# Sync integration
dotnet add package SharpCoreDB.Provider.Sync --version 1.6.0

# Graph algorithms
dotnet add package SharpCoreDB.Graph --version 1.6.0

# Advanced graph analytics and GraphRAG
dotnet add package SharpCoreDB.Graph.Advanced --version 1.6.0

# Optional integrations
dotnet add package SharpCoreDB.EntityFrameworkCore --version 1.6.0
dotnet add package SharpCoreDB.Extensions --version 1.6.0

# Functional programming adapters (optional packages)
dotnet add package SharpCoreDB.Functional --version 1.6.0
dotnet add package SharpCoreDB.Functional.Dapper --version 1.6.0
dotnet add package SharpCoreDB.Functional.EntityFrameworkCore --version 1.6.0