59 lines
18 KiB
Markdown
59 lines
18 KiB
Markdown
# @suaveplan/migration - Database-agnostic migration runner with ledger tracking, dry-run, checksums, lock adapters, and OTel instrumentation
|
|
|
|
## Summary
|
|
|
|
Database-agnostic schema migration runner with ledger tracking, checksum validation, dry-run reporting, distributed locking, event bus integration, and OTel instrumentation.
|
|
|
|
<!-- begin:auto-docs -->
|
|
## Documentation tree
|
|
|
|
- [surrealdb](./src/adapters/surrealdb/surrealdb.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
|
|
- [surrealdb](./src/adapters/surrealdb/surrealdb.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
|
|
- [batch-migrator](./src/batch/batch-migrator/batch-migrator.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
|
|
- [batch-migrator](./src/batch/batch-migrator/batch-migrator.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
|
|
- [errors](./src/errors/migration-error.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
|
|
- [migration-error](./src/errors/migration-error.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
|
|
- [distributed-lock](./src/lock/distributed-lock/distributed-lock.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
|
|
- [distributed-lock](./src/lock/distributed-lock/distributed-lock.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
|
|
- [memory-lock](./src/lock/memory-lock/memory-lock.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
|
|
- [memory-lock](./src/lock/memory-lock/memory-lock.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
|
|
- [redis-lock](./src/lock/redis-lock/redis-lock.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
|
|
- [redis-lock](./src/lock/redis-lock/redis-lock.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
|
|
- [migration-planner](./src/planner/migration-planner/migration-planner.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
|
|
- [migration-planner](./src/planner/migration-planner/migration-planner.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
|
|
- [dry-run-reporter](./src/runner/dry-run-reporter/dry-run-reporter.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
|
|
- [dry-run-reporter](./src/runner/dry-run-reporter/dry-run-reporter.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
|
|
- [migration-executor](./src/runner/migration-executor/migration-executor.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
|
|
- [migration-executor](./src/runner/migration-executor/migration-executor.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
|
|
- [migration-runner](./src/runner/migration-runner/migration-runner.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
|
|
- [migration-runner](./src/runner/migration-runner/migration-runner.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
|
|
- [schemas](./src/schemas/migration.schemas.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
|
|
- [migration.schemas](./src/schemas/migration.schemas.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
|
|
- [migration-status](./src/status/migration-status/migration-status.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
|
|
- [migration-status](./src/status/migration-status/migration-status.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
|
|
- [database-store](./src/store/database-store/database-store.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
|
|
- [database-store](./src/store/database-store/database-store.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
|
|
- [memory-store](./src/store/memory-store/memory-store.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
|
|
- [memory-store](./src/store/memory-store/memory-store.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
|
|
- [utils](./src/utils/checksum.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
|
|
- [checksum](./src/utils/checksum.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
|
|
<!-- end:auto-docs --> - [surrealdb](./src/adapters/surrealdb/surrealdb.md) — <!-- begin:auto-docs --> _(no submodules)_- [batch-migrator](./src/batch/batch-migrator/batch-migrator.md) — <!-- begin:auto-docs --> _(no submodules)_- [batch-migrator](./src/batch/batch-migrator/batch-migrator.md) — <!-- begin:auto-docs --> _(no submodules)_- [errors](./src/errors/migration-error.md) — <!-- begin:auto-docs --> _(no submodules)_- [migration-error](./src/errors/migration-error.md) — <!-- begin:auto-docs --> _(no submodules)_- [distributed-lock](./src/lock/distributed-lock/distributed-lock.md) — <!-- begin:auto-docs --> _(no submodules)_- [distributed-lock](./src/lock/distributed-lock/distributed-lock.md) — <!-- begin:auto-docs --> _(no submodules)_- [memory-lock](./src/lock/memory-lock/memory-lock.md) — <!-- begin:auto-docs --> _(no submodules)_- [memory-lock](./src/lock/memory-lock/memory-lock.md) — <!-- begin:auto-docs --> _(no submodules)_- [redis-lock](./src/lock/redis-lock/redis-lock.md) — <!-- begin:auto-docs --> _(no submodules)_- [redis-lock](./src/lock/redis-lock/redis-lock.md) — <!-- begin:auto-docs --> _(no submodules)_- [migration-planner](./src/planner/migration-planner/migration-planner.md) — <!-- begin:auto-docs --> _(no submodules)_- [migration-planner](./src/planner/migration-planner/migration-planner.md) — <!-- begin:auto-docs --> _(no submodules)_- [dry-run-reporter](./src/runner/dry-run-reporter/dry-run-reporter.md) — <!-- begin:auto-docs --> _(no submodules)_- [dry-run-reporter](./src/runner/dry-run-reporter/dry-run-reporter.md) — <!-- begin:auto-docs --> _(no submodules)_- [migration-executor](./src/runner/migration-executor/migration-executor.md) — <!-- begin:auto-docs --> _(no submodules)_- [migration-executor](./src/runner/migration-executor/migration-executor.md) — <!-- begin:auto-docs --> _(no submodules)_- [migration-runner](./src/runner/migration-runner/migration-runner.md) — <!-- begin:auto-docs --> _(no submodules)_- [migration-runner](./src/runner/migration-runner/migration-runner.md) — <!-- begin:auto-docs --> _(no submodules)_- [schemas](./src/schemas/migration.schemas.md) — <!-- begin:auto-docs --> _(no submodules)_- [migration.schemas](./src/schemas/migration.schemas.md) — <!-- begin:auto-docs --> _(no submodules)_- [migration-status](./src/status/migration-status/migration-status.md) — <!-- begin:auto-docs --> _(no submodules)_- [migration-status](./src/status/migration-status/migration-status.md) — <!-- begin:auto-docs --> _(no submodules)_- [database-store](./src/store/database-store/database-store.md) — <!-- begin:auto-docs --> _(no submodules)_- [database-store](./src/store/database-store/database-store.md) — <!-- begin:auto-docs --> _(no submodules)_- [memory-store](./src/store/memory-store/memory-store.md) — <!-- begin:auto-docs --> _(no submodules)_- [memory-store](./src/store/memory-store/memory-store.md) — <!-- begin:auto-docs --> _(no submodules)_- [utils](./src/utils/checksum.md) — <!-- begin:auto-docs --> _(no submodules)_- [checksum](./src/utils/checksum.md) — <!-- begin:auto-docs --> _(no submodules)_- [surrealdb](./src/adapters/surrealdb/surrealdb.md) — <!-- begin:auto-docs --> _(no submodules)_- [batch-migrator](./src/batch/batch-migrator/batch-migrator.md) — <!-- begin:auto-docs --> _(no submodules)_- [batch-migrator](./src/batch/batch-migrator/batch-migrator.md) — <!-- begin:auto-docs --> _(no submodules)_- [errors](./src/errors/migration-error.md) — <!-- begin:auto-docs --> _(no submodules)_- [migration-error](./src/errors/migration-error.md) — <!-- begin:auto-docs --> _(no submodules)_- [distributed-lock](./src/lock/distributed-lock/distributed-lock.md) — <!-- begin:auto-docs --> _(no submodules)_- [distributed-lock](./src/lock/distributed-lock/distributed-lock.md) — <!-- begin:auto-docs --> _(no submodules)_- [memory-lock](./src/lock/memory-lock/memory-lock.md) — <!-- begin:auto-docs --> _(no submodules)_- [memory-lock](./src/lock/memory-lock/memory-lock.md) — <!-- begin:auto-docs --> _(no submodules)_- [redis-lock](./src/lock/redis-lock/redis-lock.md) — <!-- begin:auto-docs --> _(no submodules)_- [redis-lock](./src/lock/redis-lock/redis-lock.md) — <!-- begin:auto-docs --> _(no submodules)_- [migration-planner](./src/planner/migration-planner/migration-planner.md) — <!-- begin:auto-docs --> _(no submodules)_- [migration-planner](./src/planner/migration-planner/migration-planner.md) — <!-- begin:auto-docs --> _(no submodules)_- [dry-run-reporter](./src/runner/dry-run-reporter/dry-run-reporter.md) — <!-- begin:auto-docs --> _(no submodules)_- [dry-run-reporter](./src/runner/dry-run-reporter/dry-run-reporter.md) — <!-- begin:auto-docs --> _(no submodules)_- [migration-executor](./src/runner/migration-executor/migration-executor.md) — <!-- begin:auto-docs --> _(no submodules)_- [migration-executor](./src/runner/migration-executor/migration-executor.md) — <!-- begin:auto-docs --> _(no submodules)_- [migration-runner](./src/runner/migration-runner/migration-runner.md) — <!-- begin:auto-docs --> _(no submodules)_- [migration-runner](./src/runner/migration-runner/migration-runner.md) — <!-- begin:auto-docs --> _(no submodules)_- [schemas](./src/schemas/migration.schemas.md) — <!-- begin:auto-docs --> _(no submodules)_- [migration.schemas](./src/schemas/migration.schemas.md) — <!-- begin:auto-docs --> _(no submodules)_- [migration-status](./src/status/migration-status/migration-status.md) — <!-- begin:auto-docs --> _(no submodules)_- [migration-status](./src/status/migration-status/migration-status.md) — <!-- begin:auto-docs --> _(no submodules)_- [database-store](./src/store/database-store/database-store.md) — <!-- begin:auto-docs --> _(no submodules)_- [database-store](./src/store/database-store/database-store.md) — <!-- begin:auto-docs --> _(no submodules)_- [memory-store](./src/store/memory-store/memory-store.md) — <!-- begin:auto-docs --> _(no submodules)_- [memory-store](./src/store/memory-store/memory-store.md) — <!-- begin:auto-docs --> _(no submodules)_- [utils](./src/utils/checksum.md) — <!-- begin:auto-docs --> _(no submodules)_- [checksum](./src/utils/checksum.md) — <!-- begin:auto-docs --> _(no submodules)_- [surrealdb](./src/adapters/surrealdb/surrealdb.md) — <!-- begin:auto-docs --> _(no submodules)_- [batch-migrator](./src/batch/batch-migrator/batch-migrator.md) — <!-- begin:auto-docs --> _(no submodules)_- [batch-migrator](./src/batch/batch-migrator/batch-migrator.md) — <!-- begin:auto-docs --> _(no submodules)_- [errors](./src/errors/migration-error.md) — <!-- begin:auto-docs --> _(no submodules)_- [migration-error](./src/errors/migration-error.md) — <!-- begin:auto-docs --> _(no submodules)_- [distributed-lock](./src/lock/distributed-lock/distributed-lock.md) — <!-- begin:auto-docs --> _(no submodules)_- [distributed-lock](./src/lock/distributed-lock/distributed-lock.md) — <!-- begin:auto-docs --> _(no submodules)_- [memory-lock](./src/lock/memory-lock/memory-lock.md) — <!-- begin:auto-docs --> _(no submodules)_- [memory-lock](./src/lock/memory-lock/memory-lock.md) — <!-- begin:auto-docs --> _(no submodules)_- [redis-lock](./src/lock/redis-lock/redis-lock.md) — <!-- begin:auto-docs --> _(no submodules)_- [redis-lock](./src/lock/redis-lock/redis-lock.md) — <!-- begin:auto-docs --> _(no submodules)_- [migration-planner](./src/planner/migration-planner/migration-planner.md) — <!-- begin:auto-docs --> _(no submodules)_- [migration-planner](./src/planner/migration-planner/migration-planner.md) — <!-- begin:auto-docs --> _(no submodules)_- [dry-run-reporter](./src/runner/dry-run-reporter/dry-run-reporter.md) — <!-- begin:auto-docs --> _(no submodules)_- [dry-run-reporter](./src/runner/dry-run-reporter/dry-run-reporter.md) — <!-- begin:auto-docs --> _(no submodules)_- [migration-executor](./src/runner/migration-executor/migration-executor.md) — <!-- begin:auto-docs --> _(no submodules)_- [migration-executor](./src/runner/migration-executor/migration-executor.md) — <!-- begin:auto-docs --> _(no submodules)_- [migration-runner](./src/runner/migration-runner/migration-runner.md) — <!-- begin:auto-docs --> _(no submodules)_- [migration-runner](./src/runner/migration-runner/migration-runner.md) — <!-- begin:auto-docs --> _(no submodules)_- [schemas](./src/schemas/migration.schemas.md) — <!-- begin:auto-docs --> _(no submodules)_- [migration.schemas](./src/schemas/migration.schemas.md) — <!-- begin:auto-docs --> _(no submodules)_- [migration-status](./src/status/migration-status/migration-status.md) — <!-- begin:auto-docs --> _(no submodules)_- [migration-status](./src/status/migration-status/migration-status.md) — <!-- begin:auto-docs --> _(no submodules)_- [database-store](./src/store/database-store/database-store.md) — <!-- begin:auto-docs --> _(no submodules)_- [database-store](./src/store/database-store/database-store.md) — <!-- begin:auto-docs --> _(no submodules)_- [memory-store](./src/store/memory-store/memory-store.md) — <!-- begin:auto-docs --> _(no submodules)_- [memory-store](./src/store/memory-store/memory-store.md) — <!-- begin:auto-docs --> _(no submodules)_- [utils](./src/utils/checksum.md) — <!-- begin:auto-docs --> _(no submodules)_- [checksum](./src/utils/checksum.md) — <!-- begin:auto-docs --> _(no submodules)_- [surrealdb](./src/adapters/surrealdb/surrealdb.md) — <!-- begin:auto-docs --> _(no submodules)_- [batch-migrator](./src/batch/batch-migrator/batch-migrator.md) — <!-- begin:auto-docs --> _(no submodules)_ - [batch-migrator](./src/batch/batch-migrator/batch-migrator.md) — <!-- begin:auto-docs --> _(no submodules)_- [errors](./src/errors/migration-error.md) — <!-- begin:auto-docs --> _(no submodules)_ - [migration-error](./src/errors/migration-error.md) — <!-- begin:auto-docs --> _(no submodules)_- [distributed-lock](./src/lock/distributed-lock/distributed-lock.md) — <!-- begin:auto-docs --> _(no submodules)_ - [distributed-lock](./src/lock/distributed-lock/distributed-lock.md) — <!-- begin:auto-docs --> _(no submodules)_- [memory-lock](./src/lock/memory-lock/memory-lock.md) — <!-- begin:auto-docs --> _(no submodules)_ - [memory-lock](./src/lock/memory-lock/memory-lock.md) — <!-- begin:auto-docs --> _(no submodules)_- [redis-lock](./src/lock/redis-lock/redis-lock.md) — <!-- begin:auto-docs --> _(no submodules)_ - [redis-lock](./src/lock/redis-lock/redis-lock.md) — <!-- begin:auto-docs --> _(no submodules)_- [migration-planner](./src/planner/migration-planner/migration-planner.md) — <!-- begin:auto-docs --> _(no submodules)_ - [migration-planner](./src/planner/migration-planner/migration-planner.md) — <!-- begin:auto-docs --> _(no submodules)_- [dry-run-reporter](./src/runner/dry-run-reporter/dry-run-reporter.md) — <!-- begin:auto-docs --> _(no submodules)_ - [dry-run-reporter](./src/runner/dry-run-reporter/dry-run-reporter.md) — <!-- begin:auto-docs --> _(no submodules)_- [migration-executor](./src/runner/migration-executor/migration-executor.md) — <!-- begin:auto-docs --> _(no submodules)_ - [migration-executor](./src/runner/migration-executor/migration-executor.md) — <!-- begin:auto-docs --> _(no submodules)_- [migration-runner](./src/runner/migration-runner/migration-runner.md) — <!-- begin:auto-docs --> _(no submodules)_ - [migration-runner](./src/runner/migration-runner/migration-runner.md) — <!-- begin:auto-docs --> _(no submodules)_- [schemas](./src/schemas/migration.schemas.md) — <!-- begin:auto-docs --> _(no submodules)_ - [migration.schemas](./src/schemas/migration.schemas.md) — <!-- begin:auto-docs --> _(no submodules)_- [migration-status](./src/status/migration-status/migration-status.md) — <!-- begin:auto-docs --> _(no submodules)_ - [migration-status](./src/status/migration-status/migration-status.md) — <!-- begin:auto-docs --> _(no submodules)_- [database-store](./src/store/database-store/database-store.md) — <!-- begin:auto-docs --> _(no submodules)_ - [database-store](./src/store/database-store/database-store.md) — <!-- begin:auto-docs --> _(no submodules)_- [memory-store](./src/store/memory-store/memory-store.md) — <!-- begin:auto-docs --> _(no submodules)_ - [memory-store](./src/store/memory-store/memory-store.md) — <!-- begin:auto-docs --> _(no submodules)_- [utils](./src/utils/checksum.md) — <!-- begin:auto-docs --> _(no submodules)_ - [checksum](./src/utils/checksum.md) — <!-- begin:auto-docs --> _(no submodules)_
|
|
## Packages
|
|
|
|
- [migration-runner](src/runner/migration-runner/migration-runner.md)
|
|
- [migration-executor](src/runner/migration-executor/migration-executor.md)
|
|
- [dry-run-reporter](src/runner/dry-run-reporter/dry-run-reporter.md)
|
|
- [migration-planner](src/planner/migration-planner/migration-planner.md)
|
|
- [memory-store](src/store/memory-store/memory-store.md)
|
|
- [database-store](src/store/database-store/database-store.md)
|
|
- [memory-lock](src/lock/memory-lock/memory-lock.md)
|
|
- [distributed-lock](src/lock/distributed-lock/distributed-lock.md)
|
|
- [redis-lock](src/lock/redis-lock/redis-lock.md)
|
|
- [migration-status](src/status/migration-status/migration-status.md)
|
|
- [batch-migrator](src/batch/batch-migrator/batch-migrator.md)
|
|
- [surrealdb-adapter](src/adapters/surrealdb-adapter/surrealdb-adapter.md)
|
|
- [checksum](src/utils/checksum.md)
|
|
- [migration-error](src/errors/migration-error.md)
|
|
- [migration.types](src/types/migration.types.md)
|
|
- [migration.schemas](src/schemas/migration.schemas.md)
|