Class UpgradeDatabseParameter
The server task parameters for the upgrade database calculation processs
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
System.Object
UpgradeDatabseParameter
Implements
System.ComponentModel.INotifyPropertyChanged
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Assembly: 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 UpgradeDatabseParameter : ServerTaskParameter, ICloneable, INotifyPropertyChanged
Constructors
UpgradeDatabseParameter()
Creates a new upgrade database server task process parameter
Declaration
public UpgradeDatabseParameter()
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 |
System.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 |
System.Boolean |
|
Methods
Clone()
Declaration
public UpgradeDatabseParameter Clone()
Returns
CopyFromParam(SerializedParam)
Declaration
protected override void CopyFromParam(SerializedParam source)
Parameters
Overrides
CopyFromSource(UpgradeDatabseParameter)
Declaration
public void CopyFromSource(UpgradeDatabseParameter source)
Parameters
CreateNewParam()
Declaration
protected override SerializedParam CreateNewParam()
Returns
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 |
System.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 |
System.String |
propName |
|
Events
PropertyChanged
Declaration
public event PropertyChangedEventHandler PropertyChanged
Event Type
Type |
Description |
System.ComponentModel.PropertyChangedEventHandler |
|
Implements
System.ComponentModel.INotifyPropertyChanged
Extension Methods