[sr-dev] git:master: db_sqlite: added notes about usage in readme

[Daniel-Constantin Mierla]

Module: sip-router
Branch: master
Commit: 72942d8441e04c6f92c8072a373e1f0a9dcc0e61
URL:    http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=72942d8441e04c6f92c8072a373e1f0a9dcc0e61

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date:   Mon Jul 30 11:18:28 2012 +0200

db_sqlite: added notes about usage in readme

- based on content by Meftah Tayeb

---

 modules_k/db_sqlite/README                  |   40 +++++++++++++++++++++++++--
 modules_k/db_sqlite/doc/db_sqlite_admin.xml |   40 +++++++++++++++++++++++++++
 2 files changed, 77 insertions(+), 3 deletions(-)

diff --git a/modules_k/db_sqlite/README b/modules_k/db_sqlite/README
index a1ef4fa..34d1302 100644
--- a/modules_k/db_sqlite/README
+++ b/modules_k/db_sqlite/README
@@ -1,12 +1,12 @@
 SQlite Module
 
-Timo Teräs
+Timo Teräs
 
 Edited by
 
-Timo Teräs
+Timo Teräs
 
-   Copyright © 2011 Timo Teräs
+   Copyright © 2011 Timo Teräs
      __________________________________________________________________
 
    Table of Contents
@@ -21,6 +21,13 @@ Timo Teräs
 
         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
 
@@ -34,6 +41,7 @@ Chapter 1. Admin Guide
 
    3. Parameters
    4. Functions
+   5. Usage
 
 1. Overview
 
@@ -65,3 +73,29 @@ Chapter 1. Admin Guide
 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"
+...
diff --git a/modules_k/db_sqlite/doc/db_sqlite_admin.xml b/modules_k/db_sqlite/doc/db_sqlite_admin.xml
index 43c2d5d..8c11032 100644
--- a/modules_k/db_sqlite/doc/db_sqlite_admin.xml
+++ b/modules_k/db_sqlite/doc/db_sqlite_admin.xml
@@ -74,5 +74,45 @@
 		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>