Ef6DatabaseUpdateSettings Class

Summary

Contains settings used by Ef6DatabaseUpdateTool.
Assembly
Cake.EntityFramework6.dll
Namespace
Cake.EntityFramework6.Database
Base Types
graph BT Type-->Base0["Ef6Settings"] click Base0 "/api/Cake.EntityFramework6/Ef6Settings" Base0-->Base1["ToolSettings"] Type["Ef6DatabaseUpdateSettings"] class Type type-node

Syntax

public class Ef6DatabaseUpdateSettings : Ef6Settings

Constructors

Name Summary
Ef6DatabaseUpdateSettings() Initializes a new instance of the Ef6Settings class.

Properties

Name Value Summary
Assembly FilePath
The assembly to use.
Command string
Gets the command which should be run.
Inherited from Ef6Settings
ConfigurationFile FilePath
Specifies the configuration file to use for named connection strings.
ConnectionProvider string
Specifies the provider invariant name of the connection string.
ConnectionString string
Specifies the connection string to use. If omitted, the context's default connection will be used.
ConnectionStringName string
Specifies the name of a connection string to use from the application's configuration file.
DataDirectory DirectoryPath
The data directory.
Force bool
Specifies that data loss is acceptable during automatic migration of the database.
Language string
The language. Defaults to 'C#'.
MigrationsConfigurationType string
Specifies the migrations configuration (TYPE) to use. If omitted, migrations will attempt to locate a single migrations configuration type in the target project.
NoColor bool
Gets or Sets whether to colorize the output.
Inherited from Ef6Settings
PrefixOutput bool
Gets or sets whether to prefix the output level
Inherited from Ef6Settings
ProjectDirectory DirectoryPath
The project directory. Defaults to the current directory.
RedirectStandardError bool
Gets or sets the process option to redirect standard error
Inherited from Ef6Settings
RedirectStandardOutput bool
Gets or sets the process option to redirect standard output
Inherited from Ef6Settings
RootNamespace string
The root namespace. Defaults to the target assembly name.
Script bool
Generate a SQL script rather than executing the pending changes directly.
Source string
Only valid with --script. Specifies the name of a particular migration to use as the update's starting point. If omitted, the last applied migration in the database will be used.
Target string
Specifies the name of a particular migration to update the database to. If omitted, the current model will be used.
Verbose bool
Gets or Sets whether to show Verbose output
Inherited from Ef6Settings
Version bool
Gets or Sets whether to show the version of Entity Framework.
Inherited from Ef6Settings

Methods

Name Value Summary
EvaluateCore(ProcessArgumentBuilder) void
Evaluates the settings and writes them to args.

Extension Methods

Name Value Summary
Dump<Ef6DatabaseUpdateSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
ForceChanges() Ef6DatabaseUpdateSettings
Specifies that data loss is acceptable during automatic migration of the database.
Requires the Cake.EntityFramework6 addin
FromAssembly(FilePath) Ef6DatabaseUpdateSettings
The assembly to use.
Requires the Cake.EntityFramework6 addin
FromConfigurationFile(FilePath) Ef6DatabaseUpdateSettings
Specifies the configuration file to use for named connection strings.
Requires the Cake.EntityFramework6 addin
FromDataDirectory(DirectoryPath) Ef6DatabaseUpdateSettings
The data directory
Requires the Cake.EntityFramework6 addin
FromPath(DirectoryPath) Ef6Settings
Sets the working directory which should be used to run the ef6.exe command.
Requires the Cake.EntityFramework6 addin
FromProjectDirectory(DirectoryPath) Ef6DatabaseUpdateSettings
The project directory. Defaults to the current directory.
Requires the Cake.EntityFramework6 addin
IsIn<Ef6DatabaseUpdateSettings>(Ef6DatabaseUpdateSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<Ef6DatabaseUpdateSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<Ef6DatabaseUpdateSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ScriptChanges() Ef6DatabaseUpdateSettings
Generate a SQL script rather than executing the pending changes directly.
Requires the Cake.EntityFramework6 addin
SetConnectionprovider(string) Ef6DatabaseUpdateSettings
Specifies the connection string to use. If omitted, the context's default connection will be used.
Requires the Cake.EntityFramework6 addin
SetConnectionString(string) Ef6DatabaseUpdateSettings
Specifies the connection string to use. If omitted, the context's default connection will be used.
Requires the Cake.EntityFramework6 addin
SetConnectionStringName(string) Ef6DatabaseUpdateSettings
Specifies the name of a connection string to use from the application's configuration file.
Requires the Cake.EntityFramework6 addin
SetLanguage(string) Ef6DatabaseUpdateSettings
The language. Defaults to 'C#'.
Requires the Cake.EntityFramework6 addin
SetMigrationsConfigurationType(string) Ef6DatabaseUpdateSettings
Specifies the migrations configuration (TYPE) to use. If omitted, migrations will attempt to locate a single migrations configuration type in the target project.
Requires the Cake.EntityFramework6 addin
SetNoColor() Ef6Settings
Sets the no color output for Entity Framework output (e.g. - Don't colorize output).
Requires the Cake.EntityFramework6 addin
SetPrefixOutput() Ef6Settings
Sets the Prefix Out with level for the e6.exe. (e.g. - Prefix output with level.).
Requires the Cake.EntityFramework6 addin
SetRootNamespace(string) Ef6DatabaseUpdateSettings
The root namespace. Defaults to the target assembly name.
Requires the Cake.EntityFramework6 addin
SetVerbose() Ef6Settings
Sets the verbose output for Entity Framework output. (e.g. - Show verbose output).
Requires the Cake.EntityFramework6 addin
SetVersion() Ef6Settings
Sets the version to show for the e6.exe. (e.g. - Show version information).
Requires the Cake.EntityFramework6 addin
ThrowIfNull<Ef6DatabaseUpdateSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<Ef6DatabaseUpdateSettings>(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
WithSource(string) Ef6DatabaseUpdateSettings
Specifies the name of a particular migration to use as the update's starting point. If omitted, the last applied migration in the database will be used.
Requires the Cake.EntityFramework6 addin
WithTarget(string) Ef6DatabaseUpdateSettings
Specifies the name of a particular migration to update the database to. If omitted, the current model will be used.
Requires the Cake.EntityFramework6 addin