Skip to content

Commit f3c7b43

Browse files
author
MPCoreDeveloper
committed
docs
1 parent 6a9819e commit f3c7b43

File tree

49 files changed

+992
-7274
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+992
-7274
lines changed

README.md

Lines changed: 199 additions & 273 deletions
Large diffs are not rendered by default.

audit_markers.txt

Lines changed: 0 additions & 2250 deletions
This file was deleted.

audit_markers_filtered.txt

Lines changed: 0 additions & 207 deletions
This file was deleted.

docs/CHANGELOG.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,22 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
3131
- Explicitly documented the remaining deferred single-file parameterized `ExecuteCompiled` disposal deadlock path.
3232
- **Performance test hardening**: `ColumnStore_Average_10kRecords_Under2ms` now runs 10 iterations and asserts the best (minimum) time, with an additional warmup call. This eliminates false failures caused by concurrent test execution, GC pauses, or OS scheduling jitter.
3333

34+
## [1.7.0] - 2026-04-06
35+
36+
### Added
37+
- `SharpCoreDB.Graph.Advanced` package for advanced graph analytics and GraphRAG workflows.
38+
- Functional package family: `SharpCoreDB.Functional`, `SharpCoreDB.Functional.Dapper`, `SharpCoreDB.Functional.EntityFrameworkCore`.
39+
- Expanded optional package guidance for `SharpCoreDB.EventSourcing`, `SharpCoreDB.Projections`, and `SharpCoreDB.CQRS`.
40+
41+
### Changed
42+
- Ecosystem-wide package version synchronization on `1.7.0`.
43+
- Documentation refresh across root/docs/src package README files with per-project features and v1.7.0 changes.
44+
- SIMD aggregate hot loops updated to `Vector256.LoadUnsafe` pattern in columnar paths.
45+
46+
### Fixed
47+
- SQL lexer/parser reliability for parameterized compiled-query execution.
48+
- Metadata flush/reopen reliability paths with backward-compatible metadata format handling.
49+
3450
## [1.6.0] - 2026-03-30
3551

3652
### 🎉 Major Achievement - Phase 12: GraphRAG Enhancement & Vector Search Integration COMPLETE

