Class UpgradeDatabaseParameter

The server task parameters for the upgrade database calculation process

Forces a comparrison of the database with the current loaded entity schema and upgrades the database if any changes from API AddIns are required.

Inheritance
object
SerializedParam
ServerTaskParameter
UpgradeDatabaseParameter
Implements
Inherited Members
Namespace: LemonEdge.API.Core.Tasks.Parameters
Assembly: LemonEdge.API.dll
Syntax
[DataContract]
[ServerTaskParameters("Upgrade Database", "0B63C444-1127-4631-805D-3ADA803F0288", Description = "Forces a comparrison of the database with the current loaded entity schema and upgrades the database if any changes from API AddIns are required.")]
public class UpgradeDatabaseParameter : ServerTaskParameter, ICloneable, INotifyPropertyChanged

Constructors

UpgradeDatabaseParameter()

Declaration
public UpgradeDatabaseParameter()

Fields

UNIQUE_TASK_ID

The unique id of the upgrade database server task

Declaration
public const string UNIQUE_TASK_ID = "0B63C444-1127-4631-805D-3ADA803F0288"
Field Value
Type Description
string

Properties

Force

Indicates if the database upgrade process should run even if the system does not detect and schema changes to upgrade

This will still force the system to drop all functions/sps,etc and recreate everything anyway even if there are no changes for it to update on the actual entity database tables

Declaration
public bool Force { get; set; }
Property Value
Type Description
bool

Methods

Clone()

Declaration
public UpgradeDatabaseParameter Clone()
Returns
Type Description
UpgradeDatabaseParameter

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(UpgradeDatabaseParameter)

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

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 an upgrade database server task

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

The server task for processing the upgrade database
Returns
Type Description
string

A string stating that this is an upgrade database server task
Overrides

OnPropChanged(string)

Declaration
protected void OnPropChanged(string propName)
Parameters
Type Name Description
string propName

Events

PropertyChanged

Declaration
public event PropertyChangedEventHandler PropertyChanged
Event Type
Type Description
PropertyChangedEventHandler

Implements

Extension Methods