INDEX.md

SharpCoreDB Documentation Index

Version: 1.4.1 (Phase 10 Complete + Critical Fixes)
Status: Production Ready ✅

Welcome to SharpCoreDB documentation! This page helps you find the right documentation for your use case.

---

🚨 Latest Updates (v1.4.1 - Feb 20, 2026)

Critical Fixes & Improvements

• Quick Reference v1.4.1 - TL;DR of critical fixes
• Metadata Improvements - Complete technical guide
• Progression v1.3.5 → v1.4.1 - All changes since v1.3.5
• Changelog - Full version history

Summary: Database reopen bug fixed + 60-80% metadata compression. Upgrade immediately. ✅

---

🚀 Getting Started

Start here if you're new to SharpCoreDB:

1. README.md - Project overview and quick start
2. Installation Guide - Setup instructions
3. Quick Start Examples - Common use cases

---

📚 Documentation by Feature

Core Database Engine

Document	Topics
User Manual	Complete feature guide, all APIs
src/SharpCoreDB/README.md	Core engine documentation
Storage Architecture	ACID, transactions, WAL
Serialization Format	Data format specification
Metadata Improvements v1.4.1 🆕	JSON compression & edge cases

📊 Analytics Engine (Phase 9)

Document	Topics
Analytics Overview	Phase 9 features, aggregates, window functions
Analytics Tutorial	Complete tutorial with examples
src/SharpCoreDB.Analytics/README.md	Package documentation
New in Phase 9.2:	STDDEV, VARIANCE, PERCENTILE, CORRELATION
New in Phase 9.1:	COUNT, SUM, AVG, ROW_NUMBER, RANK

🔍 Vector Search (Phase 8)

Document	Topics
Vector Search Overview	HNSW indexing, semantic search
Vector Search Guide	Implementation details
src/SharpCoreDB.VectorSearch/README.md	Package documentation
Features:	SIMD acceleration, 50-100x faster than SQLite

📈 Graph Algorithms (Phase 6.2)

Document	Topics
Graph Algorithms Overview	A* pathfinding, 30-50% improvement
src/SharpCoreDB.Graph/README.md	Package documentation

🌍 Collation & Internationalization

Document	Topics
Collation Guide	Language-aware string comparison
Locale Support	Supported locales and configuration

💾 BLOB Storage

Document	Topics
BLOB Storage Guide	3-tier storage (inline/overflow/filestream)

⏰ Time-Series

Document	Topics
Time-Series Guide	Compression, bucketing, downsampling

🔐 Security & Encryption

Document	Topics
Encryption Configuration	AES-256-GCM setup
Security Best Practices	Deployment guidelines

🏗️ Architecture

Document	Topics
Architecture Overview	System design, components
Query Plan Cache	Optimization details
Index Implementation	B-tree and hash indexes

🔄 Distributed Features (NEW - Phase 10)

Document	Topics
Distributed Overview	Multi-master replication, sharding, conflict resolution
Dotmim.Sync Integration	Bidirectional sync with SQL Server/PostgreSQL
src/SharpCoreDB.Distributed/README.md	Distributed package documentation
src/SharpCoreDB.Provider.Sync/README.md	Sync provider documentation
New in Phase 10.3:	Distributed transactions, 2PC protocol
New in Phase 10.2:	Multi-master replication, vector clocks
New in Phase 10.1:	Dotmim.Sync integration, enterprise sync

---

🔧 By Use Case

Building a RAG System

1. Start: Vector Search Overview
2. Setup: Vector Search Guide
3. Integrate: Vector package docs

Real-Time Analytics Dashboard

1. Setup: Analytics Overview
2. Tutorial: Analytics Complete Guide
3. Examples: Analytics package docs

High-Volume Data Processing

1. Foundation: Storage Architecture
2. BLOB Storage: BLOB Storage Guide
3. Batch Operations: User Manual - Batch Operations

Multi-Language Application

1. Collation: Collation Guide
2. Locales: Locale Support
3. Setup: User Manual - Collation Section

Graph-Based Applications

1. Overview: Graph Algorithms
2. Implementation: Graph package docs
3. Examples: Graph tutorial

---

📋 Installation & Setup

Quick Install

# Core database
dotnet add package SharpCoreDB --version 1.4.1

# Add features as needed
dotnet add package SharpCoreDB.Analytics --version 1.4.1
dotnet add package SharpCoreDB.VectorSearch --version 1.4.1
dotnet add package SharpCoreDB.Graph --version 1.4.1

Full Setup Guide

See USER_MANUAL.md for detailed installation instructions.

---

🚀 Quick Start

Example 1: Basic Database

using SharpCoreDB;

var services = new ServiceCollection();
services.AddSharpCoreDB();
var database = services.BuildServiceProvider().GetRequiredService<IDatabase>();

// Create table
await database.ExecuteAsync(
    "CREATE TABLE users (id INT PRIMARY KEY, name TEXT)"
);

// Insert data
await database.ExecuteAsync(
    "INSERT INTO users VALUES (1, 'Alice')"
);

// Query
var users = await database.QueryAsync("SELECT * FROM users");

