Skip to content

Commit d724fc0

Browse files
author
MPCoreDeveloper
committed
docs: update server-mode messaging and standardize to v1.5.0
- clarify SharpCoreDB as embedded + network database - add explicit server mode guidance in README - add installer/deployment references (Windows/Linux/macOS/Docker) - standardize documentation/version labels to v1.5.0 - rename v1.4.1-named docs to v1.5.0 equivalents
1 parent a0d0167 commit d724fc0

File tree

34 files changed

+545
-697
lines changed

34 files changed

+545
-697
lines changed

.github/CI_STATUS.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -75,42 +75,42 @@ After CI passes on master:
7575

7676
### 2. Publish to NuGet.org
7777
```bash
78-
# Use the correct order (see docs/RELEASE_CHECKLIST_V1.4.1.md)
78+
# Use the correct order (see docs/RELEASE_CHECKLIST_v1.5.0.md)
7979

8080
# Wave 1: Core
81-
dotnet nuget push "SharpCoreDB.1.4.1.nupkg" -k <api-key> -s https://api.nuget.org/v3/index.json
81+
dotnet nuget push "SharpCoreDB.1.5.0.nupkg" -k <api-key> -s https://api.nuget.org/v3/index.json
8282

8383
# Wave 2: Direct dependencies (wait 60 seconds after Wave 1)
84-
dotnet nuget push "SharpCoreDB.Analytics.1.4.1.nupkg" -k <api-key> -s https://api.nuget.org/v3/index.json
85-
dotnet nuget push "SharpCoreDB.Data.Provider.1.4.1.nupkg" -k <api-key> -s https://api.nuget.org/v3/index.json
86-
dotnet nuget push "SharpCoreDB.Extensions.1.4.1.nupkg" -k <api-key> -s https://api.nuget.org/v3/index.json
87-
dotnet nuget push "SharpCoreDB.Graph.1.4.1.nupkg" -k <api-key> -s https://api.nuget.org/v3/index.json
88-
dotnet nuget push "SharpCoreDB.Distributed.1.4.1.nupkg" -k <api-key> -s https://api.nuget.org/v3/index.json
89-
dotnet nuget push "SharpCoreDB.VectorSearch.1.4.1.nupkg" -k <api-key> -s https://api.nuget.org/v3/index.json
90-
dotnet nuget push "SharpCoreDB.Serilog.Sinks.1.4.1.nupkg" -k <api-key> -s https://api.nuget.org/v3/index.json
84+
dotnet nuget push "SharpCoreDB.Analytics.1.5.0.nupkg" -k <api-key> -s https://api.nuget.org/v3/index.json
85+
dotnet nuget push "SharpCoreDB.Data.Provider.1.5.0.nupkg" -k <api-key> -s https://api.nuget.org/v3/index.json
86+
dotnet nuget push "SharpCoreDB.Extensions.1.5.0.nupkg" -k <api-key> -s https://api.nuget.org/v3/index.json
87+
dotnet nuget push "SharpCoreDB.Graph.1.5.0.nupkg" -k <api-key> -s https://api.nuget.org/v3/index.json
88+
dotnet nuget push "SharpCoreDB.Distributed.1.5.0.nupkg" -k <api-key> -s https://api.nuget.org/v3/index.json
89+
dotnet nuget push "SharpCoreDB.VectorSearch.1.5.0.nupkg" -k <api-key> -s https://api.nuget.org/v3/index.json
90+
dotnet nuget push "SharpCoreDB.Serilog.Sinks.1.5.0.nupkg" -k <api-key> -s https://api.nuget.org/v3/index.json
9191

9292
# Wave 3: Multi-dependencies (wait 60 seconds after Wave 2)
93-
dotnet nuget push "SharpCoreDB.Provider.Sync.1.4.1.nupkg" -k <api-key> -s https://api.nuget.org/v3/index.json
94-
dotnet nuget push "SharpCoreDB.Provider.YesSql.1.4.1.nupkg" -k <api-key> -s https://api.nuget.org/v3/index.json
95-
dotnet nuget push "SharpCoreDB.EntityFrameworkCore.1.4.1.nupkg" -k <api-key> -s https://api.nuget.org/v3/index.json
93+
dotnet nuget push "SharpCoreDB.Provider.Sync.1.5.0.nupkg" -k <api-key> -s https://api.nuget.org/v3/index.json
94+
dotnet nuget push "SharpCoreDB.Provider.YesSql.1.5.0.nupkg" -k <api-key> -s https://api.nuget.org/v3/index.json
95+
dotnet nuget push "SharpCoreDB.EntityFrameworkCore.1.5.0.nupkg" -k <api-key> -s https://api.nuget.org/v3/index.json
9696
```
9797

