migrations library
Classes
- $OrmMigrationRecord
- Generated tracked model class for OrmMigrationRecord.
- AppliedMigrationRecord
- Snapshot of a migration persisted inside the ledger table.
- ColumnBuilder
- ColumnCommand
- Snapshot of a column mutation.
- ColumnDefault
- Representation of a default value. Literal values and SQL expressions are both supported.
- ColumnDefinition
- Declarative column metadata captured by the DSL.
- ColumnDriverOverride
- Driver-specific column hints that override the default definition.
- ColumnRename
- Records the original and new names for a column rename.
- ColumnType
- Declarative column type metadata.
- DatabaseSeeder
- Base class for database seeders that work with OrmConnection
- DropTableOptions
- ForeignKeyBuilder
- ForeignKeyCommand
- Snapshot of a foreign key mutation.
- ForeignKeyDefinition
- Declarative foreign key metadata.
- ForeignKeyEntry
- IndexCommand
- Snapshot of an index mutation.
- IndexDefinition
- Declarative index metadata.
- Migration
- Base contract migrations extend.
- MigrationAction
- Describes a single migration action that occurred.
- MigrationDescriptor
- Snapshot of a compiled migration ready to be logged inside the ledger.
- MigrationEntry
- Ties a MigrationId to a Migration instance.
- MigrationId
- Value object representing a migration identifier derived from its file name.
- MigrationLedger
- Storage abstraction for recording applied migrations.
- MigrationReport
- High-level summary returned after applying or rolling back migrations.
- MigrationRunner
- MigrationSqlExporter
- Exports SQL text files derived from schema plan previews.
- MigrationStatus
- Status information for a migration when listing history.
- ModelColumnSnapshot
- Snapshot of a single column derived from a model field.
- ModelGraphSnapshot
-
Captures the tables derived from the current
ModelDefinitionregistry. - ModelTableSnapshot
- Snapshot of a single model's table shape.
- OrmMigrationRecord
- OrmMigrationRecordInsertDto
- Insert DTO for OrmMigrationRecord.
- OrmMigrationRecordModelFactory
- OrmMigrationRecordPartial
- Partial projection for OrmMigrationRecord.
- OrmMigrationRecords
- OrmMigrationRecordUpdateDto
- Update DTO for OrmMigrationRecord.
- RenameTableOptions
- SchemaBuilder
- Fluent builder that collects schema commands for a migration direction.
- SchemaColumn
- Metadata describing a table column.
- SchemaDialect
- Dialects convert individual schema mutations into executable SQL.
- SchemaDriver
- Contract implemented by database drivers that can execute schema plans and introspect live database metadata.
- SchemaForeignKey
- Metadata describing a foreign key constraint.
- SchemaIndex
- Metadata describing an index.
- SchemaInspector
- High-level helper that mirrors Laravel's schema inspector.
- SchemaMutation
- A mutation emitted by the schema builder.
- SchemaNamespace
- Additional metadata about namespaces/schemas available on a connection.
- SchemaPlan
- Immutable collection of schema mutations.
- SchemaPlanCompiler
- Translates SchemaPlan objects into SQL statements using a dialect.
- SchemaPreview
- Preview of the SQL statements a schema plan would execute. A preview of SQL statements that would be executed for a schema plan.
- SchemaSnapshot
- Captures a read-only snapshot of schema metadata for offline inspection.
- SchemaStatement
- Represents a single schema statement and optional structured payload.
- SchemaTable
- Metadata describing a database table (excluding views).
- SchemaTableIdentifier
- Identifier that pairs a schema with a table name for comparisons.
- SchemaView
- Metadata describing a database view.
- Seeder
- Base class for database seeders
- SeederRegistration
- Seeder registration for managing multiple seeders.
- SeederRegistry
- Registry and runner for database seeders
- SnapshotSchemaDriver
- Lightweight driver backed entirely by a SchemaSnapshot.
- SqlFileMigration
-
A Migration implementation backed by SQL files (
up.sqlanddown.sql). - SqliteFullTextOptions
- Options for SQLite full text search indexes.
- SqliteSpatialIndexOptions
- Options controlling SQLite spatial indexes.
- SqlMigrationLedger
- Generic SQL ledger that persists migrations inside a driver-managed table.
- TableBlueprint
- Mutable blueprint that records the operations to perform against a table.
Enums
- ColumnCommandKind
- Low-level column command kinds surfaced through TableBlueprint.
- ColumnMutation
- Describes whether a column command adds or alters a column.
- ColumnTypeName
- Logical column type names recognized by the DSL.
- ForeignKeyCommandKind
- Foreign-key command kinds supported by the fluent DSL.
- IndexCommandKind
- Index command kinds supported by the fluent DSL.
- IndexType
- Logical index types that influence naming and SQL generation.
- MigrationDirection
- Directions supported by a migration lifecycle.
- MigrationOperation
- Supported operations tracked inside a MigrationAction.
- MorphKeyType
- Morph key variants supported by helper methods like TableBlueprint.morphs.
- ReferenceAction
- Reference actions that control cascading behavior for foreign keys.
- SchemaMutationOperation
- High-level operations supported by the schema planner.
- TableOperationKind
- Determines whether a blueprint is creating a new table or mutating an existing one.
Extensions
- DataSourceSeeding on DataSource
- Extension on DataSource for convenient seeding
- OrmMigrationRecordOrmDefinition on OrmMigrationRecord
- OrmMigrationRecordOrmExtension on OrmMigrationRecord
- SqliteTableBlueprintExtensions on TableBlueprint
- SQLite-specific schema helpers.
Functions
-
registerOrmMigrationRecordEventHandlers(
EventBus bus) → void
Typedefs
-
MigrationPlanResolver
= Future<
SchemaPlan> Function(MigrationDescriptor descriptor, MigrationDirection direction) - Coordinates applying and rolling back migrations using a SchemaDriver and ledger store.