Table of Contents
List of Examples
Table of Contents
The following modules must be loaded before this module:
No dependencies on other Kamailio modules.
This will set the db connection to "SQLITE_OPEN_READONLY", useful if another program is writing to the DB. The value is the full path to the sqlite file used for example in any db_url or sqlops/sqlcon 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_OPEN_READWRITE | SQLITE_OPEN_CREATE"
Example 1.1. Set db_set_readonly parameter
...
# Don't use trailing slashes for db_sqlite params
modparam("db_sqlite","db_set_readonly","var/mydb.sqlite")
modparam("sqlops","sqlcon","lrn=>sqlite:///var/mydb.sqlite") # Example if using the sqlops module
...
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 When setting this option, you must also set db_set_busy_timeout, because all kamailio sub-processes will set this option individually and simultaneously, causing "database locked" errors on startup if no busy timeout is set. 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 database
# from another process(external to Kamailio) without facing any locking.
# Don't use trailing slashes for db_sqlite params
#!subst "!DB_FILE!var/mydb.sqlite!"
modparam("db_sqlite","db_set_readonly","DB_FILE") # We are also opening the database in readonly
modparam("db_sqlite","db_set_journal_mode","DB_FILE=WAL;")
modparam("db_sqlite","db_set_busy_timeout","DB_FILE=300;") # wait 300ms max for locks to release
modparam("sqlops","sqlcon","lrn=>sqlite:///DB_FILE")
...
This will set the db connection busy timeout to let it wait for the given milliseconds for database locks to be released by other processes before giving up. Use this with the WAL journaling mode if you run into "database locked" errors. The value is the full path to the sqlite file used for example in any db_url or sqlops/sqlcon This parameter may be set multiple times to set the busy-timeout for different DB connections in the same configuration file.
By default all the db connections are NOT using any busy timeout, causing them to immediately give up and return a "databased locked" error if another process is locking it at the same time.
Example 1.3. Set db_set_busy_timeout parameter
...
# In this example we are using Write-Ahead Logging in combination with a busy-timeout to prevent
"database locked" errors. Note that you have to leave out the leading slash in the DB file!
#!subst "!DB_FILE!var/mydb.sqlite!"
modparam("db_sqlite","db_set_journal_mode","DB_FILE=WAL;")
modparam("db_sqlite","db_set_busy_timeout","DB_FILE=300;") # wait 300ms max for locks to release
modparam("sqlops","sqlcon","lrn=>sqlite:///DB_FILE")
...
To use the module, first you have to load it in the Kamailio configuration file.
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.5. 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: