Class MigrationInfo

The default IMigrationInfo implementation for migrations with the MigrationAttribute

Inheritance
object
MigrationInfo
Implements
Inherited Members
Namespace: FluentMigrator.Infrastructure
Assembly: FluentMigrator.Abstractions.dll
Syntax
public class MigrationInfo : IMigrationInfo

Constructors

MigrationInfo(long, TransactionBehavior, IMigration)

Initializes a new instance of the MigrationInfo class.

Declaration
public MigrationInfo(long version, TransactionBehavior transactionBehavior, IMigration migration)
Parameters
Type Name Description
long version

The migration version
TransactionBehavior transactionBehavior

The desired transaction behavior
IMigration migration

The underlying migration

MigrationInfo(long, TransactionBehavior, bool, IMigration)

Initializes a new instance of the MigrationInfo class.

Declaration
public MigrationInfo(long version, TransactionBehavior transactionBehavior, bool isBreakingChange, IMigration migration)
Parameters
Type Name Description
long version

The migration version
TransactionBehavior transactionBehavior

The desired transaction behavior
bool isBreakingChange

Indicates wether the migration is a breaking change
IMigration migration

The underlying migration

MigrationInfo(long, string, TransactionBehavior, bool, Func<IMigration>)

Initializes a new instance of the MigrationInfo class.

Declaration
public MigrationInfo(long version, string description, TransactionBehavior transactionBehavior, bool isBreakingChange, Func<IMigration> migrationFunc)
Parameters
Type Name Description
long version

The migration version
string description

The migration description
TransactionBehavior transactionBehavior

The desired transaction behavior
bool isBreakingChange

Indicates wether the migration is a breaking change
Func<IMigration> migrationFunc

A function to get the IMigration instance

Properties

Description

Gets the migration description

Declaration
public string Description { get; }
Property Value
Type Description
string

IsBreakingChange

Gets a value indicating whether the migration is a breaking change

Declaration
public bool IsBreakingChange { get; }
Property Value
Type Description
bool

Migration

Gets the migration

Declaration
public IMigration Migration { get; }
Property Value
Type Description
IMigration

TransactionBehavior

Gets the desired transaction behavior

Declaration
public TransactionBehavior TransactionBehavior { get; }
Property Value
Type Description
TransactionBehavior

Version

Gets the migration version

Declaration
public long Version { get; }
Property Value
Type Description
long

Methods

AddTrait(string, object)

Manually adds a trait to the migration

Declaration
public void AddTrait(string name, object value)
Parameters
Type Name Description
string name

The trait name
object value

The trait value

GetName()

Gets the migration name

Declaration
public string GetName()
Returns
Type Description
string

HasTrait(string)

Returns a value indicating whether a given trait was specified

Declaration
public bool HasTrait(string name)
Parameters
Type Name Description
string name

The trait name
Returns
Type Description
bool

true when the trait was specified

ToString()

Returns a string that represents the current object.

Declaration
public override string ToString()
Returns
Type Description
string

A string that represents the current object.
Overrides

Trait(string)

Gets the trait object with the given name

Declaration
public object Trait(string name)
Parameters
Type Name Description
string name

The trait name
Returns
Type Description
object

The object associated with the given name

Implements

Extension Methods