Class RunnerOptions

The options for a migration runner

Inheritance
Object
RunnerOptions
Namespace: FluentMigrator.Runner.Initialization
Assembly: FluentMigrator.Runner.Core.dll
Syntax
public class RunnerOptions : object

Constructors

| Improve this Doc View Source

RunnerOptions()

Initializes a new instance of the RunnerOptions class.

Declaration
public RunnerOptions()
| Improve this Doc View Source

RunnerOptions(IRunnerContext)

Initializes a new instance of the RunnerOptions class.

Declaration
public RunnerOptions(IRunnerContext runnerContext)
Parameters
Type Name Description
IRunnerContext runnerContext

The runner context

Properties

| Improve this Doc View Source

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
Boolean
| Improve this Doc View Source

ApplicationContext

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

Declaration
public object ApplicationContext { get; set; }
Property Value
Type Description
Object
| Improve this Doc View Source

IncludeUntaggedMaintenances

Gets or sets a value indicating whether untagged maintenance items should always be loaded/executed.

Declaration
public bool IncludeUntaggedMaintenances { get; set; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IncludeUntaggedMigrations

Gets or sets a value indicating whether untagged migrations should always be loaded/executed.

Declaration
public bool IncludeUntaggedMigrations { get; set; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

NoConnection

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

Declaration
public bool NoConnection { get; set; }
Property Value
Type Description
Boolean
Remarks

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

| Improve this Doc View Source

Profile

Gets or sets the profile migrations to apply

Declaration
public string Profile { get; set; }
Property Value
Type Description
String
| Improve this Doc View Source

StartVersion

Gets or sets the start version

Declaration
public long StartVersion { get; set; }
Property Value
Type Description
Int64
Remarks

This will be used only if NoConnection is set to true. Otherwise current state of target database will determine which migrations are needed.

| Improve this Doc View Source

Steps

Gets or sets the number of versions to apply

Declaration
public int Steps { get; set; }
Property Value
Type Description
Int32
| Improve this Doc View Source

Tags

Gets or sets the tags the migrations must match

Declaration
public string[] Tags { get; set; }
Property Value
Type Description
String[]
Remarks

All migrations are matched when no tags were specified

| Improve this Doc View Source

Task

Gets or sets the task to execute

Declaration
public string Task { get; set; }
Property Value
Type Description
String
| Improve this Doc View Source

TransactionPerSession

Use one transaction for the whole session

Declaration
public bool TransactionPerSession { get; set; }
Property Value
Type Description
Boolean
Remarks

The default transaction behavior is to use one transaction per migration.

| Improve this Doc View Source

Version

Gets or sets the target version

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

Methods

| Improve this Doc View Source

SetValuesFrom(IRunnerContext)

Sets the values from the given runner context

Declaration
public void SetValuesFrom(IRunnerContext runnerContext)
Parameters
Type Name Description
IRunnerContext runnerContext

The runner context