AliaSqlSettings Class

Summary

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

Syntax

public class AliaSqlSettings : ToolSettings

Constructors

Name Summary
AliaSqlSettings()

Properties

Name Value Summary
Command string
The AliaSql command to run. (ex: TestData, Rebuild)
ConnectionString string
The Connection String to connect to the target database.
DatabaseName string
The database to run scripts against.
Password string
The password used for authenticating with the database.
ScriptsFolder DirectoryPath
The scripts folder containing Create, Update, and/or TestData scripts.
UserName string
The username used for authenticating with the database.

Extension Methods

Name Value Summary
Dump<AliaSqlSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<AliaSqlSettings>(AliaSqlSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<AliaSqlSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<AliaSqlSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<AliaSqlSettings>(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<AliaSqlSettings>(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