You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/copilot-instructions.md
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,6 +5,7 @@
5
5
- All project documentation must be written in English. This includes docs, README files, technical specs, implementation plans, and code comments.
6
6
- Provide periodic progress updates while work is ongoing to ensure the assistant is not stuck.
7
7
- 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").
8
9
9
10
## Testing Policy
10
11
- 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.
### ✅ **Production-Ready: ALL Phase 1-11 Features Complete (100%)**
21
21
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.**
23
23
24
24
#### 🎉 **Major Milestone: All Core Features + Server Complete**
25
25
@@ -47,6 +47,11 @@ SharpCoreDB has been successfully transformed from embedded database into a **ne
47
47
48
48
**See documentation:**`docs/INDEX.md`
49
49
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
+
50
55
### 📚 Documentation Policy
51
56
52
57
- 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
59
64
60
65
---
61
66
62
-
#### 🎯 Latest Release (v1.4.0 → v1.4.1)
67
+
#### 🎯 Latest Release (v1.4.0 → v1.5.0)
63
68
64
69
-**🐛 Critical Bug Fixes**
65
70
- Database reopen edge case fixed (graceful empty JSON handling)
@@ -72,7 +77,7 @@ SharpCoreDB has been successfully transformed from embedded database into a **ne
72
77
- Zero breaking changes
73
78
74
79
-**📊 Quality Metrics**
75
-
-**1,468+ tests** (was 850+ in v1.3.5)
80
+
-**1,490+ tests** (was 850+ in v1.3.5)
76
81
-**100% backward compatible**
77
82
-**All 11 phases production-ready**
78
83
@@ -129,29 +134,89 @@ SharpCoreDB has been successfully transformed from embedded database into a **ne
129
134
#### 📦 Installation
130
135
131
136
```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
134
139
135
-
# Server mode (network database server with gRPC/HTTP/WebSocket)
## 🌐 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
0 commit comments