1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
|
<?xml version="1.0" encoding='ISO-8859-1'?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
<!-- Include general documentation entities -->
<!ENTITY % docentities SYSTEM "../../../docbook/entities.xml">
%docentities;
]>
<!-- Module User's Guide -->
<chapter>
<title>&adminguide;</title>
<section>
<title>Overview</title>
<para>The module is an implementation of the internal DB API v1 connector
for SQlite 3 file.</para>
</section>
<section>
<title>Dependencies</title>
<section>
<title>&kamailio; Modules</title>
<para>
The following modules must be loaded before this module:
<itemizedlist>
<listitem>
<para>
<emphasis>No dependencies on other &kamailio; modules</emphasis>.
</para>
</listitem>
</itemizedlist>
</para>
</section>
<section>
<title>External Libraries or Applications</title>
<para>
The following libraries or applications must be installed before running
&kamailio; with this module loaded:
<itemizedlist>
<listitem>
<para>
<emphasis>SQlite 3 library</emphasis> - e.g., libsqlite3-0
</para>
</listitem>
<listitem>
<para>
<emphasis>SQlite 3 devel library</emphasis> - to compile
the module e.g. libsqlite3-dev
</para>
</listitem>
<listitem>
<para>
<emphasis>SQlite 3 utilities</emphasis> - for kamdbctl
e.g. sqlite3
</para>
</listitem>
</itemizedlist>
</para>
</section>
</section>
<section>
<title>Parameters</title>
<para>
NONE
</para>
</section>
<section>
<title>Functions</title>
<para>
NONE
</para>
</section>
<section>
<title>Usage</title>
<para>
To use the module, first you have to load it in the &kamailio;
configuration file.
</para>
<example>
<title><function>loading the module</function> usage</title>
<programlisting format="linespecific">
...
loadmodule "db_sqlite.so"
...
</programlisting>
</example>
<para>
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:
</para>
<example>
<title><function>db_url module parameter</function> usage</title>
<programlisting format="linespecific">
...
modparam("auth_db", "db_url", "sqlite:///etc/kamailio/kamailio.db")
...
</programlisting>
</example>
<para>
In the default config file, defined token DBURL can be updated like:
</para>
<example>
<title><function>DBURL define</function> usage</title>
<programlisting format="linespecific">
...
#!define DBURL "sqlite:///etc/kamailio/kamailio.db"
...
</programlisting>
</example>
</section>
</chapter>
|
