Skip to content

Commit

Permalink
modules: readme files regenerated - db_mysql ... [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
kamailio-dev committed Feb 13, 2017
1 parent 5612f7d commit 82d2a42
Showing 1 changed file with 47 additions and 30 deletions.
77 changes: 47 additions & 30 deletions src/modules/db_mysql/README
Expand Up @@ -26,10 +26,11 @@ Daniel-Constantin Mierla
3. Parameters

3.1. ping_interval (integer)
3.2. timeout_interval (integer)
3.3. auto_reconnect (integer)
3.4. insert_delayed (integer)
3.5. update_affected_found (integer)
3.2. server_timezone (integer)
3.3. timeout_interval (integer)
3.4. auto_reconnect (integer)
3.5. insert_delayed (integer)
3.6. update_affected_found (integer)

4. Functions
5. Installation
Expand All @@ -38,13 +39,14 @@ Daniel-Constantin Mierla
List of Examples

1.1. Set ping_interval parameter
1.2. Set timeout_interval parameter
1.3. Set auto_reconnect parameter
1.4. Set insert_delayed parameter
1.5. Set update_affected_found parameter
1.6. Set a my.cnf group in db_url parameter
1.7. Adding a kamailio group to my.cnf
1.8. Using [client] and specific group
1.2. Set server_timezone parameter
1.3. Set timeout_interval parameter
1.4. Set auto_reconnect parameter
1.5. Set insert_delayed parameter
1.6. Set update_affected_found parameter
1.7. Set a my.cnf group in db_url parameter
1.8. Adding a kamailio group to my.cnf
1.9. Using [client] and specific group

Chapter 1. Admin Guide

Expand All @@ -59,10 +61,11 @@ Chapter 1. Admin Guide
3. Parameters

3.1. ping_interval (integer)
3.2. timeout_interval (integer)
3.3. auto_reconnect (integer)
3.4. insert_delayed (integer)
3.5. update_affected_found (integer)
3.2. server_timezone (integer)
3.3. timeout_interval (integer)
3.4. auto_reconnect (integer)
3.5. insert_delayed (integer)
3.6. update_affected_found (integer)

4. Functions
5. Installation
Expand Down Expand Up @@ -93,10 +96,11 @@ Chapter 1. Admin Guide
3. Parameters

3.1. ping_interval (integer)
3.2. timeout_interval (integer)
3.3. auto_reconnect (integer)
3.4. insert_delayed (integer)
3.5. update_affected_found (integer)
3.2. server_timezone (integer)
3.3. timeout_interval (integer)
3.4. auto_reconnect (integer)
3.5. insert_delayed (integer)
3.6. update_affected_found (integer)

3.1. ping_interval (integer)

Expand All @@ -110,7 +114,20 @@ Chapter 1. Admin Guide
modparam("db_mysql", "ping_interval", 600)
...

3.2. timeout_interval (integer)
3.2. server_timezone (integer)

Control if kamailio convers a time to string using the local timezone
or if MySQL will convert it using FROM_UNIXTIME. This option is useful
if kamailio and the database are configured for different timezones.

Default value is 0 (use local conversion)

Example 1.2. Set server_timezone parameter
...
modparam("db_mysql", "server_timezone", 1)
...

3.3. timeout_interval (integer)

Time interval (in seconds) after that an connection attempt, read or
write request is aborted. The value counts three times, as several
Expand All @@ -123,43 +140,43 @@ modparam("db_mysql", "ping_interval", 600)

Default value is 2 (6 sec).

Example 1.2. Set timeout_interval parameter
Example 1.3. Set timeout_interval parameter
...
modparam("db_mysql", "timeout_interval", 2)
...

3.3. auto_reconnect (integer)
3.4. auto_reconnect (integer)

Configure whether the module should automatically reconnect to MySQL
server if the connection was lost.

Default value is 1 (1 - on / 0 - off).

Example 1.3. Set auto_reconnect parameter
Example 1.4. Set auto_reconnect parameter
...
modparam("db_mysql", "auto_reconnect", 0)
...

3.4. insert_delayed (integer)
3.5. insert_delayed (integer)

If set to 1, all INSERT SQL queries will be sent to MySQL server as
INSERT DELAYED.

Default value is 0 (1 - on / 0 - off).

Example 1.4. Set insert_delayed parameter
Example 1.5. Set insert_delayed parameter
...
modparam("db_mysql", "insert_delayed", 1)
...

3.5. update_affected_found (integer)
3.6. update_affected_found (integer)

If set to 1, all UPDATE SQL queries will return the number of matched
rows instead of the number of "updated" rows.

Default value is 0 (1 - on / 0 - off).

Example 1.5. Set update_affected_found parameter
Example 1.6. Set update_affected_found parameter
...
modparam("db_mysql", "update_affected_found", 1)
...
Expand Down Expand Up @@ -190,12 +207,12 @@ modparam("db_mysql", "update_affected_found", 1)
* mysql://user:pass@[group]/db
* mysql://[group]/db

Example 1.6. Set a my.cnf group in db_url parameter
Example 1.7. Set a my.cnf group in db_url parameter
...
modparam("usrloc", "db_url", "mysql://[kamailio]/kamailio)
...

Example 1.7. Adding a kamailio group to my.cnf
Example 1.8. Adding a kamailio group to my.cnf
...
[kamailio]
socket = /path/to/mysql.sock
Expand All @@ -209,7 +226,7 @@ default-character-set = utf8
both your specific group and the client group, then the value is taken
from the last one.

Example 1.8. Using [client] and specific group
Example 1.9. Using [client] and specific group
...
[client]
socket = /var/run/mysql/mysqld.sock
Expand Down

0 comments on commit 82d2a42

Please sign in to comment.