GrateSettings Class

Summary

Contains settings used by GrateRunner.
Assembly
Cake.grate.dll
Namespace
Cake.Grate
Base Types
  • ToolSettings
graph BT Type-->Base0["ToolSettings"] Type["GrateSettings"] class Type type-node

Syntax

public sealed class GrateSettings : ToolSettings

Constructors

Name Summary
GrateSettings()

Properties

Name Value Summary
AccessToken string
Gets or sets the access token to use.
Baseline bool
Gets or sets a value indicating whether to create an insert for its recording tables, but not run anything.
CommandTimeout Nullable<int>
Gets or sets the timeout (in seconds) for normal connections.
CommandTimeoutAdmin Nullable<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.
DatabaseType string
Gets or sets database type.
DisableTokenReplacement bool
Gets or sets a value indicating whether to perform token replacement.
DoNotStoreScriptsRunText bool
Gets or sets a value indicating whether to store script text.
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 grate to be scoped.
Folders string
Gets or sets the Folder configuration. See Grate website for documentation.
IsUpToDate bool
Gets or sets a value indicating whether to check if the database is up to date or not.
OutputPath string
Gets or sets the output path.
RepositoryPath string
Gets or sets the repository path value used to track along with version.
Restore string
Gets or sets the restore file path.
RunAllAnyTimeScripts bool
Gets or sets a value indicating whether to execute any time scripts.
SchemaName string
Gets or sets the schema name to use instead of [grate].
Silent bool
Gets or sets a value indicating whether to keep grate silent.
SqlFilesDirectory string
Gets or sets the sql files directory.
UserTokens IDictionary<string, string>
Gets or sets a dictionary of user tokens.
Version string
Gets or sets the version file.
WarnAndIgnoreOnOneTimeScriptChanges bool
Gets or sets a value indicating whether to warn and update when previously run one time run 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.

Extension Methods

Name Value Summary
Dump<GrateSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<GrateSettings>(GrateSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<GrateSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
NotNull<GrateSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
ThrowIfNull<GrateSettings>(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
ThrowIfNull<GrateSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin
ToStringWithNullMarkup() string
Returns the string value or a Not set> markup suitable for Spectre.Console.
Requires the Cake.Issues addin
WithUserToken(string, string) GrateSettings
Adds a UserToken to the settings.
Requires the Cake.grate addin