cachedb_local Module

The following modules must be loaded before this module:

The following libraries or applications must be installed before running OpenSIPS with this module loaded:

URLs of local cache groups to be used used for the script and MI cacheDB operations. The parameter can be set multiple times.

One collection can belong to multiple URLs, but one URL can have only one collection. Redefining an URL with the same schema and group name will result in overwriting that URL. Each collection used in URL definition must be defined using cachedb_collection parameter. The collection shall be defined as a normal database, at the end of the URL as in the examples. In the script the collection shall be identified using the schema and, if exists, the group name.

“If no URL defined, the url with no group name and collection "default" will be used.”.

...
### for this example, if no collection is defined, the default collection named
### "default" shall be used
modparam("cachedb_local", "cachedb_url", "local://")
### this URL will use the collection named collection1; it will overwrite the
### previous url definition which was using the "default" collection
modparam("cachedb_local", "cachedb_url", "local:///collection1")
### this URL will use collection2; it will be referenced from the script
### with "local:group2"
modparam("cachedb_local", "cachedb_url", "local:group2:///collection2")

## how to use the URLs from the script
## as defined above, this call will use collection1
cache_store("local", ...)
## as defined above, this call will use collection2
cache_store("local:group2", ...)
...
	

Using this parameter, collections(hash tables) and their sizes can be defined. Each collection definition must be separated one from another using ';'. Default size for a hash is 512. The size must be separated from the name of the collection using '='.

If clustering is enabled you have to specify which collections you want to replicate with the /r suffix to the collection name.

The "default" collection always gets created, even when not included in this list of collections.

...
## creating collection1 with default size (512) and collection2 with custom size
## 2^5 (32); we also changed the size of the default collection, which would have been
## created anyway from 2^9 - 512 (default value) to 2^4 - 16
## also, collection1 and collection2 will be replicated in the cluster, while the
## default collection will be local to this node
modparam("cachedb_local", "cache_collections", "collection1/r; collection2/r = 5; default = 4")
...
	

The time interval in seconds at which to go through all the records and delete the expired ones.

Default value is “600 (10 minutes)”.

...
modparam("cachedb_local", "cache_clean_period", 1200)
...
	

Specifies the cluster ID which this instance will send to and receive cache data.

This OpenSIPS cluster exposes the "cachedb-local-repl" capability in order to mark nodes as eligible for becoming data donors during an arbitrary sync request. Consequently, the cluster must have at least one node marked with the "seed" value as the clusterer.flags column/property in order to be fully functional. Consult the clusterer - Capabilities chapter for more details.

Default value is 0 (replication disabled).

...
modparam("cachedb_local", "cluster_id", 1)
...
		

Controls the behavior of the OpenSIPS local cachedb clustering following a restart.

This parameter may take the following values:

Default value is "sync-from-cluster".

...
modparam("cachedb_local", "cluster_persistency", "sync-from-cluster")
...
		

Enable restart persistency using the persistent memory mechanism. Data is stored in a cache file that is mapped against OpenSIPS memory.

Note that you have to keep the same collection definitions from a previous run in order to use the cached data for the respective collections.

If cluster persistency is enabled as well, keys loaded from the persistent cache will be discarded if they are not received in the cluster sync data.

Default value is “0 (disabled)”.

...
modparam("cachedb_local", "enable_restart_persistency", yes)
...

Remove all keys from local cache that match the glob pattern corresponding to a certain collection or the 'default' collection if none defined. Keep in mind that collection name is different than group name, which identifies the engine in cachedb operations.

Parameters:

This function can be used from all routes

	...
	cache_remove_chunk("myinfo_*");
	cache_remove_chunk("collection1", "myinfo_*");
	...
	

Removes all local cache entries that match the provided glob param.

Parameters :

MI FIFO Command Format:

opensips-cli -x mi cache_remove_chunk "keyprefix*" collection
		

Fetches all local cache entries that match the provided glob param.

Parameters :

MI FIFO Command Format:

opensips-cli -x mi cache_fetch_chunk "keyprefix*" collection
{
    "keys": [
        {
            "name": "keyprefix_1",
            "value": "key 1 data here"
        },
        {
            "name": "keyprefix_2",
            "value": "key 2 data here"
        }
    ]
}