9898
### 3. Create GitHub Release
9999
```bash
100-
git tag v1.4.1
101-
git push origin v1.4.1
100+
git tag v1.5.0
101+
git push origin v1.5.0
102102
```
103103

104104
Then create release on GitHub with:
105-
- Tag: `v1.4.1`
106-
- Title: `SharpCoreDB v1.4.1 - Critical Bug Fixes & Metadata Compression`
107-
- Description: Link to `docs/PROGRESSION_V1.3.5_TO_V1.4.1.md`
105+
- Tag: `v1.5.0`
106+
- Title: `SharpCoreDB v1.5.0 - Critical Bug Fixes & Metadata Compression`
107+
- Description: Link to `docs/PROGRESSION_V1.3.5_TO_v1.5.0.md`
108108

109109
## 🔗 Related Documentation
110110

111-
- [Release Checklist](../docs/RELEASE_CHECKLIST_V1.4.1.md)
112-
- [Version Update Summary](../docs/VERSION_UPDATE_SUMMARY_V1.4.1.md)
113-
- [Progression Report](../docs/PROGRESSION_V1.3.5_TO_V1.4.1.md)
111+
- [Release Checklist](../docs/RELEASE_CHECKLIST_v1.5.0.md)
112+
- [Version Update Summary](../docs/VERSION_UPDATE_SUMMARY_v1.5.0.md)
113+
- [Progression Report](../docs/PROGRESSION_V1.3.5_TO_v1.5.0.md)
114114

115115
## 🐛 Troubleshooting
116116

@@ -123,11 +123,11 @@ Then create release on GitHub with:
123123
- Check test output in GitHub Actions artifacts
124124

125125
### Pack Failures
126-
- Ensure all dependencies are v1.4.1
126+
- Ensure all dependencies are v1.5.0
127127
- Check for missing NuGet.README.md files
128128

129129
---
130130

131131
**Last Updated:** 2026-02-28
132-
**Version:** 1.4.1
132+
**Version:** 1.5.0
133133
**Status:** ✅ Fully Operational with .NET 10 SDK

.github/copilot-instructions.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
- All project documentation must be written in English. This includes docs, README files, technical specs, implementation plans, and code comments.
66
- Provide periodic progress updates while work is ongoing to ensure the assistant is not stuck.
77
- When benchmarking competitor databases (like BLite), document the developer experience (DX) honestly. If a library's API is hard to use, poorly documented, or has mismatches between docs and actual API, note that as a real finding in the benchmark report. User-friendliness and ease of integration matter as much as raw performance numbers.
8+
- Standardize all documentation/version labels to v1.5.0 ("V 1.50").
89

910
## Testing Policy
1011
- All test projects in SharpCoreDB must use **xUnit v3** (`xunit.v3` NuGet package, currently 3.2.2+). **Never** use `xunit` v2 (package id `xunit`). The old v2 package is incompatible with .NET 10 / C# 14.

README.md

Lines changed: 88 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -3,23 +3,23 @@
33

44
# SharpCoreDB
55

6-
**High-Performance Embedded Database for .NET 10**
6+
**High-Performance Embedded & Network Database for .NET 10**
77