Example 2: Analytics with Aggregates

using SharpCoreDB.Analytics;

// Statistical analysis
var stats = await database.QueryAsync(@"
    SELECT 
        COUNT(*) as total,
        AVG(salary) as avg_salary,
        STDDEV(salary) as salary_stddev,
        PERCENTILE(salary, 0.75) as top_25_percent
    FROM employees
");

Example 3: Vector Search

using SharpCoreDB.VectorSearch;

// Semantic search
var results = await database.QueryAsync(@"
    SELECT title, vec_distance_cosine(embedding, ?) AS distance
    FROM documents
    ORDER BY distance ASC
    LIMIT 10
", [queryEmbedding]);

Example 4: Graph Algorithms

using SharpCoreDB.Graph;

// A* pathfinding
var path = await graphEngine.FindPathAsync(
    start: "NodeA",
    end: "NodeZ",
    algorithm: PathfindingAlgorithm.AStar
);

---

📖 Project-Specific Documentation

Packages

Package	README
SharpCoreDB (Core)	src/SharpCoreDB/README.md
SharpCoreDB.Analytics	src/SharpCoreDB.Analytics/README.md
SharpCoreDB.VectorSearch	src/SharpCoreDB.VectorSearch/README.md
SharpCoreDB.Graph	src/SharpCoreDB.Graph/README.md
SharpCoreDB.Extensions	src/SharpCoreDB.Extensions/README.md
SharpCoreDB.EntityFrameworkCore	src/SharpCoreDB.EntityFrameworkCore/README.md

Project-Specific READMEs

• src/SharpCoreDB/README.md - Core database
• src/SharpCoreDB.Analytics/README.md - Analytics engine
• src/SharpCoreDB.VectorSearch/README.md - Vector search
• src/SharpCoreDB.Graph/README.md - Graph algorithms
• src/SharpCoreDB.EntityFrameworkCore/README.md - EF Core provider
• examples/README.md - Complete examples collection

---

📊 Changelog & Release Notes

Version	Document	Notes
1.3.5	CHANGELOG.md	Phase 9.2 analytics complete
1.3.0	RELEASE_NOTES_v1.3.0.md	Base version
Phase 8	RELEASE_NOTES_v6.4.0_PHASE8.md	Vector search
Phase 9	RELEASE_NOTES_v6.5.0_PHASE9.md	Analytics

---

🎯 Development & Contributing

Document	Purpose
CONTRIBUTING.md	Contribution guidelines
CODING_STANDARDS_CSHARP14.md	Code style requirements
PROJECT_STATUS.md	Current phase status

---

🔍 Search Documentation

By Topic

• SQL Operations: USER_MANUAL.md
• Performance: PERFORMANCE.md
• Architecture: architecture/README.md
• Benchmarks: BENCHMARK_RESULTS.md

By Problem

• Slow queries? → PERFORMANCE.md
• Vector search setup? → vectors/README.md
• Analytics queries? → analytics/TUTORIAL.md
• Multi-language? → collation/README.md
• Build large files? → storage/BLOB_STORAGE.md

---

📞 Support & Resources

Documentation

• Main Documentation: docs/ folder
• API Documentation: Within each package README

Getting Help

• Issues: GitHub Issues
• Discussions: GitHub Discussions
• Contributing: CONTRIBUTING.md

---

🗂️ Directory Structure

docs/
├── INDEX.md                            # Navigation (you are here)
├── USER_MANUAL.md                      # Complete feature guide
├── CHANGELOG.md                        # Version history
├── PERFORMANCE.md                      # Performance tuning
│
├── analytics/                          # Phase 9 Analytics Engine
│   ├── README.md                       # Overview & quick start
│   └── TUTORIAL.md                     # Complete tutorial
│
├── vectors/                            # Phase 8 Vector Search
│   ├── README.md                       # Overview
│   └── IMPLEMENTATION.md               # Implementation guide
│
├── graph/                              # Phase 6.2 Graph Algorithms
│   ├── README.md                       # Overview
│   └── TUTORIAL.md                     # Examples
│
├── collation/                          # Internationalization
│   ├── README.md                       # Collation guide
│   └── LOCALE_SUPPORT.md               # Locale list
│
├── storage/                            # Storage architecture
│   ├── README.md                       # Storage overview
│   ├── BLOB_STORAGE.md                 # BLOB storage details
│   └── SERIALIZATION.md                # Data format
│
├── architecture/                       # System design
│   ├── README.md                       # Architecture overview
│   ├── ENCRYPTION.md                   # Security
│   ├── INDEXING.md                     # Index details
│   └── SECURITY.md                     # Best practices
│
└── features/                           # Feature guides
    └── TIMESERIES.md                   # Time-series operations

---

✅ Checklist: Getting Started

• Read README.md for overview
• Install packages via NuGet
• Run Quick Start Examples
• Read USER_MANUAL.md for your feature
• Check PERFORMANCE.md for optimization
• Review CONTRIBUTING.md if contributing

---

Last Updated: February 19, 2026 | Version: 1.4.0 (Phase 10)

For questions or issues, please open an issue on GitHub.