Transformer Pipeline Module API Reference  6.2.11.309924
Persistence Module: Pipeline Functions

Functions

 persist_query (var query)
 Query the Database for matching values. More...
 
 persist_store (var key, var value)
 Store a value in the persistence Database. More...
 
 persist_remove (var key)
 Remove a value in the persistence Database. More...
 
 persist_get (var key)
 Retrieve a value from the persistence Database. More...
 

Detailed Description

The persistence module if loaded exposes some methods to pipelines to enable control the persistence of data.

Note
The methods in this package are only available if the persistence module is loaded.

Function Documentation

persist_get ( var  key)

Retrieve a value from the persistence Database.

Parameters
key- Key whose value is being retrieved.
Return values
Databasevalue
persist_query ( var  query)

Query the Database for matching values.

Parameters
query- A prefix to the keys of the elements to be retrieved.
Returns
An array of matching values for the query.
persist_remove ( var  key)

Remove a value in the persistence Database.

Parameters
key- Key whose value is being removed.
persist_store ( var  key,
var  value 
)

Store a value in the persistence Database.

Parameters
key- Key whose value is being stored.
value- Value to store.

Generated on Sat Aug 26 2017 12:36:33 for Transformer Pipeline Module API Reference