1.8 KiB
1.8 KiB
name: migration
description: Use when implementing or debugging code that uses @suaveplan/migration: Database-agnostic migration runner with ledger tracking, dry-run, checksums, lock adapters, and OTel instrumentation.
@suaveplan/migration
Database-agnostic schema migration runner with ledger tracking, checksum validation, dry-run reporting, distributed locking, event bus integration, and OTel instrumentation.
When to use this skill
- Implementing or debugging code that imports
@suaveplan/migration. - The task touches: see package README.
- You need API guidance for this package's exports.
Quick reference
import { /* see API Reference below */ } from "@suaveplan/migration";
Dependencies
Workspace dependencies: @suaveplan/db, @suaveplan/error, @suaveplan/events, @suaveplan/logger, @suaveplan/types
Where to read more
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
packages/database/migration/README.md— overview, install, quick-start, module indexpackages/database/migration/src/**/*.md— co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)packages/database/migration/package.jsonexportsmap — every subpath you can import from
When the user asks an API question, read the relevant co-located .md first; do not answer from training-data memory.
See also
@suaveplan/db@suaveplan/error@suaveplan/events@suaveplan/logger@suaveplan/types
This SKILL.md is auto-generated by suaveplan-skills/scripts/generate-skills.ts from the package's README. Do not edit by hand — re-run the generator after the README changes.