Database Migration System Documentation
Overview
The migration system is built using TypeORM and provides a robust way to manage database schema changes over time. It supports both forward and backward migrations, ensuring data integrity throughout the application lifecycle.
Table of Contents
- Architecture
- Migration Files
- Migration Operations
- Configuration
- Best Practices
- Error Handling
- Version Control
- Examples
Architecture
Core Components
- Migration Interface: Base interface that all migrations must implement
- QueryRunner: Executes SQL queries and manages database operations
- Database Module: Configures and initializes the migration system
File Structure
libs/database/src/lib/
├── migration/
│ ├── 1650734742695-versionTwoFeatures.ts
│ ├── 1671535821585-preauth.ts
│ └── ...
├── database.module.ts
└── ...
Migration Files