Skip to content

Commit

Permalink
modules: readme files regenerated - p_usrloc ... [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
@kamailio-dev
kamailio-dev committed May 23, 2018
1 parent bec6a75 commit 3334a01
Showing 1 changed file with 67 additions and 48 deletions.
115 changes: 67 additions & 48 deletions src/modules/p_usrloc/README
View file
Expand Up @@ -43,13 +43,14 @@ Patric Marschall
3.16. db_use_transactions (int)
3.17. db_transaction_level (string)
3.18. write_on_master_db (int)
3.19. write_on_db (int)
3.20. connection_expires (int)
3.21. alg_location (int)
3.22. domain_db(str)
3.23. default_db_type(str)
3.24. db_ops_ruid (int)
3.25. db_update_as_insert (string)
3.19. mdb_availability_control(str)
3.20. write_on_db (int)
3.21. connection_expires (int)
3.22. alg_location (int)
3.23. domain_db(str)
3.24. default_db_type(str)
3.25. db_ops_ruid (int)
3.26. db_update_as_insert (string)

4. default_db_url(str)
5. Changes from usrloc module
Expand Down Expand Up @@ -112,16 +113,17 @@ Patric Marschall
1.16. Set db_use_transactions parameter
1.17. Set db_transaction_level parameter
1.18. Set write_on_master_db parameter
1.19. Set write_on_db parameter
1.20. Set connection_expires parameter
1.21. Set alg_location parameter
1.22. Set domain_db parameter
1.23. Set default_db_type parameter
1.24. Set db_ops_ruid parameter
1.25. Set db_update_as_insert parameter
1.26. Set default_db_type parameter
1.27. Set db_mode parameter
1.28. Example database content - reg_table (locdb) table
1.19. Set mdb_availability_control parameter
1.20. Set write_on_db parameter
1.21. Set connection_expires parameter
1.22. Set alg_location parameter
1.23. Set domain_db parameter
1.24. Set default_db_type parameter
1.25. Set db_ops_ruid parameter
1.26. Set db_update_as_insert parameter
1.27. Set default_db_type parameter
1.28. Set db_mode parameter
1.29. Example database content - reg_table (locdb) table

Chapter 1. User's Guide

Expand Down Expand Up @@ -153,13 +155,14 @@ Chapter 1. User's Guide
3.16. db_use_transactions (int)
3.17. db_transaction_level (string)
3.18. write_on_master_db (int)
3.19. write_on_db (int)
3.20. connection_expires (int)
3.21. alg_location (int)
3.22. domain_db(str)
3.23. default_db_type(str)
3.24. db_ops_ruid (int)
3.25. db_update_as_insert (string)
3.19. mdb_availability_control(str)
3.20. write_on_db (int)
3.21. connection_expires (int)
3.22. alg_location (int)
3.23. domain_db(str)
3.24. default_db_type(str)
3.25. db_ops_ruid (int)
3.26. db_update_as_insert (string)

4. default_db_url(str)
5. Changes from usrloc module
Expand Down Expand Up @@ -269,13 +272,14 @@ Warning
3.16. db_use_transactions (int)
3.17. db_transaction_level (string)
3.18. write_on_master_db (int)
3.19. write_on_db (int)
3.20. connection_expires (int)
3.21. alg_location (int)
3.22. domain_db(str)
3.23. default_db_type(str)
3.24. db_ops_ruid (int)
3.25. db_update_as_insert (string)
3.19. mdb_availability_control(str)
3.20. write_on_db (int)
3.21. connection_expires (int)
3.22. alg_location (int)
3.23. domain_db(str)
3.24. default_db_type(str)
3.25. db_ops_ruid (int)
3.26. db_update_as_insert (string)

3.1. write_db_url (string)

Expand Down Expand Up @@ -520,44 +524,59 @@ modparam("p_usrloc", "db_transaction_level", "READ UNCOMMITED")
modparam("p_usrloc", "write_on_master_db", "0")
...

3.19. write_on_db (int)
3.19. mdb_availability_control(str)

Checks the master database in certain time intervals specified by the
“retry_interval” parameter. Overwrites the “write_on_master_db”
parameter based on the reachability of master database. If the master
db is unavailable then the aforementioned parameter will be
deactivated.

Default value is “0”.

Example 1.19. Set mdb_availability_control parameter
...
modparam("p_usrloc", "mdb_availability_control", 1)
...

3.20. write_on_db (int)

Sets the write access to the distributed databases. If set to 0, no
write operations are permitted on the databases.

Default value is “0”.

Example 1.19. Set write_on_db parameter
Example 1.20. Set write_on_db parameter
...
modparam("p_usrloc", "write_on_db", "0")
...

3.20. connection_expires (int)
3.21. connection_expires (int)

Specifies the period (in seconds) after a database connection expires.
Usage of a too small value will probably decrease the performance.

Default value is “300”.

Example 1.20. Set connection_expires parameter
Example 1.21. Set connection_expires parameter
...
modparam("p_usrloc", "connection_expires", "300")
...

3.21. alg_location (int)
3.22. alg_location (int)

Specify the way the distribution of the subscriptions are computed. At
the moment the only way is to use the CRC32 algorithm to compute the
location ID. Any integer value is fine.

Default value is “0”.

Example 1.21. Set alg_location parameter
Example 1.22. Set alg_location parameter
...
modparam("p_usrloc", "alg_location", 1)
...

3.22. domain_db(str)
3.23. domain_db(str)

Specify the way the lookup is made. In can be either partitioned or
single. For example, if you have a location table that is large and
Expand All @@ -575,25 +594,25 @@ lookup(cfa)

Default value is “location=cluster,cfa=single”.

Example 1.22. Set domain_db parameter
Example 1.23. Set domain_db parameter
...
modparam("p_usrloc", "domain_db", "location=cluster,cfa=single")
...

3.23. default_db_type(str)
3.24. default_db_type(str)

In case a domain (like location,cfa) is not matched by a domain_db
definition, the type is configured by using this parameter. Accepted
values are single and cluster.

Default value is “single”.

Example 1.23. Set default_db_type parameter
Example 1.24. Set default_db_type parameter
...
modparam("p_usrloc", "default_db_type", "cluster")
...

3.24. db_ops_ruid (int)
3.25. db_ops_ruid (int)

If set to 1, database queries for update or delete are done using ruid
value. If it is set to 0, the old style using aor, contact and call-id
Expand All @@ -604,12 +623,12 @@ modparam("p_usrloc", "default_db_type", "cluster")
Can be set at runtime, e.g.:
$ kamcmd cfg.set_now_int p_usrloc db_ops_ruid 1

Example 1.24. Set db_ops_ruid parameter
Example 1.25. Set db_ops_ruid parameter
...
modparam("p_usrloc", "db_ops_ruid", 0)
...

3.25. db_update_as_insert (string)
3.26. db_update_as_insert (string)

Set this parameter if you want to do INSERT DB operations instead of
UPDATE DB operations. It is recommended to set this parameter if you
Expand All @@ -620,7 +639,7 @@ modparam("p_usrloc", "db_ops_ruid", 0)
Can be set at runtime, e.g.:
$ kamcmd cfg.set_now_int p_usrloc db_update_as_insert 1

Example 1.25. Set db_update_as_insert parameter
Example 1.26. Set db_update_as_insert parameter
...
modparam("usrloc", "db_update_as_insert", 1)
...
Expand All @@ -632,7 +651,7 @@ modparam("usrloc", "db_update_as_insert", 1)

Default value is “DEFAULT_DB_URL”.

Example 1.26. Set default_db_type parameter
Example 1.27. Set default_db_type parameter
...
modparam("p_usrloc", "default_db_url", "mysql://ser:ser@localhost/ser")
...
Expand All @@ -659,7 +678,7 @@ modparam("p_usrloc", "default_db_url", "mysql://ser:ser@localhost/ser")

Default value is 3.

Example 1.27. Set db_mode parameter
Example 1.28. Set db_mode parameter
...
modparam("p_usrloc", "db_mode", 2)
...
Expand Down Expand Up @@ -693,7 +712,7 @@ modparam("p_usrloc", "db_mode", 2)
complete database documentation on the project webpage,
https://www.kamailio.org/docs/db-tables/kamailio-db-devel.html.

Example 1.28. Example database content - reg_table (locdb) table
Example 1.29. Example database content - reg_table (locdb) table
...
+----+----+------+--------+--------+---------------------+-------+----+
| id | no | url | status | errors | failover | spare | rg |
Expand Down

0 comments on commit 3334a01

Please sign in to comment.