Transformer Pipeline Module API Reference (JavaScript)  7.1.8.29710-170e587
Configuration database access

Detailed Description

This package provides access to the configuration database of the pipeline module.

Functions

 database.get (var symbol, var key)
 Obtain a value from the configuration database. More...
 
 database.put (var symbol, var key, var value)
 Insert a value into the configuration database. More...
 
 database.delete (var symbol, var key)
 Delete a value from the configuration database. More...
 
 database.deleteAll (var symbol)
 Delete all database entries matching the symbol. More...
 
 database.initAtomicCounter (var symbol, var key, var initialValue)
 Initialise an atomic counter. More...
 
 database.incAtomicCounter (var symbol, var key, var count)
 Increment an atomic counter. More...
 
 database.decAtomicCounter (var symbol, var key, var count)
 Decrement an atomic counter. More...
 
 database.deleteAtomicCounter (var symbol, var key)
 Delete an atomic counter. More...
 

Function Documentation

database.decAtomicCounter ( var  symbol,
var  key,
var  count 
)

Decrement an atomic counter.

Parameters
symbol- Symbol to store under
key- Parameter to insert
count- (Optional) deccrement
Return values
valueafter decrement - Success
nil- Failure (could not decrement)

This function will decrement an atomic counter. A call to this function is guaranteed not to interleave with other calls to database.incAtomicCounter and database.decAtomicCounter

database.delete ( var  symbol,
var  key 
)

Delete a value from the configuration database.

Parameters
symbol- Symbol to lookup on
key- Parameter to delete
Returns
Nothing
database.deleteAll ( var  symbol)

Delete all database entries matching the symbol.

Parameters
symbol- Symbol to lookup on
Returns
Nothing
database.deleteAtomicCounter ( var  symbol,
var  key 
)

Delete an atomic counter.

Parameters
symbol- Symbol to delete
key- Parameter to delete
Return values
0- Success
nil- Failure (could not delete)

This function will delete an atomic counter.

database.get ( var  symbol,
var  key 
)

Obtain a value from the configuration database.

Parameters
symbol- Symbol to lookup on
key- Parameter to obtain
Returns
The database entry
Return values
nil- No value found
database.incAtomicCounter ( var  symbol,
var  key,
var  count 
)

Increment an atomic counter.

Parameters
symbol- Symbol to store under
key- Parameter to insert
count- (Optional) increment
Return values
valueafter increment - Success
nil- Failure (could not increment)

This function will increment an atomic counter. A call to this function is guaranteed not to interleave with other calls to database.incAtomicCounter and database.decAtomicCounter

database.initAtomicCounter ( var  symbol,
var  key,
var  initialValue 
)

Initialise an atomic counter.

Parameters
symbol- Symbol to store under
key- Parameter to insert
initialValue- Value to initialise counter with, optional, defaults to 0.
Returns
Initial value - Success
Return values
nil- Failure (could not initialise)

This function will initialise an atomic counter. The counter can only be modified by the functions database.incAtomicCounter and database.decAtomicCounter

database.put ( var  symbol,
var  key,
var  value 
)

Insert a value into the configuration database.

Parameters
symbol- Symbol to lookup on
key- Parameter to insert
value- Value to insert
Returns
Nothing

Generated on Tue May 12 2020 16:10:25 for Transformer Pipeline Module API Reference (JavaScript)