FluentMigratorSettings Class

Summary

Contains settings used by FluentMigratorRunner.
Assembly
Cake.FluentMigrator.dll
Namespace
Cake.FluentMigrator
Base Types
  • ToolSettings
graph BT Type-->Base0["ToolSettings"] Type["FluentMigratorSettings"] class Type type-node

Syntax

public class FluentMigratorSettings : ToolSettings

Constructors

Properties

Name Value Summary
ApplicationContext string
Gets or sets the application context.
Assembly FilePath
Gets or sets the FilePath to the assembly that will be used.
Connection string
Gets or sets the Connection string that will be used.
ConnectionStringConfigPath string
Gets or sets the path to the connection string configuration.
Namespace string
Gets or sets the default namespace to be used.
NestedNamespaces bool
Gets or sets a value indicating whether nested namespaces should be used.
NoConnection bool
Gets or sets a value indicating whether no connection.
Output bool
Gets or sets a value indicating whether to output the result.
OutputFileName string
Gets or sets the name of the output file.
PreviewOnly bool
Gets or sets a value indicating whether execution should only a preview.
Profile string
Gets or sets the profile name to be used.
Provider string
Gets or sets the Provider that will be used by FluentMigrator.
ProviderSwitches string
Gets or sets the provider switches that should be applied.
StartVersion long
Gets or sets the start version number for the execution.
Steps int
Gets or sets the number of steps.
Tags IEnumerable<string>
Gets or sets the list of tags to be used.
Task string
Gets or sets the name of the task.
Timeout int
Gets or sets the timeout period.
TransactionPerSession bool
Gets or sets a value indicating whether transaction are based per session.
Verbose bool
Gets or sets a value indicating whether verbose output should be used.
Version long
Gets or sets the version number to be used.

Extension Methods

Name Value Summary
Dump<FluentMigratorSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<FluentMigratorSettings>(FluentMigratorSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<FluentMigratorSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
NotNull<FluentMigratorSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
ThrowIfNull<FluentMigratorSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<FluentMigratorSettings>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin