BackupDatabaseSettings Class

Summary

Settings for backing up database to a file
Assembly
Cake.SqlServer.dll
Namespace
Cake.SqlServer
Base Types
  • Object
graph BT Type-->Base0["Object"] Type["BackupDatabaseSettings"] class Type type-node

Syntax

public class BackupDatabaseSettings

Constructors

Name Summary
BackupDatabaseSettings() Default constructor. Sets Compress to true.

Properties

Name Value Summary
Compress bool
Sets the flag to execute backup and create a compressed file
Path string
Gets or sets the backup file path. This can either be a file or a folder

Extension Methods

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