Summary
Contains settings used by
RoundhouseRunner
.
- Namespace
- Cake
.Common .Tools .Roundhouse - Base Types
-
- object
- ToolSettings
graph BT
Type-->Base0["ToolSettings"]
click Base0 "/api/Cake.Core.Tooling/ToolSettings"
Base0-->Base1["object"]
Type["RoundhouseSettings"]
class Type type-node
Syntax
public sealed class RoundhouseSettings : ToolSettings
Properties
Name | Value | Summary |
---|---|---|
After |
string |
Gets or sets the folder name for 'afterMig' scripts.
|
Alter |
string |
Gets or sets the folder name for 'alterDatabase' scripts.
|
Argument |
Func |
Gets or sets the argument customization.
Argument customization is a way that lets you add, replace or reuse arguments passed to a tool.
This allows you to support new tool arguments, customize arguments or address potential argument issues.
Inherited from ToolSettings
|
Baseline | bool |
Gets or sets a value indicating whether to create an insert for its recording tables, but not run anything.
|
Before |
string |
Gets or sets the folder name for 'beforeMig' scripts.
|
CommandTimeout | int? |
Gets or sets the timeout (in seconds) for normal connections.
|
CommandTimeoutAdmin | int? |
Gets or sets the timeout (in seconds) for admin connections.
|
ConnectionString | string |
Gets or sets the connection string.
|
Connection |
string |
Gets or sets the connection string for admin connections.
|
Create |
string |
Gets or sets the custom database creation script.
|
DatabaseName | string |
Gets or sets the database name.
|
DatabaseType | string |
Gets or sets database type.
|
Debug | bool |
Gets or sets a value indicating whether to write debug messages.
|
DisableOutput | bool |
Gets or sets a value indicating whether to disable output of backup, items ran, permissions dumps, etc.
|
Disable |
bool |
Gets or sets a value indicating whether to perform token replacement.
|
DoNotCreateDatabase | bool |
Gets or sets a value indicating whether to create a database if it does not exist.
|
Drop | bool |
Gets or sets a value indicating whether to drop the DB.
|
DryRun | bool |
Gets or sets a value indicating whether to perform a dry run.
|
Environment | string |
Gets or sets the environment for RH to be scoped.
|
EnvironmentVariables | IDictionary |
Gets or sets search paths for files, directories for temporary files, application-specific options, and other similar information.
Inherited from ToolSettings
|
FunctionsFolderName | string |
Gets or sets the folder name for 'functions' scripts.
|
HandleExitCode | Func |
Gets or sets whether the exit code from the tool process causes an exception to be thrown.
If the delegate is null (the default) or returns false, then an exception is thrown upon a non-zero exit code. If the delegate returns true then no exception is thrown. This can be useful when the exit code should be ignored, or if there is a desire to apply logic that is conditional on the exit code value. Inherited from ToolSettings
|
IndexesFolderName | string |
Gets or sets the folder name for 'indexes' scripts.
|
NoWorkingDirectory | bool |
Gets or sets a value indicating whether or not to opt out of using
an explicit working directory for the process.
Inherited from ToolSettings
|
OutputPath | string |
Gets or sets the output path.
|
Permissions |
string |
Gets or sets the folder name for 'permissions' scripts.
|
PostAction | Action |
Gets or sets a delegate which is executed after the process was started.
Inherited from ToolSettings
|
RecoveryMode | RecoveryMode? |
Gets or sets SQL Server recovery mode.
|
RepositoryPath | string |
Gets or sets the location of the source code repository.
|
Restore | bool |
Gets or sets a value indicating whether perform a restore.
|
RestoreFilePath | string |
Gets or sets the restore file path.
|
Run |
string |
Gets or sets the folder name for 'runAfterCreateDatabase' scripts.
|
Run |
string |
Gets or sets the folder name for 'runAfterOtherAnyTimeScripts' scripts.
|
RunAllAnyTimeScripts | bool |
Gets or sets a value indicating whether to execute any time scripts.
|
Run |
string |
Gets or sets the folder name for 'runBeforeUp' scripts.
|
Run |
string |
Gets or sets the folder name for 'runFirstAfterUp' scripts.
|
SchemaName | string |
Gets or sets the schema name to use instead of [RoundhousE].
|
Search |
bool |
Gets or sets a value indicating whether to search all subdirectories.
|
ServerName | string |
Gets or sets the server name.
|
SetupProcessSettings | Action |
Gets or sets a delegate to configure the process settings.
Inherited from ToolSettings
|
Silent | bool |
Gets or sets a value indicating whether to keep RH silent.
|
SprocsFolderName | string |
Gets or sets the folder name for 'sprocs' scripts.
|
SqlFilesDirectory | string |
Gets or sets the sql files directory.
|
ToolPath | FilePath |
Gets or sets the tool path.
Inherited from ToolSettings
|
ToolTimeout | TimeSpan? |
Gets or sets optional timeout for tool execution.
Inherited from ToolSettings
|
UpFolderName | string |
Gets or sets the folder name for 'up' scripts.
|
VersionFile | string |
Gets or sets the version file.
|
VersionXPath | string |
Gets or sets the XPath to locate version in the
VersionFile .
|
ViewsFolderName | string |
Gets or sets the folder name for 'views' scripts.
|
Warn |
bool |
Gets or sets a value indicating whether to warn when previously run scripts have changed.
|
WithTransaction | bool |
Gets or sets a value indicating whether to use transactions.
|
WorkingDirectory | DirectoryPath |
Gets or sets the working directory for the tool process.
Inherited from ToolSettings
|
Extension Methods
Name | Value | Summary |
---|---|---|
Dump |
string |
Get a basic string representation of specified object.
From LoggingExtensions
Requires the Cake.Incubator addin
|
IsIn |
bool |
Checks if the source is contained in a list
From EnumerableExtensions
Requires the Cake.Incubator addin
|
NotNull |
void |
From IssuesArgumentChecks
Requires the Cake.Issues addin
|
NotNull |
void |
Throws an exception if the specified parameter's value is null.
From Extensions
Requires the Cake.Ftp addin
|
ThrowIfNull |
T |
Throws a
System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
ThrowIfNull |
T |
Throws a
System.ArgumentNullException if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
ToDictionary |
IDictionary |
From ObjectHelpers
Requires the Cake.DeployParams addin
|
To |
string |
From StringExtensions
Requires the Cake.Issues addin
|
With |
T |
Sets the tool argument customization delegate.
|
With |
T |
Sets or adds tool environment variable.
|
WithExpectedExitCode |
T |
Sets expected exit code using
WithHandleExitCode<T>(T, Func<int, bool>) .
|
WithHandleExitCode |
T |
Sets delegate whether the exit code from the tool process causes an exception to be thrown.
|
With |
T |
Sets whether the tool should use a working directory or not.
|
WithPostAction |
T |
Sets a delegate which is executed after the tool process was started.
|
With |
T |
Sets a delegate to configure the process settings.
|
WithToolPath |
T |
Sets the tool path.
|
WithToolSettings |
T |
Provides fluent null guarded tool settings action.
|
WithToolTimeout |
T |
Sets the tool timeout.
|
WithWorkingDirectory |
T |
Sets the tool working directory.
|