cachedb_couchbase Module

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.

1.2. Advantages

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 applications
By creating a CouchBase Cluster, multiple OpenSIPS instances can easily share key-value information

1.3. Limitations

keys (in key:value pairs) may not contain spaces or control characters

1.4. Dependencies

1.4.1. OpenSIPS Modules

None.

1.4.2. External Libraries or Applications

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

libcouchbase >= 2.0:
libcoucbase can be downloaded from http://www.couchbase.com/develop/c/current

1.5. Exported Parameters

1.5.1. `cachedb_url` (string)

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")
...

1.5.2. `timeout` (int)

The max duration in microseconds that a couchbase op is expected to last. Default is 3000000 ( 3 seconds )

Example 1.2. Set timeout parameter

...
modparam("cachedb_couchbase", "timeout",5000000);
...

1.5.3. `exec_threshold` (int)

The maximum number of microseconds that a couchbase query can last. Anything above the threshold will trigger a warning message to the log

Default value is “0 ( unlimited - no warnings )”.

Example 1.3. Set exec_threshold parameter

...
modparam("cachedb_couchbase", "exec_threshold", 100000)
...

1.5.4. `lazy_connect` (int)

Delay connecting to a bucket until the first time it is used. Connecting to many buckets at startup can be time consuming. This option allows for faster startup by delaying connections until they are needed. This option can be dangerous for untested bucket configurations/settings. Always test first without lazy_connect. This option will show errors in the log during the first access made to a bucket. Default is 0 ( Connect to all buckets on startup )

Example 1.4. Set lazy_connect parameter

...
modparam("cachedb_couchbase", "lazy_connect", 1);
...

Example 1.5. Use CouchBase servers

...
cache_store("couchbase:group1","key","$ru value");
cache_fetch("couchbase:cluster1","key",$avp(10));
cache_remove("couchbase:cluster1","key");
...

1.5.5. Exported Functions

The module does not export functions to be used in configuration script.

Chapter 2. Contributors

2.1. By Commit Statistics

Table 2.1. Top contributors by DevScore⁽¹⁾, authored commits⁽²⁾ and lines added/removed⁽³⁾

	Name	DevScore	Commits	Lines ++	Lines --
1.	Vlad Paiu (@vladpaiu)	21	8	1146	151
2.	Razvan Crainea (@razvancrainea)	10	8	100	19
3.	Liviu Chircu (@liviuchircu)	10	7	96	89
4.	Ryan Bullock (@rrb3942)	6	2	230	87
5.	Bogdan-Andrei Iancu (@bogdan-iancu)	5	3	3	5
6.	Maksym Sobolyev (@sobomax)	4	2	3	3
7.	Julián Moreno Patiño	3	1	1	1
8.	Peter Lemenkov (@lemenkov)	3	1	1	1
9.	Vlad Patrascu (@rvlad-patrascu)	2	1	1	0

(1) DevScore = author_commits + author_lines_added / (project_lines_added / project_commits) + author_lines_deleted / (project_lines_deleted / project_commits)

(2) including any documentation-related commits, excluding merge commits. Regarding imported patches/code, we do our best to count the work on behalf of the proper owner, as per the "fix_authors" and "mod_renames" arrays in opensips/doc/build-contrib.sh. If you identify any patches/commits which do not get properly attributed to you, please submit a pull request which extends "fix_authors" and/or "mod_renames".

(3) ignoring whitespace edits, renamed files and auto-generated files

2.2. By Commit Activity

Table 2.2. Most recently active contributors⁽¹⁾ to this module

	Name	Commit Activity
1.	Maksym Sobolyev (@sobomax)	Feb 2023 - Feb 2023
2.	Bogdan-Andrei Iancu (@bogdan-iancu)	Oct 2014 - Mar 2020
3.	Razvan Crainea (@razvancrainea)	Aug 2015 - Sep 2019
4.	Liviu Chircu (@liviuchircu)	Mar 2014 - Apr 2019
5.	Peter Lemenkov (@lemenkov)	Jun 2018 - Jun 2018
6.	Vlad Patrascu (@rvlad-patrascu)	May 2017 - May 2017
7.	Julián Moreno Patiño	Feb 2016 - Feb 2016
8.	Ryan Bullock (@rrb3942)	Oct 2013 - Jun 2015
9.	Vlad Paiu (@vladpaiu)	Jan 2013 - May 2014

(1) including any documentation-related commits, excluding merge commits

Chapter 3. Documentation

3.1. Contributors

Last edited by: Peter Lemenkov (@lemenkov), Liviu Chircu (@liviuchircu), Razvan Crainea (@razvancrainea), Julián Moreno Patiño, Vlad Paiu (@vladpaiu), Ryan Bullock (@rrb3942).