cachedb_sql Module
__________________________________________________________
Table of Contents
1. Admin Guide
1.1. Overview
1.2. Advantages
1.3. Limitations
1.4. Dependencies
1.4.1. OpenSIPS Modules
1.4.2. External Libraries or Applications
1.5. Exported Parameters
1.5.1. cachedb_url (string)
1.5.2. db_table (string)
1.5.3. key_column (string)
1.5.4. value_column (string)
1.5.5. counter_column (string)
1.5.6. expires_column (string)
1.5.7. cache_clean_period (int)
1.5.8. Exported Functions
2. Frequently Asked Questions
3. Contributors
3.1. By Commit Statistics
3.2. By Commit Activity
4. Documentation
4.1. Contributors
List of Tables
3.1. Top contributors by DevScore^(1), authored commits^(2) and
lines added/removed^(3)
3.2. Most recently active contributors^(1) to this module
List of Examples
1.1. Set db_url parameter
1.2. Usage example
1.3. Set db_url parameter
1.4. Set key_column parameter
1.5. Set value_column parameter
1.6. Set counter_column parameter
1.7. Set expires_column parameter
1.8. Set cache_clean_period parameter
Chapter 1. Admin Guide
1.1. Overview
This module is an implementation of a cache system designed to
work with a regular SQL-based server. It uses the internal DB
interface to connect to the back-end, and also implements the
Key-Value interface exported from the core.
1.2. Advantages
* memory costs are no longer on the server
* the cache is 100% persistent. A restart of OpenSIPS server
will not affect the DB. The DB is also persistent so it can
also be restarted without loss of information.
* Multiple OpenSIPS instances can easily share key-value
information via a regular SQL-based database
1.3. Limitations
* The module's counter operations ( ADD and SUB ) are
currently only supported by MySQL
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:
* none:
1.5. Exported Parameters
1.5.1. cachedb_url (string)
The url of the Database that OpenSIPS will connect to in order
to use the from script cache_store,cache_fetch, etc operations.
The format to follow is : sql:[conn_id]-dburl
The parameter can be set multiple times to create multiple
connections accessible from the OpenSIPS script.
Example 1.1. Set db_url parameter
...
modparam("cachedb_sql", "cachedb_url", "sql:1st-mysql://root:vlad@localh
ost/opensips_sql")
...
Example 1.2. Usage example
...
modparam("cachedb_sql", "cachedb_url", "sql:1st-mysql://root:vlad@localh
ost/opensips_sql")
modparam("cachedb_sql", "cachedb_url", "sql:2nd-postgres://root:vlad@loc
alhost/opensips_pg")
...
...
cache_store("sql:1st-mysql","key","$ru value");
cache_store("sql:2nd-postgres","counter","10");
...
1.5.2. db_table (string)
The table of the Database that OpenSIPS will connect to in
order to use the from script cache_store,cache_fetch, etc
operations.
Example 1.3. Set db_url parameter
...
modparam("cachedb_sql", "db_table","my_table");
...
1.5.3. key_column (string)
The column where the key will be stored
Example 1.4. Set key_column parameter
...
modparam("cachedb_sql", "key_column","some_name");
...
1.5.4. value_column (string)
The column where the value will be stored
Example 1.5. Set value_column parameter
...
modparam("cachedb_sql", "value_column","some_name");
...
1.5.5. counter_column (string)
The column where the counter value will be stored
Example 1.6. Set counter_column parameter
...
modparam("cachedb_sql", "counter_column","some_name");
...
1.5.6. expires_column (string)
The column where the expires will be stored
Example 1.7. Set expires_column parameter
...
modparam("cachedb_sql", "expires_column","some_name");
...
1.5.7. cache_clean_period (int)
The interval in seconds at which the expired keys will be
removed from the database. Default value is 60 ( seconds )
Example 1.8. Set cache_clean_period parameter
...
modparam("cachedb_sql", "cache_clean_period",10);
...
1.5.8. Exported Functions
The module does not export functions to be used in
configuration script.
Chapter 2. Frequently Asked Questions
2.1.
What happened with the old "db_url" module parameter?
It was replaced with the "cachedb_url" parameter. See the
documentation for the usage of the "cachedb_url" parameter.
Chapter 3. Contributors
3.1. By Commit Statistics
Table 3.1. Top contributors by DevScore^(1), authored
commits^(2) and lines added/removed^(3)
Name DevScore Commits Lines ++ Lines --
1. Vlad Paiu (@vladpaiu) 16 5 1001 87
2. Liviu Chircu (@liviuchircu) 10 8 41 58
3. Razvan Crainea (@razvancrainea) 7 5 4 2
4. Bogdan-Andrei Iancu (@bogdan-iancu) 5 3 5 2
5. Dusan Klinec (@ph4r05) 3 1 2 2
6. Julián Moreno Patiño 3 1 2 2
7. Peter Lemenkov (@lemenkov) 3 1 1 1
8. 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
3.2. By Commit Activity
Table 3.2. Most recently active contributors^(1) to this module
Name Commit Activity
1. Razvan Crainea (@razvancrainea) Aug 2015 - Sep 2019
2. Bogdan-Andrei Iancu (@bogdan-iancu) Oct 2014 - Apr 2019
3. Liviu Chircu (@liviuchircu) Mar 2014 - Nov 2018
4. Peter Lemenkov (@lemenkov) Jun 2018 - Jun 2018
5. Vlad Patrascu (@rvlad-patrascu) May 2017 - May 2017
6. Julián Moreno Patiño Feb 2016 - Feb 2016
7. Dusan Klinec (@ph4r05) Dec 2015 - Dec 2015
8. Vlad Paiu (@vladpaiu) Jan 2013 - May 2014
(1) including any documentation-related commits, excluding
merge commits
Chapter 4. Documentation
4.1. Contributors
Last edited by: Peter Lemenkov (@lemenkov), Liviu Chircu
(@liviuchircu), Julián Moreno Patiño, Vlad Paiu (@vladpaiu).
Documentation Copyrights:
Copyright © 2013 www.opensips-solutions.com
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。