Class RunnerContext

Inheritance

object

RunnerContext

Implements

IRunnerContext

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: FluentMigrator.Runner.Initialization

Assembly: FluentMigrator.Runner.dll

Syntax

[Obsolete]
public class RunnerContext : IRunnerContext

Constructors

RunnerContext(IAnnouncer)

Declaration

public RunnerContext(IAnnouncer announcer)

Parameters

Type	Name	Description
IAnnouncer	announcer

Properties

AllowBreakingChange

Gets or sets a value indicating whether the migration runner is allowed to apply breaking changes

Declaration

public bool AllowBreakingChange { get; set; }

Property Value

Type	Description
bool

Remarks

The option is now stored in AllowBreakingChange.

Announcer

Gets or sets the announcer to use

Declaration

public IAnnouncer Announcer { get; }

Property Value

Type	Description
IAnnouncer

ApplicationContext

Gets or sets the arbitrary application context passed to the task runner

Declaration

[Obsolete("Use dependency injection to access 'application state'.")]
public object ApplicationContext { get; set; }

Property Value

Type	Description
object

Connection

Gets or sets the connection string (or name)

Declaration

public string Connection { get; set; }

Property Value

Type	Description
string

Remarks

Will not be used when PreviewOnly is active. The option is now directly stored in ConnectionString

ConnectionStringConfigPath

Gets or sets the path to an app.config/web.config to load the connection string from

Declaration

public string ConnectionStringConfigPath { get; set; }

Property Value

Type	Description
string

Database

Gets or sets the identifier of the processor to use

Declaration

public string Database { get; set; }

Property Value

Type	Description
string

DefaultSchemaName

Gets or sets the default schema name

Declaration

public string DefaultSchemaName { get; set; }

Property Value

Type	Description
string

Remarks

The default schema name must be set using the SchemaConvention

Namespace

Gets or sets the root namespace for filtering

Declaration

public string Namespace { get; set; }

Property Value

Type	Description
string

Remarks

The option is now directly stored in Namespace.

NestedNamespaces

Gets or sets the value indicating whether all sub-namespaces should be included

Declaration

public bool NestedNamespaces { get; set; }

Property Value

Type	Description
bool

Remarks

The option is now directly stored in NestedNamespaces.

NoConnection

Gets or sets a value indicating whether no connection should be used

Declaration

public bool NoConnection { get; set; }

Property Value

Type	Description
bool

Remarks

The difference between this and PreviewOnly is, that the preview-only mode uses the connection to determine the current state of the database.

PreviewOnly

Gets or sets a value indicating whether a preview-only mode is active

Declaration

public bool PreviewOnly { get; set; }

Property Value

Type	Description
bool

Remarks

The option is now directly stored in PreviewOnly

Profile

Gets or sets the profile migrations to apply

Declaration

public string Profile { get; set; }

Property Value

Type	Description
string

Remarks

The option is now stored in Profile.

ProviderSwitches

Gets or sets the provider switches

Declaration

public string ProviderSwitches { get; set; }

Property Value

Type	Description
string

Remarks

The option is now stored in PreviewOnly.

StartVersion

Gets or sets the start version

Declaration

public long StartVersion { get; set; }

Property Value

Type	Description
long

Remarks

The option is now stored in StartVersion.

Steps

Gets or sets the number of versions to apply

Declaration

public int Steps { get; set; }

Property Value

Type	Description
int

Remarks

The option is now stored in Steps.

StopWatch

Gets or sets the stopwatch to use

Declaration

public IStopWatch StopWatch { get; }

Property Value

Type	Description
IStopWatch

StripComments

Gets or sets a value indicating whether the comments should be stripped

Declaration

public bool StripComments { get; set; }

Property Value

Type	Description
bool

Tags

Gets or sets the tags the migrations must match

Declaration

public IEnumerable<string> Tags { get; set; }

Property Value

Type	Description
IEnumerable<string>

Remarks

All migrations are matched when no tags were specified. The option is now stored in Tags.

Targets

Gets or sets the assembly names

Declaration

public string[] Targets { get; set; }

Property Value

Type	Description
string[]

Remarks

The option is now stored in AssemblyNames

Task

Gets or sets the task to execute

Declaration

public string Task { get; set; }

Property Value

Type	Description
string

Remarks

The option is now stored in Task.

Timeout

Gets or sets the default command timeout in seconds

Declaration

public int? Timeout { get; set; }

Property Value

Type	Description
int?

TransactionPerSession

Use one transaction for the whole session

Declaration

public bool TransactionPerSession { get; set; }

Property Value

Type	Description
bool

Remarks

The default transaction behavior is to use one transaction per migration. The option is now stored in TransactionPerSession.

Version

Gets or sets the target version

Declaration

public long Version { get; set; }

Property Value

Type	Description
long

Remarks

The option is now stored in Version.

WorkingDirectory

Gets or sets the working directory

Declaration

public string WorkingDirectory { get; set; }

Property Value

Type	Description
string

Implements

IRunnerContext