This repository has been archived on 2025-08-03. You can view files and clone it, but cannot push or open issues or pull requests.
network-orbit/docs/docs/api/migration-manager.md
anonpenguin f183015f47 Add comprehensive documentation for decorators, migration, and relationships in DebrosFramework
- Introduced hook decorators for lifecycle methods in models.
- Documented @Model decorator for model configuration.
- Added relationship decorators for defining model relationships.
- Created MigrationBuilder and MigrationManager documentation for schema migrations.
- Added QueryExecutor and RelationshipManager documentation for query execution and relationship handling.
- Included examples for complex queries and migration scenarios.
- Developed a social platform example showcasing model relationships and application structure.
- Enhanced contributing guidelines with community, documentation, and release processes.
- Established testing guidelines for unit and integration tests.
2025-07-09 16:43:01 +03:00

1.2 KiB

sidebar_position
sidebar_position
7

MigrationManager

The MigrationManager handles database schema migrations and data transformations in DebrosFramework.

Overview

The MigrationManager provides tools for evolving database schemas over time, handling version control, and performing data transformations during migrations.

Class Definition

class MigrationManager {
  constructor(
    private databaseManager: DatabaseManager,
    private configManager: ConfigManager
  );
}

Core Methods

Migration Management

runMigration(migration)

Executes a migration.

async runMigration(migration: Migration): Promise<void>

Parameters:

  • migration - The migration to execute

Example:

await migrationManager.runMigration(addUserProfileMigration);

Migration History

getPendingMigrations()

Gets all pending migrations.

async getPendingMigrations(): Promise<Migration[]>

Returns: Promise resolving to array of pending migrations