1. Tasks
  2. StubberDB Update Migration

Tasks

StubberDB Update Migration

Updates the name and SQL script for a pending StubberDB migration

Basic usage

loading...

Parameters

stubberdbmigrationuuid
required
string

The migration UUID to update.


stubberdbuuid
required
string

The StubberDB UUID that owns the migration.


name
required
string

The migration name.

The name is normalized to snake_case before the migration is saved.


script
required
string

The SQL script to store for the migration.

NOTE

Only migrations that have not yet been applied can be updated. If the migration has already been applied to draft or live, the task returns the conceptual error migration_already_applied.

Result

loading...

Properties

message
string

Confirms that the migration was updated successfully.


payload
object

The updated migration record.


payload.name
string

The saved migration name after normalization to snake_case.


payload.script
string

The SQL script stored for the migration.


payload.updated_at
string

The timestamp when the migration was last updated.


payload.draft_applied
boolean

Whether the migration has already been applied to the draft branch.


payload.live_applied
boolean

Whether the migration has already been applied to the live branch.

Examples

Rename a pending migration before rollout

loading...