modules: readme files regenerated - db_sqlite ... [skip ci]
authorKamailio Dev <kamailio.dev@kamailio.org>
Tue, 20 Jun 2017 06:46:49 +0000 (08:46 +0200)
committerKamailio Dev <kamailio.dev@kamailio.org>
Tue, 20 Jun 2017 06:46:49 +0000 (08:46 +0200)
src/modules/db_sqlite/README

index 41ba517..a6c3b0b 100644 (file)
@@ -31,6 +31,7 @@ Julien Chavanton
         3. Parameters
 
               3.1. db_set_readonly (string)
+              3.2. db_set_journal_mode (string)
 
         4. Functions
         5. Usage
@@ -38,9 +39,10 @@ Julien Chavanton
    List of Examples
 
    1.1. Set db_set_readonly parameter
-   1.2. loading the module usage
-   1.3. db_url module parameter usage
-   1.4. DBURL define usage
+   1.2. Set db_set_journal_mode parameter
+   1.3. loading the module usage
+   1.4. db_url module parameter usage
+   1.5. DBURL define usage
 
 Chapter 1. Admin Guide
 
@@ -55,6 +57,7 @@ Chapter 1. Admin Guide
    3. Parameters
 
         3.1. db_set_readonly (string)
+        3.2. db_set_journal_mode (string)
 
    4. Functions
    5. Usage
@@ -85,6 +88,7 @@ Chapter 1. Admin Guide
 3. Parameters
 
    3.1. db_set_readonly (string)
+   3.2. db_set_journal_mode (string)
 
 3.1. db_set_readonly (string)
 
@@ -94,7 +98,7 @@ Chapter 1. Admin Guide
    parameter may be set multiple times to set many DB connections to
    readonly in the same configuration file.
 
-   By default all the db connection are using "SQLITE_OPEN_READWRITE |
+   By default all the db connections are using "SQLITE_OPEN_READWRITE |
    SQLITE_OPEN_CREATE"
 
    Example 1.1. Set db_set_readonly parameter
@@ -104,6 +108,29 @@ modparam("sqlops","sqlcon","lrn=>sqlite:////var/mydb.sqlite") # Example if using
  the sqlops module
 ...
 
+3.2. db_set_journal_mode (string)
+
+   This will set the db connection journal mode, for the given connection.
+   The value is the full path to the sqlite file used for example in any
+   db_url or sqlops/sqlcon Other journal mode are : DELETE | TRUNCATE |
+   PERSIST | MEMORY | WAL | OFF This parameter may be set multiple times
+   to set many DB connections to readonly in the same configuration file.
+
+   By default all the db connections are using sqlite default journaling
+   mode.
+
+   Example 1.2. Set db_set_journal_mode parameter
+...
+# In this example we are using Write-Ahead Logging in order to update the databa
+se from another process(external to Kamailio) without facing any locking.
+
+#!subst "!DB_FILE!/var/mydb.sqlite!"
+modparam("db_sqlite","db_set_readonly","DB_FILE")   # We are also opening the da
+tabase in readonly
+modparam("db_sqlite","db_set_journal_mode","DB_FILE=WAL;")
+modparam("sqlops","sqlcon","lrn=>sqlite:///DB_FILE")
+...
+
 4. Functions
 
    NONE
@@ -113,7 +140,7 @@ modparam("sqlops","sqlcon","lrn=>sqlite:////var/mydb.sqlite") # Example if using
    To use the module, first you have to load it in the Kamailio
    configuration file.
 
-   Example 1.2. loading the module usage
+   Example 1.3. loading the module usage
 ...
 loadmodule "db_sqlite.so"
 ...
@@ -122,14 +149,14 @@ loadmodule "db_sqlite.so"
    the SQLite database to driver part 'sqlite://', followed by the path to
    database file. For example:
 
-   Example 1.3. db_url module parameter usage
+   Example 1.4. 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.4. DBURL define usage
+   Example 1.5. DBURL define usage
 ...
 #!define DBURL "sqlite:///etc/kamailio/kamailio.db"
 ...