Interface ICustomUpgradeVersionHandler
With custom addins this provids a mechanism to record version numbers representing the state the database is in, and if upgrades are required
Namespace: LemonEdge.API.Migrations.Core
Assembly: API.dll
Syntax
public interface ICustomUpgradeVersionHandlerMethods
GetAccountGlobalSystemValue<T>(String, T)
Returns the value of the specified key for the whole database
Declaration
Task<T> GetAccountGlobalSystemValue<T>(string key, T defaultValue)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | key | The unique key of the value to return. Typically the name of a custom AddIn module for custom upgrade processes. |
| T | defaultValue | The default value to return if there is no value currently |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<T> | A task holding the result of the specified setting in the database |
Type Parameters
| Name | Description |
|---|---|
| T | The type of value to return. Typically an int if dealing with incrementing version numbers. |
SetAccountGlobalSystemValue<T>(String, T)
Sets the new value of the specified key for the whole database
Declaration
Task SetAccountGlobalSystemValue<T>(string key, T value)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | key | The unique key of the value to update. Typically the name of a custom AddIn module for custom upgrade processes. |
| T | value | The new value to set the database setting too |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | A task representing the completion of the operation |
Type Parameters
| Name | Description |
|---|---|
| T | The type of value to update. Typically an int if dealing with incrementing version numbers. |