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
docs: Add cross-references between README, Database Management Guide, and Compatibility Matrix
- Link Quick Start Guide from README First Run section
- Add Database Management Guide link in README System Requirements
- Link Compatibility Matrix from Database Management Guide schema version sections
- Link Compatibility Matrix from auto-migration and version upgrade sections
- Improve documentation navigation and version compatibility awareness
Copy file name to clipboardExpand all lines: Documentation/Database-Management-Guide.md
+15-7Lines changed: 15 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -114,10 +114,15 @@ When you upgrade Aquiis SimpleStart to a new version:
114
114
115
115
**No manual intervention required** - migrations are automatic and seamless!
116
116
117
+
**Version Upgrade Compatibility:**
118
+
Not all version upgrades are supported automatically. Check the **[Compatibility Matrix](Compatibility-Matrix.md)** before upgrading to see if your current version can auto-migrate to the target version, or if manual steps are required.
119
+
117
120
#### Migration to v1.1.0
118
121
119
122
When upgrading from v1.0.0 to v1.1.0, the following schema changes are automatically applied:
120
123
124
+
> **Note:** For complete version compatibility information and upgrade paths, see the **[Compatibility Matrix](Compatibility-Matrix.md)**.
125
+
121
126
**New Tables:**
122
127
123
128
-**DatabaseSettings** - Tracks encryption state and configuration
@@ -150,6 +155,9 @@ When upgrading from v1.0.0 to v1.1.0, the following schema changes are automatic
150
155
151
156
**Important:** v1.1.0 application **requires** v1.1.0 database schema - the DatabaseSettings table is queried on startup. Running v1.1.0 app with v1.0.0 database will result in an error.
152
157
158
+
**Version Compatibility:**
159
+
See the **[Compatibility Matrix](Compatibility-Matrix.md)** for detailed information about which app versions work with which database versions, and whether automatic migration is available.
160
+
153
161
---
154
162
155
163
## 🔐 Backup Procedures
@@ -972,13 +980,13 @@ The compiled model lives in `1-Aquiis.Infrastructure/Data/CompiledModels/` and i
972
980
973
981
**When to regenerate the compiled model:**
974
982
975
-
| Change | Re-run optimize? |
976
-
|---|---|
977
-
| Add / remove entity or property | ✅ Yes |
978
-
| Add / modify relationship or index | ✅ Yes |
979
-
| Rename entity or property | ✅ Yes |
980
-
| Data-only migration (seed data, no schema change) | ❌ No |
0 commit comments