migrations library

Classes

DeployResult
Result of applying all pending local migrations.
DirectoryMigrationReader
Filesystem-backed runtime migration reader.
LocalMigrationArtifact
Describes a migration artifact loaded from disk.
MigrationArtifact
Runtime migration artifact consumed by MigrationExecutor.
MigrationCapableDatabaseAdapter
Adapter capability required by ComonOrm.migrate(...).
MigrationDraft<TPlan extends PlannedMigration>
File-backed migration draft created from schema diffing.
MigrationExecutor
Runtime migration executor created by provider adapters.
MigrationReader
Source of runtime migration artifacts.
MigrationRecord<TKind extends Enum>
Single migration history record stored by a relational provider.
MigrationResult<TPlan extends PlannedMigration>
Result of applying a relational migration plan.
MigrationStatus<TIssue extends MigrationStatusIssue>
Summary returned by relational migration status checks.
MigrationStatusIssue
Issue reported when local and database migration state differ.
PlannedMigration
Contract implemented by relational migration plans.
ResolveResult
Result of marking migration history manually.
RollbackResult
Result of rolling back relational migration state.

Constants

migrationManifestFileName → const String
Default manifest file name used by runtime asset migration readers.

Functions

attributeToSource(FieldAttribute attribute) String
Converts a field attribute back into schema source.
buildMigrationSqlScript(PlannedMigration plan) String
Builds the canonical SQL script for a migration plan.
computeMigrationChecksum({required String provider, required String beforeSchema, required String afterSchema, required String migrationSql, required List<String> warnings, required bool requiresRebuild}) String
Computes the stable checksum stored with a migration artifact.
containsManualMigrationWarnings(Iterable<String> warnings) bool
Whether any warning indicates that the migration requires manual intervention.
decodeMigrationWarnings(String? rawWarnings) List<String>
Decodes warnings from either JSON or the legacy line-based format.
detectPotentialDataLossWarnings({required SchemaDocument from, required SchemaDocument to}) List<String>
Returns human-readable warnings for schema transitions that may lose data.
encodeMigrationWarnings(List<String> warnings) String
Serializes warning lines into the canonical metadata representation.
filterSchemaForUserModels(SchemaDocument schema, {required String historyTableName}) SchemaDocument
Returns schema without the provider history table model.
isManualMigrationWarning(String warning) bool
Whether warning indicates that the migration cannot be applied automatically.
loadLocalMigrationArtifacts(String directoryPath, {required String provider}) List<LocalMigrationArtifact>
File-backed migration artifact loading is unavailable on web builds.
mergeMigrationWarnings(List<String> warnings, List<String> riskWarnings) List<String>
Returns the union of plan warnings and detected risk warnings.
metadataText({required String name, required DateTime generatedAt, required int statementCount, required int warningCount, required bool rebuildRequired, required String provider, required String checksum}) String
Builds the metadata.txt payload for a migration artifact directory.
migrationManifestText(Iterable<String> migrationNames) String
Builds the canonical migration manifest JSON.
modelAttributeToSource(ModelAttribute attribute) String
Converts a model-level attribute back into schema source.
parseMetadataText(String text) Map<String, String>
Parses metadata.txt content into key-value pairs.
parseMigrationManifestText(String text) List<String>
Parses migration names from a manifest JSON payload.
resolveRollbackTarget<TRecord>({required List<TRecord> activeHistory, required String? migrationName, required String migrationNameOf(TRecord record)}) → TRecord
Resolves which active migration should be rolled back.
schemaToSource(SchemaDocument schema) String
Converts a schema AST back into schema.prisma source text.
updateMigrationManifest(String directoryPath) → void
File-backed manifest updates are unavailable on web builds.

Exceptions / Errors

ManualMigrationRequiredException
Exception raised when a migration requires manual intervention.