Class CompareDatabaseParameters

The server task parameters for comparing databases

Holds the parameter for another database alias to compare this current database to

Compares all tables between two databases and results on any differences by table/key.
Inheritance
object
SerializedParam
ServerTaskParameter
CompareDatabaseParameters
Implements
Inherited Members
Namespace: LemonEdge.API.Core.Tasks.Parameters
Assembly: LemonEdge.API.dll
Syntax
[DataContract]
[ServerTaskParameters("Compare Databases", "1B830EBD-35B2-4400-9A04-A21A48FC2CFB", Description = "Compares all tables between two databases and results on any differences by table/key.")]
public class CompareDatabaseParameters : ServerTaskParameter, ICloneable, ICloneable<CompareDatabaseParameters>, INotifyPropertyChanged

Constructors

CompareDatabaseParameters()

Declaration
public CompareDatabaseParameters()

Fields

UNIQUE_TASK_ID

The unique id of the compare databases calculation server task

Declaration
public const string UNIQUE_TASK_ID = "1B830EBD-35B2-4400-9A04-A21A48FC2CFB"
Field Value
Type Description
string

Properties

DatabaseAlias

The database alias to connect to and compare to the current system.

If this is running from a service this needs to be one of the database aliases that service connects to.

If directly connected to the database, this can be a name of a database on the same server
Declaration
public string DatabaseAlias { get; set; }
Property Value
Type Description
string

Methods

Clone()

Creates a new instance of this class (of type CompareDatabaseParameters) with all the same property values as this instance

Declaration
public CompareDatabaseParameters Clone()
Returns
Type Description
CompareDatabaseParameters

A new instance of this class with all the same property values as this instance

CopyFromParam(SerializedParam)

Should be overridden by inheriting implementations to ensure all parameters values are copied from the specified source

Declaration
protected override void CopyFromParam(SerializedParam source)
Parameters
Type Name Description
SerializedParam source

The source instance of a SerializedParam that is of the same type as this one to copy parameter values from
Overrides
Remarks

Used by the generic implementation of Clone()

CopyFromSource(CompareDatabaseParameters)

Updates all properties in this item to have the same properties as the source object.

Declaration
public void CopyFromSource(CompareDatabaseParameters source)
Parameters
Type Name Description
CompareDatabaseParameters source

The source object to copy all values from.

CreateNewParam()

Must be implemented by inheriting classes to provide a new instance of the current class type.

Used when cloning this SerializedParam to create a new instance of the same type

Declaration
protected override SerializedParam CreateNewParam()
Returns
Type Description
SerializedParam

A new instance of the current SerializedParam type
Overrides

GetUserFriendlyTaskInstanceIdentityInfo(IServerTask)

Returns that this is a compare database task against the specified database alias

Declaration
public override string GetUserFriendlyTaskInstanceIdentityInfo(IServerTask task)
Parameters
Type Name Description
IServerTask task

The server task for processing this algorithm
Returns
Type Description
string

A string stating that this is a compare database task against the specified database alias
Overrides

Events

PropertyChanged

Declaration
public event PropertyChangedEventHandler PropertyChanged
Event Type
Type Description
PropertyChangedEventHandler

Implements

Extension Methods