RoundhouseSettings Class

Summary

Contains settings used by RoundhouseRunner.
Namespace
Cake.Common.Tools.Roundhouse
Base Types
graph TD Base0["ToolSettings"]-->Type click Base0 "/api/Cake.Core.Tooling/ToolSettings" Base1["object"]-->Base0 Type["RoundhouseSettings"] class Type type-node

Syntax

public sealed class RoundhouseSettings : ToolSettings

Properties

Name Value Summary
AfterMigrationFolderName string
Gets or sets the folder name for 'afterMig' scripts.
AlterDatabaseFolderName string
Gets or sets the folder name for 'alterDatabase' scripts.
ArgumentCustomization Func<ProcessArgumentBuilder, ProcessArgumentBuilder>
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.
BeforeMigrationFolderName 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.
ConnectionStringAdmin string
Gets or sets the connection string for admin connections.
CreateDatabaseCustomScript 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.
DisableTokenReplacement 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<string, string>
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.
IndexesFolderName string
Gets or sets the folder name for 'indexes' scripts.
OutputPath string
Gets or sets the output path.
PermissionsFolderName string
Gets or sets the folder name for 'permissions' scripts.
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.
RunAfterCreateDatabaseFolderName string
Gets or sets the folder name for 'runAfterCreateDatabase' scripts.
RunAfterOtherAnyTimeScriptsFolderName string
Gets or sets the folder name for 'runAfterOtherAnyTimeScripts' scripts.
RunAllAnyTimeScripts bool
Gets or sets a value indicating whether to execute any time scripts.
RunBeforeUpFolderName string
Gets or sets the folder name for 'runBeforeUp' scripts.
RunFirstAfterUpFolderName string
Gets or sets the folder name for 'runFirstAfterUp' scripts.
SchemaName string
Gets or sets the schema name to use instead of [RoundhousE].
SearchAllSubdirectoriesInsteadOfTraverse bool
Gets or sets a value indicating whether to search all subdirectories.
ServerName string
Gets or sets the server name.
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.
WarnOnOneTimeScriptChanges 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<RoundhouseSettings>() string
Get a basic string representation of specified object.
ThrowIfNull<RoundhouseSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
ThrowIfNull<RoundhouseSettings>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value