Migration

Represents a database migration, including events and metadata.

class Migration extends \Hazaar\DBI\Manager\Struct

Encapsulates migration message, requirements, execution steps, and up/down events for schema changes.

Properties

message

The message describing the migration.

public string $message

raise

Raises an exception if the migration is not compatible with the current database schema.

public string $raise

requires

List of migration versions that are required to be run before this migration.

public array $requires

exec

public array $exec

up

The event to run when applying the migration (up direction).

public Event $up

down

The event to run when rolling back the migration (down direction).

public Event $down

Methods

replay

Applies the migration by running the 'up' event.

public replay(Adapter $dbi): bool

Parameters

Parameter	Type	Description
$dbi	Adapter	the database adapter instance

rollback

Rolls back the migration by running the 'down' event.

public rollback(Adapter $dbi): bool

Parameters

Parameter	Type	Description
$dbi	Adapter	the database adapter instance

---

Generated by Hazaar API Doc Generator on Tue, 21 Apr 2026 04:00:24 +0000