docs/FEATURE_MATRIX_v1.7.0.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# SharpCoreDB Feature Matrix (v1.7.0)
2+
3+
This page consolidates the major SharpCoreDB capabilities by package for quick discovery.
4+
5+
## Core platform
6+
7+
| Package | Purpose | Key capabilities in v1.7.0 |
8+
|---|---|---|
9+
| `SharpCoreDB` | Embedded core engine | AES-256-GCM encryption, SQL engine, ACID + WAL, indexing, FTS, SIMD optimizations, metadata durability fixes, compiled-query parser fixes |
10+
| `SharpCoreDB.Server` | Network server runtime | gRPC-first (HTTP/2 + HTTP/3), REST, WebSocket, JWT/RBAC, optional mTLS, multi-database hosting, health/metrics |
11+
| `SharpCoreDB.Client` | .NET client | ADO.NET-style commands/readers, async access, parameterized execution, server connectivity |
12+
13+
## Data access and framework integrations
14+
15+
| Package | Purpose | Key capabilities in v1.7.0 |
16+
|---|---|---|
17+
| `SharpCoreDB.Data.Provider` | ADO.NET provider | `DbConnection`/`DbCommand`/`DbDataReader`, transactions, parameterized queries |
18+
| `SharpCoreDB.EntityFrameworkCore` | EF Core provider | Provider services, query translation components, migration/update SQL generation |
19+
| `SharpCoreDB.Extensions` | Productivity extensions | Dapper helpers, health checks, optional FluentMigrator integration |
20+
| `SharpCoreDB.Provider.YesSql` | YesSql integration | Storage provider components for YesSql/Orchard-style patterns |
21+
| `SharpCoreDB.Serilog.Sinks` | Logging sink | Batch-oriented structured logging into SharpCoreDB |
22+
23+
## Analytics, vector, graph, and GraphRAG
24+
25+
| Package | Purpose | Key capabilities in v1.7.0 |
26+
|---|---|---|
27+
| `SharpCoreDB.Analytics` | Analytical SQL extension | 100+ aggregates, window functions, statistical analysis (`STDDEV`, `VARIANCE`, `PERCENTILE`, `CORRELATION`) |
28+
| `SharpCoreDB.VectorSearch` | Vector retrieval | HNSW indexing, SIMD distance computations, quantization, semantic search workflows |
29+
| `SharpCoreDB.Graph` | Graph traversal engine | BFS/DFS/bidirectional traversal, A* pathfinding, graph query helpers |
30+
| `SharpCoreDB.Graph.Advanced` | Advanced graph analytics + GraphRAG | Community detection, centrality metrics, subgraph analysis, graph-aware ranking, profiling and caching helpers |
31+
32+
## Distributed and synchronization
33+
34+
| Package | Purpose | Key capabilities in v1.7.0 |
35+
|---|---|---|
36+
| `SharpCoreDB.Distributed` | Distributed runtime components | Multi-master replication, vector clocks, streaming replication components, distributed transaction primitives |
37+
| `SharpCoreDB.Provider.Sync` | Dotmim.Sync provider | Sync adapter, tracking/tombstones, metadata/scope builders, provider integration for cloud/offline sync |
38+
39+
## Event-driven optional architecture packages
40+
41+
| Package | Purpose | Key capabilities in v1.7.0 |
42+
|---|---|---|
43+
| `SharpCoreDB.EventSourcing` | Event persistence | Append-only streams, global ordered feed, snapshots, snapshot-aware loading, upcasting hooks |
44+
| `SharpCoreDB.Projections` | Read model projection scaffold | Projection registration/runners, durable checkpoints, background hosted execution, OTel metrics |
45+
| `SharpCoreDB.CQRS` | Command/outbox scaffold | Command handlers/dispatchers, aggregate root base, in-memory/persistent outbox, retry/dead-letter workflows |
46+
47+
## Functional package family (new in v1.7.0 line)
48+
49+
| Package | Purpose | Key capabilities in v1.7.0 |
50+
|---|---|---|
51+
| `SharpCoreDB.Functional` | Functional façade | `Option<T>`, `Fin<T>`, `Seq<T>`, functional-first database APIs |
52+
| `SharpCoreDB.Functional.Dapper` | Functional Dapper adapter | Functional wrappers over Dapper read/write/query patterns |
53+
| `SharpCoreDB.Functional.EntityFrameworkCore` | Functional EF Core adapter | Functional wrappers over `DbContext` workflows |
54+
55+
## Quality and compatibility summary
56+
57+
- `1,490+` tests passing across workspace and targeted suites
58+
- Ecosystem package synchronization on `v1.7.0`
59+
- No intended breaking changes from `v1.5.0` to `v1.7.0`
60+
61+
## Related docs
62+
63+
- `INDEX.md`
64+
- `README.md`
65+
- `release/PHASE12_RELEASE_NOTES.md`
66+
- `../README.md`

docs/INDEX.md

Lines changed: 25 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -6,70 +6,67 @@
66

77
- `../README.md`
88
- `README.md`
9+
- `FEATURE_MATRIX_v1.7.0.md`
910
- `PROJECT_STATUS.md`
1011
- `IMPLEMENTATION_AUDIT_v1.7.0.md`
1112
- `OPEN_ITEMS_v1.7.0.md`
1213
- `release/PHASE12_RELEASE_NOTES.md`
1314

14-
## 2. Server Documentation
15+
## 2. Package Documentation (src)
1516

17+
- `../src/SharpCoreDB/README.md`
18+
- `../src/SharpCoreDB.Server/README.md`
19+
- `../src/SharpCoreDB.Client/README.md`
20+
- `../src/SharpCoreDB.Analytics/README.md`
21+
- `../src/SharpCoreDB.VectorSearch/README.md`
22+
- `../src/SharpCoreDB.Graph/README.md`
23+
- `../src/SharpCoreDB.Graph.Advanced/README.md`
24+
- `../src/SharpCoreDB.Distributed/README.md`
25+
- `../src/SharpCoreDB.Provider.Sync/README.md`
26+
- `../src/SharpCoreDB.EventSourcing/README.md`
27+
- `../src/SharpCoreDB.Projections/README.md`
28+
- `../src/SharpCoreDB.CQRS/README.md`
29+
- `../src/SharpCoreDB.Functional/README.md`
30+
31+
## 3. Server Documentation
32+
33+
- `server/README.md`
1634
- `server/QUICKSTART.md`
1735
- `server/INSTALLATION.md`
1836
- `server/CLIENT_GUIDE.md`
1937
- `server/ADMIN_TOOLING_GUIDE.md`
20-
- `server/ODBC_JDBC_STRATEGY.md`
2138
- `server/REST_API.md`
2239
- `server/BINARY_PROTOCOL_SPEC.md`
2340
- `server/CONFIGURATION_SCHEMA.md`
2441
- `server/SECURITY.md`
2542
- `server/SYSTEM_DATABASES_SECURITY.md`
26-
- `server/EVENT_SOURCING_RFC.md`
27-
- `server/EVENT_STREAM_MODEL_FINAL.md`
2843

