@radzor/database-migrate

Run SQL database migrations with up/down support, status tracking, and migration file generation. Connects via raw TCP to PostgreSQL or via HTTP to compatible APIs.

Storagev0.1.0typescriptpythonServerdatabasemigrationsqlpostgresschemaversioningby Radzor

Install

View source on GitHub →

$npx radzor@latest add database-migrate

⚠ Constraints: Migration files must export up() and down() functions returning SQL strings. The migrations table is created automatically. Runs migrations in a transaction — a failed migration rolls back its own changes. File naming convention: YYYYMMDDHHMMSS_name.ts.

Inputs

Name	Type	Default	Description
databaseUrl*	string	—	Database connection URL (postgres://user:pass@host:5432/db).DATABASE_URL
migrationsDir	string	./migrations	Directory containing migration files (default: ./migrations).
tableName	string	_migrations	Table name for tracking migration state (default: _migrations).

databaseUrl*string

Database connection URL (postgres://user:pass@host:5432/db).

DATABASE_URL

migrationsDirstring

Directory containing migration files (default: ./migrations).

{ "llm": { "constraints": "Migration files must export up() and down() functions returning SQL strings. The migrations table is created automatically. Runs migrations in a transaction — a failed migration rolls back its own changes. File naming convention: YYYYMMDDHHMMSS_name.ts.", "usageExamples": "llm/examples.md", "integrationPrompt": "llm/integration.md" }, "name": "@radzor/database-migrate", "tags": [ "database", "migration", "sql", "postgres", "schema", "versioning" ], "events": [ { "name": "onMigrationComplete", "payload": { "name": "string", "direction": "string", "durationMs": "number" }, "description": "Fired when a single migration runs successfully." }, { "name": "onMigrationFailed", "payload": { "name": "string", "error": "string", "direction": "string" }, "description": "Fired when a migration fails." } ], "inputs": [ { "name": "databaseUrl", "type": "string", "envVar": "DATABASE_URL", "required": true, "description": "Database connection URL (postgres://user:pass@host:5432/db)." }, { "name": "migrationsDir", "type": "string", "default": "./migrations", "required": false, "description": "Directory containing migration files (default: ./migrations)." }, { "name": "tableName", "type": "string", "default": "_migrations", "required": false, "description": "Table name for tracking migration state (default: _migrations)." } ], "radzor": "1.0.0", "actions": [ { "name": "migrate", "params": [ { "name": "target", "type": "string", "required": false, "description": "Migrate up to this migration name. If omitted, runs all pending migrations." } ], "returns": "Promise<{ applied: string[]; durationMs: number }>", "description": "Run pending migrations forward." }, { "name": "rollback", "params": [ { "name": "steps", "type": "number", "required": false, "description": "Number of migrations to roll back (default: 1)." } ], "returns": "Promise<{ rolledBack: string[]; durationMs: number }>", "description": "Roll back the most recent migration(s)." }, { "name": "getStatus", "params": [], "returns": "Promise<{ applied: string[]; pending: string[]; current: string }>", "description": "Get the current migration status." }, { "name": "createMigration", "params": [ { "name": "name", "type": "string", "description": "Migration name (will be prefixed with timestamp)." } ], "returns": "Promise<{ filePath: string; name: string }>", "description": "Create a new empty migration file with up/down sections." } ], "outputs": [ { "name": "migrationStatus", "type": "{ applied: string[]; pending: string[]; current: string }", "fields": [ { "name": "applied", "type": "string[]", "description": "List of applied migration names." }, { "name": "pending", "type": "string[]", "description": "List of pending migration names." }, { "name": "current", "type": "string", "description": "Most recently applied migration name." } ], "description": "Current migration status." } ], "runtime": "server", "version": "0.1.0", "category": "storage", "languages": [ "typescript", "python" ], "description": "Run SQL database migrations with up/down support, status tracking, and migration file generation. Connects via raw TCP to PostgreSQL or via HTTP to compatible APIs.", "dependencies": { "radzor": [], "packages": {} }, "composability": { "connectsTo": [ { "event": "onMigrationComplete", "description": "Notify team after successful migration", "compatibleWith": [ "@radzor/slack-bot.action.sendMessage.text", "@radzor/notification-hub.action.send.body" ] }, { "event": "onMigrationFailed", "description": "Alert on migration failure", "compatibleWith": [ "@radzor/slack-bot.action.sendMessage.text", "@radzor/email-send.action.send.message", "@radzor/error-tracker.action.captureMessage.message" ] } ] } }

@radzor/database-migrate

Install

Inputs

Outputs

Actions

Events

Composability

radzor.manifest.json