CACHEDB_COUCHBASE module
Admin Guide
Section titled “Admin Guide”Overview
Section titled “Overview”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.
Advantages
Section titled “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
Limitations
Section titled “Limitations”- keys (in key:value pairs) may not contain spaces or control characters
Dependencies
Section titled “Dependencies”OpenSIPS Modules
Section titled “OpenSIPS Modules”None.
External Libraries or Applications
Section titled “External Libraries or Applications”The following libraries or applications must be installed before running OpenSIPS with this module loaded:
- libcouchbase >= 3.0: libcoucbase can be downloaded from http://www.couchbase.com/develop/c/current
Exported Parameters
Section titled “Exported Parameters”cachedb_url (string)
Section titled “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
...modparam("cachedb_couchbase", "cachedb_url","couchbase:group1://localhost:6379/default")modparam("cachedb_couchbase", "cachedb_url","couchbase:cluster1://random_url:8888/my_bucket")# Multiple hostsmodparam("cachedb_couchbase", "cachedb_url","couchbase:cluster1://random_url1:8888,random_url2:8888,random_url3:8888/my_bucket")...timeout (int)
Section titled “timeout (int)”The max duration in microseconds that a couchbase op is expected to last.
Default value is 3000000 (3 seconds).
...modparam("cachedb_couchbase", "timeout",5000000);...exec_threshold (int)
Section titled “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 )“.
...modparam("cachedb_couchbase", "exec_threshold", 100000)...lazy_connect (int)
Section titled “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 value is 0 (Connect to all buckets on startup).
...modparam("cachedb_couchbase", "lazy_connect", 1);......cache_store("couchbase:group1","key","$ru value");cache_fetch("couchbase:cluster1","key",$avp(10));cache_remove("couchbase:cluster1","key");...Exported Functions
Section titled “Exported Functions”The module does not export functions to be used in configuration script.
Contributors
Section titled “Contributors”By Commit Statistics
Section titled “By Commit Statistics”Top contributors by DevScore(1), authored commits(2) and lines added/removed(3)
| # | Name | DevScore | Commits | Lines++ | Lines— |
|---|---|---|---|---|---|
| 1. | Vlad Paiu (@vladpaiu) | 21 | 8 | 1156 | 161 |
| 2. | Peter Lemenkov (@lemenkov) | 17 | 11 | 206 | 238 |
| 3. | Razvan Crainea (@razvancrainea) | 12 | 10 | 104 | 23 |
| 4. | Liviu Chircu (@liviuchircu) | 10 | 7 | 98 | 91 |
| 5. | Stefan Darius | 7 | 4 | 195 | 35 |
| 6. | Ryan Bullock (@rrb3942) | 7 | 2 | 253 | 110 |
| 7. | Bogdan-Andrei Iancu (@bogdan-iancu) | 5 | 3 | 3 | 5 |
| 8. | Maksym Sobolyev (@sobomax) | 4 | 2 | 3 | 3 |
| 9. | Julián Moreno Patiño | 3 | 1 | 1 | 1 |
| 10. | 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
(3) ignoring whitespace edits, renamed files and auto-generated files
By Commit Activity
Section titled “By Commit Activity”| # | Name | Commit Activity |
|---|---|---|
| 1. | Stefan Darius | Jun 2026 - Jul 2026 |
| 2. | Razvan Crainea (@razvancrainea) | Aug 2015 - Jun 2026 |
| 3. | Maksym Sobolyev (@sobomax) | Feb 2023 - Feb 2023 |
| 4. | Peter Lemenkov (@lemenkov) | Jun 2018 - Jan 2021 |
| 5. | Bogdan-Andrei Iancu (@bogdan-iancu) | Oct 2014 - Mar 2020 |
| 6. | Liviu Chircu (@liviuchircu) | Mar 2014 - Apr 2019 |
| 7. | Vlad Patrascu (@rvlad-patrascu) | May 2017 - May 2017 |
| 8. | Julián Moreno Patiño | Feb 2016 - Feb 2016 |
| 9. | Ryan Bullock (@rrb3942) | Oct 2013 - Jun 2015 |
| 10. | Vlad Paiu (@vladpaiu) | Jan 2013 - May 2014 |
(1) including any documentation-related commits, excluding merge commits
Documentation
Section titled “Documentation”Contributors
Section titled “Contributors”Last edited by: Razvan Crainea (@razvancrainea), Peter Lemenkov (@lemenkov), Liviu Chircu (@liviuchircu), Julián Moreno Patiño, Vlad Paiu (@vladpaiu), Ryan Bullock (@rrb3942).
License
Section titled “License”All documentation files (i.e. .md extension) are licensed under the Creative Common License 4.0