29-
## 3. Storage and Engine Internals
44+
## 4. Storage and Engine Internals
3045

3146
- `scdb/README.md`
3247
- `scdb/README_INDEX.md`
3348
- `scdb/PRODUCTION_GUIDE.md`
3449
- `serialization/README.md`
3550
- `serialization/SERIALIZATION_AND_STORAGE_GUIDE.md`
36-
- `serialization/SERIALIZATION_FAQ.md`
37-
- `serialization/BINARY_FORMAT_VISUAL_REFERENCE.md`
3851
- `storage/QUICK_REFERENCE_v1.7.0.md`
3952
- `storage/METADATA_IMPROVEMENTS_v1.7.0.md`
4053

41-
## 4. GraphRAG and Analytics
54+
## 5. GraphRAG, Vector, and Analytics
4255

4356
- `graphrag/00_START_HERE.md`
4457
- `graphrag/README.md`
45-
- `graphrag/LINQ_API_GUIDE.md`
46-
- `graphrag/EF_CORE_COMPLETE_GUIDE.md`
47-
- `graphrag/CUSTOM_HEURISTICS_GUIDE.md`
48-
- `graphrag/METRICS_AND_OBSERVABILITY_GUIDE.md`
4958
- `analytics/README.md`
50-
- `analytics/TUTORIAL.md`
59+
- `Vectors/README.md`
60+
- `performance/graphrag-performance-tuning.md`
5161

52-
## 5. Distributed, Sync, and Migration
62+
## 6. Distributed, Sync, and Migration
5363

5464
- `distributed/README.md`
5565
- `sync/README.md`
56-
- `sync/CHANGELOG.md`
5766
- `migration/README.md`
67+
- `migration/MIGRATION_GUIDE.md`
5868
- `migration/FLUENTMIGRATOR_EMBEDDED_MODE_v1.7.0.md`
5969
- `migration/FLUENTMIGRATOR_SERVER_MODE_v1.7.0.md`
60-
- `migration/MIGRATION_GUIDE.md`
61-
- `migration/SQLITE_VECTORS_TO_SHARPCORE.md`
62-
63-
## 6. Additional References
64-
65-
- `cqrs/README.md`
66-
- `cqrs/QUICKSTART.md`
67-
- `features/advanced-graphrag.md`
68-
- `features/graphrag-enhancement.md`
69-
- `api/SharpCoreDB.Graph.Advanced.API.md`
70-
- `performance/graphrag-performance-tuning.md`
71-
- `proposals/README.md`
72-
- `proposals/ADR_FLUENTMIGRATOR_PACKAGE_PLACEMENT_v1.7.0.md`
7370

7471
## Canonical Documentation Rule
7572

docs/README.md

Lines changed: 19 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,31 @@
11
# SharpCoreDB Documentation
22

3-
This folder contains the maintained documentation set for SharpCoreDB.
3+
This folder contains the maintained documentation set for SharpCoreDB (`v1.7.0`).
44

55
## Start Here
66

77
- `INDEX.md` - Canonical documentation index.
8-
- `PROJECT_STATUS.md` - Current product status for v1.7.0.
9-
- `IMPLEMENTATION_AUDIT_v1.7.0.md` - Repository-wide implementation completeness audit.
10-
- `OPEN_ITEMS_v1.7.0.md` - Repository-wide open points and follow-up tracker.
11-
- `../README.md` - Project overview, features, and installation.
12-
- `release/PHASE12_RELEASE_NOTES.md` - Latest release notes.
8+
- `FEATURE_MATRIX_v1.7.0.md` - Consolidated feature coverage by package.
9+
- `PROJECT_STATUS.md` - Current project status.
10+
- `IMPLEMENTATION_AUDIT_v1.7.0.md` - Repository-wide implementation audit.
11+
- `../README.md` - Product overview and quick start.
1312

1413
## Core Areas
1514

