Table of Contents
List of Examples
This module is an implementation of a cache system designed to work with a Couchbase server. It uses the libcouchbase client library to connect to the server instance, It uses the Key-Value interface exported from the core.
memory costs are no longer on the server
many servers can be used inside a cluster, so the memory is virtually unlimited
the cache is 100% persistent. A restart of OpenSIPS server will not affect the DB. The CouchBase DB is also persistent so it can also be restarted without loss of information.
CouchBase is an open-source project so it can be used to exchange data with various other applicationsr
By creating a CouchBase Cluster, multiple OpenSIPS instances can easily share key-value information
The urls of the server groups that OpenSIPS will connect to in order to use the from script cache_store,cache_fetch, etc operations. It can be set more than one time. The prefix part of the URL will be the identifier that will be used from the script. The format of the URL is couchbase[:identifier]://[username:password@]IP:Port/bucket_name
Example 1.1. Set cachedb_url parameter
...
modparam("cachedb_couchbase", "cachedb_url","couchbase:group1://localhost:6379/default");
modparam("cachedb_couchbase", "cachedb_url","couchbase:cluster1://random_url:8888/my_bucket");
#Multiple hosts
modparam("cachedb_couchbase", "cachedb_url","couchbase:cluster1://random_url1:8888;random_url2:8888;random_url3:8888/my_bucket");
...
The max duration in microseconds that a couchbase op is expected to last. Default is 3000000 ( 3 seconds )
Example 1.3. Use CouchBase servers
...
cache_store("couchbase:group1","key","$ru value");
cache_fetch("couchbase:cluster1","key",$avp(10));
cache_remove("couchbase:cluster1","key");
...