[sr-dev] git:master: db_postgres: documentation updated
Daniel-Constantin Mierla
miconda at gmail.com
Sun Jan 23 23:13:15 CET 2011
Module: sip-router
Branch: master
Commit: d55c6bd0f77c9211f429591df6d0a98c2ae96c33
URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=d55c6bd0f77c9211f429591df6d0a98c2ae96c33
Author: kamailio <kamailio at kamailio-laptop.(none)>
Committer: kamailio <kamailio at kamailio-laptop.(none)>
Date: Sun Jan 23 23:04:16 2011 +0100
db_postgres: documentation updated
- documented the retries parameter
---
modules/db_postgres/README | 139 +++++++++----------------
modules/db_postgres/doc/db_postgres_admin.xml | 29 ++++-
2 files changed, 73 insertions(+), 95 deletions(-)
diff --git a/modules/db_postgres/README b/modules/db_postgres/README
index e943699..f5be0af 100644
--- a/modules/db_postgres/README
+++ b/modules/db_postgres/README
@@ -1,4 +1,3 @@
-
postgres Module
Greg Fausak
@@ -9,126 +8,88 @@ Edited by
Greg Fausak
- Copyright © 2003 Greg Fausak
- _________________________________________________________
+ Copyright © 2003 Greg Fausak
+ Revision History
+ Revision $Revision$ $Date$
+ __________________________________________________________________
Table of Contents
- 1. User's Guide
-
- 1.1. Overview
- 1.2. Dependencies
-
- 1.2.1. SER Modules
- 1.2.2. External Libraries or Applications
- 1.3. Exported Parameters
+ 1. Admin Guide
- 1.3.1. param_name (param_type)
+ 1. Overview
+ 2. Dependencies
- 1.4. Exported Functions
+ 2.1. Kamailio Modules
+ 2.2. External Libraries or Applications
- 1.4.1. function_name(param1, param2)
+ 3. Exported Parameters
- 1.5. Installation & Running
+ 3.1. retries (integer)
- 2. Developer's Guide
- 3. Frequently Asked Questions
+ 4. Exported Functions
List of Examples
- 1-1. Set param_name parameter
- 1-2. function_name usage
- _________________________________________________________
-Chapter 1. User's Guide
+ 1.1. Set retries parameter
-1.1. Overview
+Chapter 1. Admin Guide
- Module description
- _________________________________________________________
+ Table of Contents
-1.2. Dependencies
+ 1. Overview
+ 2. Dependencies
-1.2.1. SER Modules
+ 2.1. Kamailio Modules
+ 2.2. External Libraries or Applications
- The following modules must be loaded before this module:
+ 3. Exported Parameters
- * No dependencies on other SER modules.
- _________________________________________________________
+ 3.1. retries (integer)
-1.2.2. External Libraries or Applications
+ 4. Exported Functions
- The following libraries or applications must be installed
- before running SER with this module loaded:
+1. Overview
- * None.
- _________________________________________________________
+ 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.
-1.3. Exported Parameters
+2. Dependencies
-1.3.1. param_name (param_type)
+ 2.1. Kamailio Modules
+ 2.2. External Libraries or Applications
- Param description.
+2.1. Kamailio Modules
- Default value is "value".
+ The following modules must be loaded before this module:
+ * No dependencies on other Kamailio modules.
- Example 1-1. Set param_name parameter
-...
-modparam("module", "param_name", "param_value")
-...
- _________________________________________________________
+2.2. External Libraries or Applications
+
+ The following libraries or applications must be installed before
+ running Kamailio with this module loaded:
+ * PostgreSQL library - e.g., libpq5.
+ * PostgreSQL devel library - to compile the module (e.g., libpq-dev).
-1.4. Exported Functions
+3. Exported Parameters
-1.4.1. function_name(param1, param2)
+ 3.1. retries (integer)
- Description
+3.1. retries (integer)
- Meaning of the parameters is as follows:
+ How many retries to attept to reconnect if connection to Postgres
+ server becomes broken.
- * param1 - description.
- * param2 - description.
+ 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).
- Example 1-2. function_name usage
+ Example 1.1. Set retries parameter
...
-function_name("sample_param1", "sample_param2");
+modparam("db_mysql", "retries", 3)
...
- _________________________________________________________
-
-1.5. Installation & Running
-
- Notes about installation and running.
- _________________________________________________________
-
-Chapter 2. Developer's Guide
-
- The module does not provide any sort of API to use in other
- SER modules.
- _________________________________________________________
-
-Chapter 3. Frequently Asked Questions
-
- 3.1. Where can I find more about SER?
- 3.2. Where can I post a question about this module?
- 3.3. How can I report a bug?
-
- 3.1. Where can I find more about SER?
-
- Take a look at http://iptel.org/ser.
-
- 3.2. Where can I post a question about this module?
-
- First at all check if your question was already answered on
- one of our mailing lists:
-
- * http://mail.iptel.org/mailman/listinfo/serusers
- * http://mail.iptel.org/mailman/listinfo/serdev
-
- E-mails regarding any stable version should be sent to
- <serusers at iptel.org> and e-mail regarding development versions
- or CVS snapshots should be send to <serdev at iptel.org>.
-
- 3.3. How can I report a bug?
+4. Exported Functions
- Please follow the guidelines provided at:
- http://iptel.org/ser/bugs
+ NONE
diff --git a/modules/db_postgres/doc/db_postgres_admin.xml b/modules/db_postgres/doc/db_postgres_admin.xml
index bf0238e..f82a997 100644
--- a/modules/db_postgres/doc/db_postgres_admin.xml
+++ b/modules/db_postgres/doc/db_postgres_admin.xml
@@ -16,7 +16,9 @@
<section>
<title>Overview</title>
- <para>Module description</para>
+ <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>
@@ -57,9 +59,28 @@
<section>
<title>Exported Parameters</title>
+ <section>
+ <title><varname>retries</varname> (integer)</title>
<para>
- NONE
+ 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_mysql", "retries", 3)
+...
+</programlisting>
+ </example>
+ </section>
</section>
<section>
@@ -68,9 +89,5 @@
NONE
</para>
</section>
- <section>
- <title>Installation and Running</title>
- <para>Notes about installation and running.</para>
- </section>
</chapter>
More information about the sr-dev
mailing list