16-
- `server/` - Server operation, security, API, and protocol docs.
17-
- `scdb/` - SCDB format and production guidance.
18-
- `serialization/` - Binary format and storage serialization details.
19-
- `distributed/` - Distributed and replication documentation.
20-
- `sync/` - Sync provider guidance and changelog.
21-
- `graphrag/` - GraphRAG usage and technical guides.
22-
- `analytics/` - Analytics feature documentation.
23-
- `migration/` - Migration guides.
24-
- `proposals/` - Active proposal documents.
15+
- `server/` - Server operation, security, APIs, and protocols.
16+
- `scdb/` - Storage engine and SCDB guidance.
17+
- `serialization/` - Binary format and serialization internals.
18+
- `analytics/` - Analytics capabilities and usage.
19+
- `Vectors/` - Vector search and semantic retrieval.
20+
- `graphrag/` - GraphRAG and advanced graph workflows.
21+
- `distributed/` - Distributed architecture components.
22+
- `sync/` - Dotmim.Sync provider usage.
23+
- `migration/` - Migration and interoperability guides.
24+
25+
## Package Documentation
26+
27+
Per-package docs are maintained in `src/*/README.md` and `src/*/NuGet.README.md`, aligned to `v1.7.0`.
2528

2629
## Cleanup Policy
2730

28-
Obsolete phase-status, kickoff, completion, and superseded planning documents are removed during documentation maintenance. Historical snapshots are not used as canonical product docs.
31+
Obsolete phase-status, kickoff, and superseded planning docs are removed during maintenance. Historical snapshots are not canonical product docs.

docs/Vectors/README.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,17 @@
11
# 🔍 SharpCoreDB Vector Search & Storage
22

3-
> **Status:****PRODUCTION READY** — v1.1.2+
3+
> **Status:****PRODUCTION READY** — v1.7.0
44
> **Module:** `SharpCoreDB.VectorSearch` (optional, separate NuGet)
5-
> **Features:** HNSW indexes, quantization, distance metrics
5+
> **Features:** HNSW indexes, quantization, distance metrics, GraphRAG integration paths
66
> **Performance:** 50-100x faster than SQLite vector search
77
> **Requirements:** .NET 10, C# 14
8-
> **Breaking Changes:** None — 100% backward compatible
8+
> **Breaking Changes:** None — backward compatible
9+
10+
## v1.7.0 changes
11+
12+
- Package/docs synchronized to `v1.7.0`
13+
- Vector workflows aligned with `SharpCoreDB.Graph.Advanced` GraphRAG guidance
14+
- Inherits core metadata/parser reliability improvements from SharpCoreDB v1.7.0
915

1016
---
1117

@@ -67,11 +73,11 @@ This is the foundation for:
6773
### 1. Install the Package
6874

6975
```bash
70-
# Core database (you already have this)
71-
dotnet add package SharpCoreDB --version 1.1.2
76+
# Core database
77+
dotnet add package SharpCoreDB --version 1.7.0
7278

73-
# Vector search extension (optional)
74-
dotnet add package SharpCoreDB.VectorSearch
79+
# Vector search extension
80+
dotnet add package SharpCoreDB.VectorSearch --version 1.7.0
7581
```
7682

7783
### 2. Register Vector Search

docs/analytics/README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
11
# SharpCoreDB Analytics Engine
22

3-
**Version:** 1.3.5 (Phase 9.2)
3+
**Version:** 1.7.0
44
**Status:** Production Ready ✅
55

6+
## v1.7.0 changes
7+
8+
- Package line synchronized to `v1.7.0`
9+
- Analytics docs aligned with the current 100+ aggregate + window-function scope
10+
- Inherits core reliability improvements from SharpCoreDB v1.7.0 (metadata/parser paths)
11+
612
## Overview
713

814
The SharpCoreDB Analytics Engine provides high-performance data aggregation, windowing, and statistical analysis capabilities. Phase 9 includes two major releases:
@@ -26,7 +32,7 @@ The SharpCoreDB Analytics Engine provides high-performance data aggregation, win
2632
### Installation
2733

2834
```bash
29-
dotnet add package SharpCoreDB.Analytics --version 1.3.5
35+
dotnet add package SharpCoreDB.Analytics --version 1.7.0
3036
```
3137

3238
### Basic Aggregation

docs/analytics/TUTORIAL.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Analytics Engine - Complete Tutorial
22

3-
**Version:** 1.3.5 (Phase 9.2)
3+
**Version:** 1.7.0
44

55
## Table of Contents
66

@@ -23,8 +23,8 @@ Create a new console application:
2323
```bash
2424
dotnet new console -n AnalyticsDemo
2525
cd AnalyticsDemo
26-
dotnet add package SharpCoreDB --version 1.3.5
27-
dotnet add package SharpCoreDB.Analytics --version 1.3.5
26+
dotnet add package SharpCoreDB --version 1.7.0
27+
dotnet add package SharpCoreDB.Analytics --version 1.7.0
2828
```
2929

3030
### Dependency Injection Setup

0 commit comments

Comments
 (0)