Interface WAKData

Hierarchy

WAKData
- Application

Index

Properties

ds
model

Methods

Properties

ds

References the datastore of the application.

model

model: WakModel

References the model object of the application

Methods

backupDataStore

backupDataStore(model: WAKFileInstance, data: WAKFileInstance, settings: Object, options?: Object): WAKFileInstance

- Defined in application.d.ts:50
Starts the backup of the closed datastore defined by model and data.

Parameters
- model: WAKFileInstance
- data: WAKFileInstance
- settings: Object
- Optional options: Object
Returns WAKFileInstance

compactDataStore

compactDataStore(model: WAKFileInstance, data: WAKFileInstance, options?: Object, compactedData?: WAKFileInstance): void

- Defined in application.d.ts:54
Compacts the datastore's data file designated by model and data, and generates the compactedData data file.

Parameters
- model: WAKFileInstance
- data: WAKFileInstance
- Optional options: Object
- Optional compactedData: WAKFileInstance
Returns void

getBackupRegistry

getBackupRegistry(registryFolder: WAKFolderInstance): Array<Object>

- Defined in application.d.ts:58
Returns an Array that lists the 20 most recent backup manifests recorded in the specified backup registry.

Parameters
- registryFolder: WAKFolderInstance
Returns Array<Object>

getBackupSettings

getBackupSettings(): Object

- Defined in application.d.ts:62
Returns an Object containing the default backup settings for the solution.

Returns Object

getJournalInfo

getJournalInfo(dataFile: WAKFileInstance, options?: Object): Object
getJournalInfo(dataFile: String, options?: Object): Object

- Defined in application.d.ts:66
Returns information about the journal of the datastore whose data file you passed in dataFile.

Parameters
- dataFile: WAKFileInstance
- Optional options: Object
Returns Object
- Defined in application.d.ts:70
Returns information about the journal of the datastore whose data file you passed in dataFile.

Parameters
- dataFile: String
- Optional options: Object
Returns Object

getLastBackups

getLastBackups(): Array<Object>

- Defined in application.d.ts:74
Returns an Array that lists the 20 most recent backup manifests recorded in the backup registry default folder of the application.

Returns Array<Object>

integrateDataStoreJournal

integrateDataStoreJournal(model: WAKFileInstance, data: WAKFileInstance, journal: WAKFileInstance, options?: Object): Object

- Defined in application.d.ts:78
Allows you to partially or fully integrate a journal file into a datastore.

Parameters
- model: WAKFileInstance
- data: WAKFileInstance
- journal: WAKFileInstance
- Optional options: Object
Returns Object

repairDataStore

repairDataStore(model: WAKFileInstance, data: WAKFileInstance, options?: Object, repairedData?: WAKFileInstance): void

- Defined in application.d.ts:82
Repairs the datastore's data file defined by model and data, and generates the repairedData data file.

Parameters
- model: WAKFileInstance
- data: WAKFileInstance
- Optional options: Object
- Optional repairedData: WAKFileInstance
Returns void

resetDataStoreJournal

resetDataStoreJournal(dataFile: WAKFileInstance): Object
resetDataStoreJournal(dataFile: String): Object

- Defined in application.d.ts:86
Resets the current journal of the datastore whose data file you passed in dataFile.

Parameters
- dataFile: WAKFileInstance
Returns Object
- Defined in application.d.ts:90
Resets the current journal of the datastore whose data file you passed in dataFile.

Parameters
- dataFile: String
Returns Object

restoreDataStore

restoreDataStore(manifest: WAKFileInstance, restoreFolder: WAKFolderInstance, options?: Object): Object
restoreDataStore(config: Object, options?: Object): Object

- Defined in application.d.ts:94
Allows you to restore a data folder previously archived.

Parameters
- manifest: WAKFileInstance
- restoreFolder: WAKFolderInstance
- Optional options: Object
Returns Object
- Defined in application.d.ts:98
Allows you to restore a data folder previously archived.

Parameters
- config: Object
- Optional options: Object
Returns Object

verifyDataStore

verifyDataStore(model: WAKFileInstance, data: WAKFileInstance, options: Object): void

- Defined in application.d.ts:102
Verifies the internal structure of the objects contained in the datastore designated by model and data.

Parameters
- model: WAKFileInstance
- data: WAKFileInstance
- options: Object
Returns void