mirror of https://github.com/sipwise/kamailio.git
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
94 lines
2.1 KiB
94 lines
2.1 KiB
<?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 and v2
|
|
connector for PostgreSQL server. It has support for reconnecting
|
|
when the connection is broken.</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>PostgreSQL library</emphasis> - e.g., libpq5.
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>
|
|
<emphasis>PostgreSQL devel library</emphasis> - to compile
|
|
the module (e.g., libpq-dev).
|
|
</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
</section>
|
|
</section>
|
|
|
|
<section>
|
|
<title>Parameters</title>
|
|
<section>
|
|
<title><varname>retries</varname> (integer)</title>
|
|
<para>
|
|
How many retries to attept to reconnect if connection to Postgres
|
|
server becomes broken.
|
|
</para>
|
|
<para>
|
|
<emphasis>
|
|
Default value is 2 (that means three attepts to submit the query,
|
|
first will triger the connection error and two more (the value
|
|
of this parameter) after resetting the connection).
|
|
</emphasis>
|
|
</para>
|
|
<example>
|
|
<title>Set <varname>retries</varname> parameter</title>
|
|
<programlisting format="linespecific">
|
|
...
|
|
modparam("db_postgres", "retries", 3)
|
|
...
|
|
</programlisting>
|
|
</example>
|
|
</section>
|
|
</section>
|
|
|
|
<section>
|
|
<title>Functions</title>
|
|
<para>
|
|
NONE
|
|
</para>
|
|
</section>
|
|
</chapter>
|
|
|