kamailio/modules/db_sqlite

SQlite Module

Timo Ter�s

Edited by

Timo Ter�s

Copyright � 2011 Timo Ter�s
__________________________________________________________________

Table of Contents

1. Admin Guide

1. Overview
2. Dependencies

2.1. Kamailio Modules
2.2. External Libraries or Applications

3. Parameters
4. Functions
5. Usage

List of Examples

1.1. loading the module usage
1.2. db_url module parameter usage
1.3. DBURL define usage

Chapter 1. Admin Guide

Table of Contents

1. Overview
2. Dependencies

2.1. Kamailio Modules
2.2. External Libraries or Applications

3. Parameters
4. Functions
5. Usage

1. Overview

The module is an implementation of the internal DB API v1 connector for
SQlite 3 file.

2. Dependencies

2.1. Kamailio Modules
2.2. External Libraries or Applications

2.1. Kamailio Modules

The following modules must be loaded before this module:
* No dependencies on other Kamailio modules.

2.2. External Libraries or Applications

The following libraries or applications must be installed before
running Kamailio with this module loaded:
* SQlite 3 library - e.g., libsqlite3-0
* SQlite 3 devel library - to compile the module e.g. libsqlite3-dev
* SQlite 3 utilities - for kamdbctl e.g. sqlite3

3. Parameters

NONE

4. Functions

NONE

5. Usage

To use the module, first you have to load it in the Kamailio
configuration file.

Example 1.1. loading the module usage
...
loadmodule "db_sqlite.so"
...

Then set the db_url (or similar) parameter of modules that have to use
the SQLite database to driver part 'sqlite://', followed by the path to
database file. For example:

Example 1.2. db_url module parameter usage
...
modparam("auth_db", "db_url", "sqlite:///etc/kamailio/kamailio.db")
...

In the default config file, defined token DBURL can be updated like:

Example 1.3. DBURL define usage
...
#!define DBURL "sqlite:///etc/kamailio/kamailio.db"
...