Skip to content

Commit 6002c18

Browse files
committed
docs(README): add section on automated database migrations
- Explain the new database migration system using a versioned approach - Highlight key features like idempotency and generic model support - Describe the date-time based naming convention for migrations - Emphasize the benefits of automated schema evolution for deployments
1 parent 4a27fe2 commit 6002c18

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,14 @@ Click on any category to explore.
9696
- **Secure & Flexible:** Manages all sensitive keys, API credentials, and environment-specific settings through a `.env` file, keeping your secrets out of the codebase.
9797
> **Your Advantage:** Deploy your application across different environments (local, staging, production) safely and efficiently.
9898
99+
---
100+
101+
### 🔄 Automated Database Migrations
102+
- **Versioned Schema Evolution:** Implements a robust, versioned database migration system that automatically applies schema changes to MongoDB on application startup.
103+
- **Idempotent & Generic:** Each migration is idempotent and designed to handle schema evolution for *any* model in the database, ensuring data consistency across deployments.
104+
- **Date-Time Based Versioning:** Migrations are named using a `YYYYMMDDHHMMSS__<description>.dart` format, guaranteeing chronological execution and clear context.
105+
> **Your Advantage:** Say goodbye to manual database updates! Your application gracefully handles schema changes, providing a professional and reliable mechanism for evolving your data models without breaking existing data.
106+
99107
</details>
100108

101109
## 🔑 Licensing

0 commit comments

Comments
 (0)