Skip to content

Latest commit

 

History

History
202 lines (148 loc) · 7.18 KB

README.md

File metadata and controls

202 lines (148 loc) · 7.18 KB
SharpCoreDB Logo

SharpCoreDB

High-Performance Embedded Database for .NET 10

License: MIT .NET NuGet Build Tests C#

📌 Current Status — v1.4.1 (February 28, 2026)

✅ Production-Ready: Phase 10 Complete + Critical Stability Fixes

SharpCoreDB v1.4.1 delivers critical bug fixes, 60-80% metadata compression, and enterprise-scale distributed features.

🎯 Latest Release (v1.4.0 → v1.4.1)

  • 🐛 Critical Bug Fixes

    • Database reopen edge case fixed (graceful empty JSON handling)
    • Immediate metadata flush ensures durability
    • Enhanced error messages with JSON preview

  • 📦 New Features

    • Brotli compression for JSON metadata (60-80% size reduction)
    • Backward compatible format detection
    • Zero breaking changes

  • 📊 Quality Metrics

    • 1,468+ tests (was 850+ in v1.3.5)
    • 100% backward compatible
    • All 12 phases production-ready

🚀 Full Feature Set (Phases 1-10 Complete)

  • 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)
    • 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)
    • Lightweight graph traversal

  • Phases 1-5: Core Engine ✅

    • Single-file encrypted database
    • SQL support with advanced query optimization
    • AES-256-GCM encryption
    • ACID transactions with WAL
    • Full-text search

📦 Installation

# Core database (v1.4.1 - NOW WITH METADATA COMPRESSION!)
dotnet add package SharpCoreDB --version 1.4.1

# Distributed features (multi-master replication, 2PC transactions)
dotnet add package SharpCoreDB.Distributed --version 1.4.1

# Analytics engine (100+ aggregate & window functions)
dotnet add package SharpCoreDB.Analytics --version 1.4.1

# Vector search (HNSW indexing, semantic search)
dotnet add package SharpCoreDB.VectorSearch --version 1.4.1

# Sync integration (bidirectional sync with SQL Server/PostgreSQL/MySQL/SQLite)
dotnet add package SharpCoreDB.Provider.Sync --version 1.4.1

# Graph algorithms (A* pathfinding)
dotnet add package SharpCoreDB.Graph --version 1.4.1

# Optional integrations
dotnet add package SharpCoreDB.EntityFrameworkCore --version 1.4.1
dotnet add package SharpCoreDB.Extensions --version 1.4.1
dotnet add package SharpCoreDB.Serilog.Sinks --version 1.4.1

🚀 Performance Benchmarks

Operation SharpCoreDB SQLite Delta
Bulk Insert (1M rows) 2.8s 18.2s 6.5x faster
COUNT (1M rows) 0.8ms 544ms 682x faster
Window Functions 15ms 2.3s 156x faster
Vector Search (10M) 1.2ms 120ms 100x faster
Metadata Compression 24KB → 5.8KB N/A 75% reduction

🎯 Core Features

✅ Production-Ready Capabilities

  • Single-file encrypted database with AES-256-GCM
  • Full SQL support with advanced query optimization
  • ACID transactions with Write-Ahead Logging (WAL)
  • Multi-version concurrency control (MVCC)
  • Automatic indexing (B-tree and hash)

📊 Analytics & Data Processing

  • 100+ aggregate functions
  • Window functions for complex analysis
  • Statistical analysis (STDDEV, VARIANCE, PERCENTILE, CORRELATION)
  • 150-680x faster than SQLite for analytics

🔍 Vector & Semantic Search

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

🌐 Enterprise Distributed Features

  • Multi-master replication across nodes
  • Distributed transactions with 2PC protocol
  • Bidirectional sync with cloud databases
  • Automatic conflict resolution
  • Vector clock-based causality tracking

📱 Cross-Platform Support

  • Windows (x64, ARM64)
  • Linux (x64, ARM64)
  • macOS (x64, ARM64)
  • Android, iOS (via portable library)
  • IoT/Embedded devices

💻 Quick Start

using SharpCoreDB;

// Create encrypted database
var factory = new DatabaseFactory();
var db = factory.Create("myapp.scdb", "master-password");

// Create table and insert data
db.ExecuteSQL("CREATE TABLE users (id INT PRIMARY KEY, name TEXT)");
db.ExecuteSQL("INSERT INTO users VALUES (1, 'Alice')");

// Query with advanced analytics
var results = db.ExecuteQuery(
  "SELECT name, COUNT(*) as count FROM users GROUP BY name"
);

// Persist to disk
db.Flush();

📚 Documentation

🏆 Why SharpCoreDB?

✅ Performance: 6.5x faster than SQLite for bulk operations
✅ Security: AES-256-GCM encryption built-in
✅ Modern: .NET 10 + C# 14 with SIMD acceleration
✅ Enterprise Ready: 1,468+ tests, production-proven
✅ Cross-Platform: Windows, Linux, macOS, ARM64 native
✅ Zero Configuration: Single-file deployment
✅ Advanced Features: Analytics, vector search, distributed transactions

📄 License

MIT License - See LICENSE file

Latest Version: 1.4.1 | Release Date: February 28, 2026 | Status: ✅ Production Ready