Interface IMigrationRunner

The migration runner

Inherited Members

Namespace: FluentMigrator.Runner

Assembly: FluentMigrator.Runner.dll

Syntax

public interface IMigrationRunner : IMigrationScopeStarter

Properties

| Edit this page View Source

MigrationAssemblies

Gets the assemblies searched for migrations, profile migrations, etc...

Declaration

[Obsolete]
[CanBeNull]
IAssemblyCollection MigrationAssemblies { get; }

Property Value

Type	Description
IAssemblyCollection

| Edit this page View Source

MigrationLoader

Gets or sets the migration loader to be used by this migration runner

Declaration

[NotNull]
IMigrationInformationLoader MigrationLoader { get; }

Property Value

Type	Description
IMigrationInformationLoader

| Edit this page View Source

Processor

Gets the migration processor used by this runner

Declaration

[NotNull]
IMigrationProcessor Processor { get; }

Property Value

Type	Description
IMigrationProcessor

| Edit this page View Source

RunnerContext

Gets the runner context

Declaration

[Obsolete]
[CanBeNull]
IRunnerContext RunnerContext { get; }

Property Value

Type	Description
IRunnerContext

Methods

| Edit this page View Source

Down(IMigration)

Executes an Down migration

Declaration

void Down(IMigration migration)

Parameters

Type	Name	Description
IMigration	migration	The migration to execute

| Edit this page View Source

HasMigrationsToApplyDown(long)

Returns true when there are migrations to revert

Declaration

bool HasMigrationsToApplyDown(long version)

Parameters

Type	Name	Description
long	version	The target version

Returns

Type	Description
bool	`true` when there are migrations to revert

| Edit this page View Source

HasMigrationsToApplyRollback()

Are there migrations available for a rollback?

Declaration

bool HasMigrationsToApplyRollback()

Returns

Type	Description
bool	`true` when there are migrations available for a rollback

| Edit this page View Source

HasMigrationsToApplyUp(long?)

Returns true when there are migrations to apply

Declaration

bool HasMigrationsToApplyUp(long? version = null)

Parameters

Type	Name	Description
long?	version	The target version (or `null` if the last one should be used)

Returns

Type	Description
bool	`true` when there are migrations to apply

| Edit this page View Source

ListMigrations()

List all migrations to the logger

Declaration

void ListMigrations()

| Edit this page View Source

MigrateDown(long)

Migrate down to the given version

Declaration

void MigrateDown(long version)

Parameters

Type	Name	Description
long	version	The version to migrate down to

| Edit this page View Source

MigrateUp()

Executes all found (and unapplied) migrations

Declaration

void MigrateUp()

| Edit this page View Source

MigrateUp(long)

Executes all found (and unapplied) migrations up to the given version

Declaration

void MigrateUp(long version)

Parameters

Type	Name	Description
long	version	The target version to migrate to (inclusive)

| Edit this page View Source

Rollback(int)

Rollback the given number of steps

Declaration

void Rollback(int steps)

Parameters

Type	Name	Description
int	steps	The number of steps to rollback

| Edit this page View Source

RollbackToVersion(long)

Rollback to a given version

Declaration

void RollbackToVersion(long version)

Parameters

Type	Name	Description
long	version	The target version to rollback to

| Edit this page View Source

Up(IMigration)

Executes an Up migration

Declaration

void Up(IMigration migration)

Parameters

Type	Name	Description
IMigration	migration	The migration to execute

| Edit this page View Source

ValidateVersionOrder()

Validate that there were no missing migration versions

Declaration

void ValidateVersionOrder()

Remarks

Throws an exception if a missing migration was found.