IEfMigrator Interface

Summary

Entity Framework Migrator
Namespace
Cake.EntityFramework.Interfaces
Interfaces
  • IDisposable
Implementing Types
graph TD Interface0["IDisposable"]-.->Type Type["IEfMigrator"] class Type type-node Type-.->Implementing0["EfMigrator"] click Implementing0 "/Cake.EntityFramework/api/Cake.EntityFramework.Migrator/EfMigrator"

Syntax

public interface IEfMigrator : IDisposable

Properties

Name Value Summary
Committed bool
Gets a boolean value if the migration was commited successfully
Ready bool
Gets a boolean value if the migration is currently ready

Methods

Name Value Summary
Commit() void
Commits the changes to the data store
GenerateScriptForLatest() string
Generates a script from the data store for the latest version
GenerateScriptForVersion(string) string
Generates a script from the data store to the specific version
GetCurrentMigration() string
Gets last migration that has been applied to the target database.
GetLatestMigration() string
Gets latest migration that is defined in the assembly but has not been applied to the target database.
GetLocalMigrations() IEnumerable<string>
Gets all migrations that are defined in the configured migrations assembly.
GetPendingMigrations() IEnumerable<string>
Gets all migrations that are defined in the assembly but haven't been applied to the target database.
GetRemoteMigrations() IEnumerable<string>
Gets all migrations that have been applied to the target database.
HasPendingMigrations() bool
Determines if there are any pending migrations
MigrateTo(string) bool
Migrates the data store to the specific version
MigrateToLatest() bool
Migrates the data store to the lastest version if any
Rollback() void
Rollsback any changes made to the data store