Database(system, cfgDir, defaults)

The class that manages the applications's main database

new Database(system, cfgDir, defaults)
lib/Data/Database.js, line 30

Create a new application flat file DB controller
Parameters:
Name Type Description
system EventEmitter the application's event emitter
cfgDir string the directory the flat file will be saved
defaults Array.<Object> the default data to use when making a new file
Since:
  • 1.0.4
Author:

Extends

Members

protected debug :debug.Debugger
lib/Data/Database.js, line 44

The debugger for this class

protected registry :Registry
lib/Data/Database.js, line 51

the core registry

SaveInterval :number
lib/Data/Database.js, line 37

The default minimum interval in ms to save to disk (4000 ms)

Methods

deleteKey(key)
lib/Data/StoreBase.js, line 65

Delete a key/value pair
Parameters:
Name Type Description
key string the key to be delete
Overrides:

getAll(cloneopt) → {Array.<Object>}
lib/Data/StoreBase.js, line 79

Get the entire database
Parameters:
Name Type Attributes Default Description
clone boolean <optional>
 false `true` if a clone is needed instead of a link
Returns:
Array.<Object> - the database
Overrides:

getCfgDir() → {string}
lib/Data/StoreBase.js, line 97

Returns:
string - the directory of the flat file
Overrides:

getKey(key, defaultValuenullable, cloneopt)
lib/Data/StoreBase.js, line 108

Get a value from the database
Parameters:
Name Type Attributes Default Description
key string the key to be retrieved
defaultValue Array.<Object> <nullable>
 the default value to use if the key doesn't exist
clone boolean <optional>
 false `true` if a clone is needed instead of a link
Overrides:

protected load()
lib/Data/StoreBase.js, line 131

Attempt to load the database from disk
Overrides:

protected loadBackup(cfgBakFile)
lib/Data/StoreBase.js, line 177

Attempt to load the backup file from disk as a recovery
Parameters:
Name Type Description
cfgBakFile string the full file path
Overrides:

protected loadDefaults()
lib/Data/StoreBase.js, line 207

Save the defaults since a file could not be found/loaded/parses
Overrides:

protected save(withBackupopt)
lib/Data/StoreBase.js, line 219

Save the database to file
Parameters:
Name Type Attributes Default Description
withBackup boolean <optional>
 true can be set to `false` if the current file should not be moved to `FILE.bak`
Overrides:

protected saveMain()
lib/Data/StoreBase.js, line 243

Save the database to file making a `FILE.bak` version then moving it into place
Overrides:

setDirty()
lib/Data/StoreBase.js, line 271

Register that there are changes in the database that need to be saved as soon as possible
Overrides:

setKey(key, value)
lib/Data/StoreBase.js, line 281

Save/update a key/value pair to the database
Parameters:
Name Type Description
key number | string the key to save under
value Object the object to save
Overrides:

setKeys(keyvalueobj)
lib/Data/StoreBase.js, line 295

Save/update multiple key/value pairs to the database
Parameters:
Name Type Description
keyvalueobj Array.<(number|string), Object> the key to save under
Overrides:

protected setSaveCycle()
lib/Data/StoreBase.js, line 312

Setup the save cycle interval
Overrides: