Skip to content

Commit

Permalink
modules: readme files regenerated - modules ... [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
kamailio-dev committed May 15, 2019
1 parent efa6601 commit 9260a2b
Showing 1 changed file with 26 additions and 11 deletions.
37 changes: 26 additions & 11 deletions src/modules/db_text/README
Expand Up @@ -47,6 +47,7 @@ Olle E. Johansson
4.3. default_connection (string)
4.4. emptystring (integer)
4.5. file_buffer_size (integer)
4.6. max_result_rows (integer)

5. Exported RPC Functions

Expand All @@ -69,11 +70,12 @@ Olle E. Johansson
1.6. Set default_connection parameter
1.7. Set emptystring parameter
1.8. Set file_buffer_size parameter
1.9. Load the dbtext module
1.10. Definition of 'subscriber' table (one line)
1.11. Definition of 'location' and 'aliases' tables (one line)
1.12. Definition of 'version' table and sample records
1.13. Configuration file
1.9. Set max_result_rows parameter
1.10. Load the dbtext module
1.11. Definition of 'subscriber' table (one line)
1.12. Definition of 'location' and 'aliases' tables (one line)
1.13. Definition of 'version' table and sample records
1.14. Configuration file

Chapter 1. Admin Guide

Expand All @@ -97,6 +99,7 @@ Chapter 1. Admin Guide
4.3. default_connection (string)
4.4. emptystring (integer)
4.5. file_buffer_size (integer)
4.6. max_result_rows (integer)

5. Exported RPC Functions

Expand Down Expand Up @@ -224,6 +227,7 @@ suser:supasswd:xxx:alpha.org:xxx
4.3. default_connection (string)
4.4. emptystring (integer)
4.5. file_buffer_size (integer)
4.6. max_result_rows (integer)

4.1. db_mode (integer)

Expand Down Expand Up @@ -281,13 +285,24 @@ modparam("db_text", "emptystring", 1)
size of the buffer used to read the text file. Some presence tables
have columns with large content.

Default value is “16384” (off).
Default value is “16384”.

Example 1.8. Set file_buffer_size parameter
...
modparam("db_text", "file_buffer_size", 8192)
...

4.6. max_result_rows (integer)

number of rows to read from the text file.

Default value is “100000”.

Example 1.9. Set max_result_rows parameter
...
modparam("db_text", "max_result_rows", 1000000)
...

5. Exported RPC Functions

5.1. db_text.dump
Expand Down Expand Up @@ -328,7 +343,7 @@ modparam("db_text", "file_buffer_size", 8192)
database path. So, either you provide an absolute path to database
directory or a relative one to “CFG_DIR” directory.

Example 1.9. Load the dbtext module
Example 1.10. Load the dbtext module
...
loadmodule "/path/to/kamailio/modules_k/db_text.so"
...
Expand All @@ -347,30 +362,30 @@ modparam("module_name", "db_url", "text:///path/to/dbtext/database")
in order to have authentication. To use with the given configuration
file, the table files must be placed in the '/tmp/serdb' directory.

Example 1.10. Definition of 'subscriber' table (one line)
Example 1.11. Definition of 'subscriber' table (one line)
...
username(str) domain(str) password(str) first_name(str) last_name(str) phone(str
) email_address(str) datetime_created(int) datetime_modified(int) confirmation(s
tr) flag(str) sendnotification(str) greeting(str) ha1(str) ha1b(str) perms(str)
allow_find(str) timezone(str,null) rpid(str,null)
...

Example 1.11. Definition of 'location' and 'aliases' tables (one line)
Example 1.12. Definition of 'location' and 'aliases' tables (one line)
...
username(str) domain(str,null) contact(str,null) received(str) expires(int,null)
q(double,null) callid(str,null) cseq(int,null) last_modified(str) flags(int) us
er_agent(str) socket(str)
...

Example 1.12. Definition of 'version' table and sample records
Example 1.13. Definition of 'version' table and sample records
...
table_name(str) table_version(int)
subscriber:3
location:6
aliases:6
...

Example 1.13. Configuration file
Example 1.14. Configuration file
...
#
#
Expand Down

0 comments on commit 9260a2b

Please sign in to comment.