This package provides access to the configuration database of the pipeline module.
|
| | 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.initialise_atomic_counter (var symbol, var key, var initial_value) |
| | Initialise an atomic counter. More...
|
| |
| | database.increment_atomic_counter (var symbol, var key, var count) |
| | Increment an atomic counter. More...
|
| |
| | database.decrement_atomic_counter (var symbol, var key, var count) |
| | Decrement an atomic counter. More...
|
| |
| | database.delete_atomic_counter (var symbol, var key) |
| | Delete an atomic counter. More...
|
| |
| database.decrement_atomic_counter |
( |
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
-
| value | after 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.increment_atomic_counter and database.decrement_atomic_counter
| 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.delete_atomic_counter |
( |
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.deleteall |
( |
var |
symbol | ) |
|
Delete all database entries matching the symbol.
- Parameters
-
| symbol | - Symbol to lookup on |
- Returns
- Nothing
| 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
-
| database.increment_atomic_counter |
( |
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
-
| value | after 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.increment_atomic_counter and database.decrement_atomic_counter
| database.initialise_atomic_counter |
( |
var |
symbol, |
|
|
var |
key, |
|
|
var |
initial_value |
|
) |
| |
Initialise an atomic counter.
- Parameters
-
| symbol | - Symbol to store under |
| key | - Parameter to insert |
| initial_value | - 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.increment_atomic_counter and database.decrement_atomic_counter
| 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
