From 133917db7a033218e54931b6cf532552d274af6c Mon Sep 17 00:00:00 2001 From: Kamailio Dev Date: Wed, 26 Sep 2018 20:16:30 +0200 Subject: [PATCH] modules: readme files regenerated - db_redis ... [skip ci] --- src/modules/db_redis/README | 66 ++++++++++++++++++++++++++----------- 1 file changed, 46 insertions(+), 20 deletions(-) diff --git a/src/modules/db_redis/README b/src/modules/db_redis/README index 9883253ffbb..75f31cf2138 100644 --- a/src/modules/db_redis/README +++ b/src/modules/db_redis/README @@ -28,24 +28,26 @@ Alex Balashov 3. Dependencies 3.1. Kamailio Modules + 3.2. External Libraries or Applications 4. Parameters 4.1. schema_path (string) 4.2. keys (string) + 4.3. verbosity (int) - 5. External Libraries or Applications - 6. Usage - 7. Module specific considerations + 5. Usage + 6. Module Specific Considerations - 7.1. usrloc + 6.1. usrloc List of Examples 1.1. Setting schema_path module parameter 1.2. Setting keys module parameter - 1.3. Usage + 1.3. Setting verbosity module parameter 1.4. Usage + 1.5. Usage Chapter 1. Admin Guide @@ -56,17 +58,18 @@ Chapter 1. Admin Guide 3. Dependencies 3.1. Kamailio Modules + 3.2. External Libraries or Applications 4. Parameters 4.1. schema_path (string) 4.2. keys (string) + 4.3. verbosity (int) - 5. External Libraries or Applications - 6. Usage - 7. Module specific considerations + 5. Usage + 6. Module Specific Considerations - 7.1. usrloc + 6.1. usrloc 1. Overview @@ -156,46 +159,69 @@ allid,time_hires&cid:callid 3. Dependencies 3.1. Kamailio Modules + 3.2. External Libraries or Applications 3.1. Kamailio Modules The following modules must be loaded before this module: * none. +3.2. External Libraries or Applications + + The following libraries or applications must be installed before + running Kamailio with this module loaded: + * hiredis - available at https://github.com/redis/hiredis + 4. Parameters 4.1. schema_path (string) 4.2. keys (string) + 4.3. verbosity (int) 4.1. schema_path (string) - The path to the table schemas (default /usr/share/kamailio/db_redis). + The path to the table schemas. + + Default value: "/usr/share/kamailio/db_redis". Example 1.1. Setting schema_path module parameter +... modparam("db_redis", "schema_path", "/usr/local/share/kamailio/db_redis/kamailio ") +... 4.2. keys (string) The entry and mapping keys of tables. + Default value: "" (empty). + Example 1.2. Setting keys module parameter +... modparam("db_redis", "keys", "version=entry:table_name;location=entry:ruid&usrdo m:username,domain&timer:partition,keepalive") +... -5. External Libraries or Applications +4.3. verbosity (int) - The following libraries or applications must be installed before - running Kamailio with this module loaded: - * hiredis - available at https://github.com/redis/hiredis + Control the verbosity of debug messages printed by the module. If set + to 1, the module prints schema details for all tables on each connect + operation to Redis server. + + Default value: 1. -6. Usage + Example 1.3. Setting verbosity module parameter +... +modparam("db_redis", "verbosity", 0) +... + +5. Usage Load the module and set the "db_url" modparam for specific modules to: 'redis://[username]@host:port/database'. Username is optional. The database portion must be a valid Redis database number. - Example 1.3. Usage + Example 1.4. Usage ... loadmodule "db_redis.so" ... @@ -221,7 +247,7 @@ modparam("permissions", "db_url", DBURL_PERM) Samples adding records for address table using 'redis-cli': - Example 1.4. Usage + Example 1.5. Usage ... SELECT 8 HMSET address:entry::1 id 1 grp 1 ip_addr "127.0.0.1" mask 32 port 0 @@ -236,11 +262,11 @@ HMSET address:entry::4 id 4 grp 2 ip_addr "127.0.0.4" mask 32 port 0 tag "test" database schema. When definition allows 'NULL', that field can be unset. -7. Module specific considerations +6. Module Specific Considerations - 7.1. usrloc + 6.1. usrloc -7.1. usrloc +6.1. usrloc If you set "expires_type" to "1" in order to use BIGINT instead of DATETIME, make sure to update your location schema file and change the