mysql Module

Daniel-Constantin Mierla

Edited by

Daniel-Constantin Mierla

Revision History
Revision $Revision: 4594 $$Date: 2008-08-06 12:08:33 +0200 (Wed, 06 Aug 2008) $

Table of Contents

1. Admin Guide
1.1. Overview
1.2. Dependencies
1.2.1. Kamailio Modules
1.2.2. External Libraries or Applications
1.3. Exported Parameters
1.3.1. ping_interval (integer)
1.3.2. timeout_interval (integer)
1.3.3. auto_reconnect (integer)
1.4. Exported Functions
1.5. Installation

List of Examples

1.1. Set ping_interval parameter
1.2. Set timeout_interval parameter
1.3. Set auto_reconnect parameter

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.

1.2. Dependencies

1.2.1. Kamailio Modules

The following modules must be loaded before this module:

  • No dependencies on other Kamailio modules.

1.2.2. External Libraries or Applications

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".

1.3. Exported Parameters

1.3.1. ping_interval (integer)

Time interval in seconds to send ping messages to MySQL server in order to keep the connection open.

Default value is 300 (5 min).

Example 1.1. Set ping_interval parameter

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.

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).

Example 1.2. Set timeout_interval parameter

modparam("db_mysql", "timeout_interval", 2)

1.3.3. 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

modparam("auto_reconnect", "auto_reconnect", 0)

1.4. Exported Functions

No function exported to be used from configuration file.

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.

  • - edit the "Makefile" and remove "db_mysql" from "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"'.