88
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
99
[![.NET](https://img.shields.io/badge/.NET-10.0-blue.svg)](https://dotnet.microsoft.com/download)
10-
[![NuGet](https://img.shields.io/badge/NuGet-1.4.1-blue.svg)](https://www.nuget.org/packages/SharpCoreDB)
10+
[![NuGet](https://img.shields.io/badge/NuGet-1.5.0-blue.svg)](https://www.nuget.org/packages/SharpCoreDB)
1111
[![Build](https://img.shields.io/badge/Build-✅_Passing-brightgreen.svg)](https://github.com/MPCoreDeveloper/SharpCoreDB)
12-
[![Tests](https://img.shields.io/badge/Tests-1468+_Passing-brightgreen.svg)](https://github.com/MPCoreDeveloper/SharpCoreDB)
12+
[![Tests](https://img.shields.io/badge/Tests-1490+_Passing-brightgreen.svg)](https://github.com/MPCoreDeveloper/SharpCoreDB)
1313
[![C#](https://img.shields.io/badge/C%23-14-purple.svg)](https://learn.microsoft.com/en-us/dotnet/csharp/)
1414
</div>
1515

1616
---
1717

18-
## 📌 **Current Status — v1.4.1 (March 8, 2026)**
18+
## 📌 **Current Status — v1.5.0 (March 8, 2026)**
1919

2020
### **Production-Ready: ALL Phase 1-11 Features Complete (100%)**
2121

22-
**SharpCoreDB v1.4.1 delivers critical bug fixes, 60-80% metadata compression, enterprise-scale distributed features, and a fully functional network database server.**
22+
**SharpCoreDB v1.5.0 delivers critical bug fixes, 60-80% metadata compression, enterprise-scale distributed features, and a fully functional network database server.**
2323

2424
#### 🎉 **Major Milestone: All Core Features + Server Complete**
2525

@@ -47,6 +47,11 @@ SharpCoreDB has been successfully transformed from embedded database into a **ne
4747

4848
**See documentation:** `docs/INDEX.md`
4949

50+
### ⚠️ Known Deferred Limitation
51+
52+
- `SingleFileDatabase.ExecuteCompiled` with parameterized plans can still hang during disposal in specific shutdown paths.
53+
- Current status: mitigated with safer shutdown ordering; full resolution requires async disposal refactor (`IAsyncDisposable`) in single-file storage provider lifecycle.
54+
5055
### 📚 Documentation Policy
5156

5257
- Canonical documentation entry points are `docs/INDEX.md` and `docs/README.md`.
@@ -59,7 +64,7 @@ SharpCoreDB has been successfully transformed from embedded database into a **ne
5964

6065
---
6166

62-
#### 🎯 Latest Release (v1.4.0 → v1.4.1)
67+
#### 🎯 Latest Release (v1.4.0 → v1.5.0)
6368

6469
- **🐛 Critical Bug Fixes**
6570
- Database reopen edge case fixed (graceful empty JSON handling)
@@ -72,7 +77,7 @@ SharpCoreDB has been successfully transformed from embedded database into a **ne
7277
- Zero breaking changes
7378

7479
- **📊 Quality Metrics**
75-
- **1,468+ tests** (was 850+ in v1.3.5)
80+
- **1,490+ tests** (was 850+ in v1.3.5)
7681
- **100% backward compatible**
7782
- **All 11 phases production-ready**
7883

@@ -129,29 +134,89 @@ SharpCoreDB has been successfully transformed from embedded database into a **ne
129134
#### 📦 Installation
130135

131136
```bash
132-
# Core database (v1.4.1 - NOW WITH METADATA COMPRESSION!)
133-
dotnet add package SharpCoreDB --version 1.4.1
137+
# Core database
138+
dotnet add package SharpCoreDB --version 1.5.0
134139

135-
# Server mode (network database server with gRPC/HTTP/WebSocket)
136-
dotnet add package SharpCoreDB.Server --version 1.4.1
137-
dotnet add package SharpCoreDB.Client --version 1.4.1
140+
# Server mode (network database server)
141+
dotnet add package SharpCoreDB.Server --version 1.5.0
142+
dotnet add package SharpCoreDB.Client --version 1.5.0
138143

139-
# Distributed features (multi-master replication, 2PC transactions)
140-
dotnet add package SharpCoreDB.Distributed --version 1.4.1
144+
# Distributed features
145+
dotnet add package SharpCoreDB.Distributed --version 1.5.0
141146

142-
# Analytics engine (100+ aggregate & window functions)
143-
dotnet add package SharpCoreDB.Analytics --version 1.4.1
147+
# Analytics engine
148+
dotnet add package SharpCoreDB.Analytics --version 1.5.0
144149

145-
# Vector search (HNSW indexing, semantic search)
146-
dotnet add package SharpCoreDB.VectorSearch --version 1.4.1
150+
# Vector search
151+
dotnet add package SharpCoreDB.VectorSearch --version 1.5.0
147152

148-
# Sync integration (bidirectional sync with SQL Server/PostgreSQL/MySQL/SQLite)
149-
dotnet add package SharpCoreDB.Provider.Sync --version 1.4.1
153+
# Sync integration
154+
dotnet add package SharpCoreDB.Provider.Sync --version 1.5.0
150155

151-
# Graph algorithms (A* pathfinding)
152-
dotnet add package SharpCoreDB.Graph --version 1.4.1
156+
# Graph algorithms
157+
dotnet add package SharpCoreDB.Graph --version 1.5.0
153158

154159
# Optional integrations
155-
dotten
160+
dotnet add package SharpCoreDB.EntityFrameworkCore --version 1.5.0
161+
dotnet add package SharpCoreDB.Extensions --version 1.5.0
162+
```
163+
164+
---
165+
166+
## 🌐 Server Mode: Run SharpCoreDB as a Real Network Database Server
167+
168+
SharpCoreDB is no longer only an embedded database. In `Server` mode it can run as a **real multi-database network server** with secure remote access over your LAN, datacenter, or cloud network.
169+
170+
### What you get in Server mode
171+
172+
- **Primary protocol: gRPC (HTTPS, HTTP/2 + HTTP/3)** for high-throughput and streaming scenarios
173+
- **Secondary protocols:** HTTPS REST API and WebSocket streaming
174+
- **Strict security defaults:** TLS 1.2+, JWT auth, optional mTLS, RBAC
175+
- **Multi-database hosting:** system databases + user databases in one server process
176+
- **Production operations:** health checks, metrics, connection pooling, graceful shutdown
177+
178+
### Quick network setup
179+
180+
1. Install packages:
181+
- `SharpCoreDB.Server`
182+
- `SharpCoreDB.Client`
183+
2. Configure TLS certificate and server settings in `appsettings.json`.
184+
3. Start the server:
185+
186+
```bash
187+
dotnet run --project src/SharpCoreDB.Server -c Release
188+
```
189+
190+
4. Verify endpoints:
191+
- Health: `https://localhost:8443/health`
192+
- gRPC endpoint: `https://localhost:5001`
193+
194+
### Installers and deployment options
195+
196+
- **Windows Service installer:** `installers/windows/install-service.ps1`
197+
- **Linux systemd installer:** `installers/linux/install.sh`
198+
- **macOS launchd installer:** `installers/macos/install.sh`
199+
- **Docker / Docker Compose:** `src/SharpCoreDB.Server/docker-compose.yml`
200+
201+
### Server documentation
202+
203+
- Quick start: `docs/server/QUICKSTART.md`
204+
- Installation and installers: `docs/server/INSTALLATION.md`
205+
- Configuration reference: `docs/server/CONFIGURATION_SCHEMA.md`
206+
- Security hardening: `docs/server/SECURITY.md`
207+
- Client usage: `docs/server/CLIENT_GUIDE.md`
208+
209+
---
210+
211+
## 📖 Documentation
212+
213+
Start here:
214+
- `docs/INDEX.md`
215+
- `docs/README.md`
216+
217+
Server-specific:
218+
- `docs/server/README.md`
219+
- `docs/server/QUICKSTART.md`
220+
- `docs/server/INSTALLATION.md`
156221

157222

docs/CHANGELOG.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,19 @@ All notable changes to SharpCoreDB will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8+
## [Unreleased]
9+
10+
### Fixed
11+
- Unified `IS NULL` / `IS NOT NULL` behavior across runtime scan, join-helper, and compiled predicate paths.
12+
- Added parser support for scalar function expressions in SELECT columns (including `COALESCE(...)`) and parenthesized subquery expressions.
13+
- Improved `EnhancedSqlParser` malformed SQL detection by flagging unparsed trailing content via `HasErrors`.
14+
- Added LINQ translator handling for `ExpressionType.Convert` / `ConvertChecked` in enum-related comparison scenarios.
15+
- Improved German locale comparison behavior for `ß/ss` equivalence in locale-aware matching.
16+
17+
### Changed
18+
- Updated project documentation and status reports to reflect current implementation and validation baseline.
19+
- Explicitly documented the remaining deferred single-file parameterized `ExecuteCompiled` disposal deadlock path.
20+
821
## [1.5.0] - 2026-03-30
922

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

docs/DOCUMENTATION_AUDIT_2026.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# SharpCoreDB Documentation Audit - January 2026
22

33
**Audit Date:** January 28, 2026
4-
**Version:** v1.4.1
4+
**Version:** v1.5.0
55
**Total Documentation Files:** 116 markdown files
66
**Status:** Comprehensive cleanup required
77

@@ -241,8 +241,8 @@ docs/analytics/TUTORIAL.md → Keep as-is (excellent)
241241
docs/sync/README.md → Add "production ready" badge
242242
docs/Vectors/TECHNICAL_SPEC.md → Keep as API reference
243243
docs/migration/MIGRATION_GUIDE.md → Keep as-is
244-
src/SharpCoreDB.Analytics/README.md → Update version to 1.4.1
245-
src/SharpCoreDB.VectorSearch/README.md → Update version to 1.4.1
244+
src/SharpCoreDB.Analytics/README.md → Update version to 1.5.0
245+
src/SharpCoreDB.VectorSearch/README.md → Update version to 1.5.0
246246
src/SharpCoreDB.Graph/README.md → Add GraphRAG status section
247247
src/SharpCoreDB.Provider.Sync/README.md → Add production status
248248
```
@@ -288,7 +288,7 @@ src/SharpCoreDB.Distributed/README.md
288288

289289
4. **Up-to-Date Package READMEs**
290290
- All 10+ packages have accurate README.md
291-
- Consistent versioning (v1.4.1)
291+
- Consistent versioning (v1.5.0)
292292

293293
5. **No Broken Links**
294294
- All internal links resolve correctly

0 commit comments

Comments
 (0)