Module: sip-router Branch: janakj/mysql Commit: 409249d61e6fa1a0e478fdfc5dd1ac3dcad957c9 URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=409249d6...

Author: Klaus Darilion klaus.darilion@pernau.at Committer: Klaus Darilion klaus.darilion@pernau.at Date: Wed Aug 6 10:49:19 2008 +0000

- regenerated all READMEs (make modules-readme exclude_modules="")

git-svn-id: https://openser.svn.sourceforge.net/svnroot/openser/trunk@4596 689a6050-402a-0410-94f2-e92a70836424

---

modules/db_mysql/km_README | 36 +++++++++++++++++++----------------- 1 files changed, 19 insertions(+), 17 deletions(-)

diff --git a/modules/db_mysql/km_README b/modules/db_mysql/km_README index a90e8f9..299309b 100644 --- a/modules/db_mysql/km_README +++ b/modules/db_mysql/km_README @@ -1,3 +1,4 @@ + mysql Module

Daniel-Constantin Mierla @@ -12,9 +13,9 @@ Daniel-Constantin Mierla

Copyright � 2006 voice-system.ro Revision History - Revision $Revision$ $Date: 2008-03-19 20:31:30 +0100 - (Mi, 19 Mär 2008) $ - __________________________________________________________ + Revision $Revision$ $Date: 2008-08-06 12:08:33 +0200 + (Wed, 06 Aug 2008) $ + _________________________________________________________

Table of Contents

@@ -45,8 +46,8 @@ Chapter 1. Admin Guide

1.1. Overview

- This is a module which provides MySQL connectivity for Kamailio. - It implements the DB API defined in Kamailio. + This is a module which provides MySQL connectivity for + Kamailio. It implements the DB API defined in Kamailio.

1.2. Dependencies

@@ -59,8 +60,8 @@ Chapter 1. Admin Guide

The following libraries or applications must be installed before running Kamailio with this module loaded: - * mysql - the development libraries forthe Mysql database. In - some Linux distributions named "libmysqlclient-dev". + * mysql - the development libraries forthe Mysql database. + In some Linux distributions named "libmysqlclient-dev".

1.3. Exported Parameters

@@ -69,7 +70,7 @@ Chapter 1. Admin Guide Time interval in seconds to send ping messages to MySQL server in order to keep the connection open.

- Default value is 300 (5 min). + Default value is 300 (5 min).

Example 1.1. Set ping_interval parameter ... @@ -79,15 +80,16 @@ modparam("db_mysql", "ping_interval", 600) 1.3.2. 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 retries are done from the driver before it gives up. + read or write request is aborted. The value counts three + times, as several retries are done from the driver before it + gives up.

The read timeout parameter is ignored on MySQL driver versions prior to "5.1.12", "5.0.25" and "4.1.22". The write timeout parameter is ignored on versions prior to "5.1.12" and "5.0.25", the "4.1" release don't support it at all.

- Default value is 2 (6 sec). + Default value is 2 (6 sec).

Example 1.2. Set timeout_interval parameter ... @@ -99,7 +101,7 @@ modparam("db_mysql", "timeout_interval", 2) Configure whether the module should automatically reconnect to MySQL server if the connection was lost.

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

Example 1.3. Set auto_reconnect parameter ... @@ -112,12 +114,12 @@ modparam("auto_reconnect", "auto_reconnect", 0)

1.5. Installation

- Because it dependes on an external library, the mysql module is - not compiled and installed by default. You can use one of these - options. + Because it dependes on an external library, the mysql module + is not compiled and installed by default. You can use one of + these options. * - edit the "Makefile" and remove "db_mysql" from - "excluded_modules" list. Then follow the standard procedure - to install Kamailio: "make all; make install". + "excluded_modules" list. Then follow the standard + procedure to install Kamailio: "make all; make install". * - from command line use: 'make all include_modules="db_mysql"; make install include_modules="db_mysql"'.