DB_SQLITE module
Admin Guide
Section titled “Admin Guide”Overview
Section titled “Overview”This is a module which provides SQLite support for OpenSIPS. It implements the DB API defined in OpenSIPS.
Dependencies
Section titled “Dependencies”OpenSIPS Modules
Section titled “OpenSIPS Modules”The following modules must be loaded before this module:
- No dependencies on other OpenSIPS modules.
Also this module provides two ways of creating the query. One is to use sqlite3_bind_* functions after opensips creates the prepared statement query. The second one directly uses only sqlite3_snprintf function to print the values into the opensips created query. In theory, the second one should be faster and should allow you to make more queries to the database in the same time, so by default this one will be active. You can use the sqlite3_bind_* interface by simply uncommenting the SQLITE_BIND line the Makefile.
External Libraries or Applications
Section titled “External Libraries or Applications”The following libraries or applications must be installed before running OpenSIPS with this module loaded:
- libsqlite3-dev - the development libraries of sqlite.
Exported Parameters
Section titled “Exported Parameters”alloc_limit (integer)
Section titled “alloc_limit (integer)”Since the library does not support a function to return the number of rows in a query, this number is obtained using “count()” query. If we use multiple processes there is the risk ,since “count()” query and the actual “select” query, the number of rows in the result query to have changed, so realloc will be needed if the number is bigger. Using alloc_limit parameter you can specify the number with which the number of allocated rows in the result is raised.
Default value is 10.
...modparam("db_sqlite", "alloc_limit", 25)...load_extension (string)
Section titled “load_extension (string)”This parameter enables extension loading, similiar to “.load” functionality in sqlite3, extenions like sqlite3-pcre which enables REGEX function. In order to use this functionality you must specify the library path (.so file) and the entry point which represents the function to be called by the sqlite library (read more at sqlite load_extension official documentation), separated by ”;” delimiter. The entry point paramter can miss, so you won’t need to use the delimitier in this case.
By default, no extension is loaded.
...modparam("db_sqlite", "load_extension", "/usr/lib/sqlite3/pcre.so")modparam("db_sqlite", "load_extension", "/usr/lib/sqlite3/pcre.so;sqlite3_extension_init")...busy_timeout (integer)
Section titled “busy_timeout (integer)”This parameter sets the default busy_handler for the SQLite library, that sleeps for
a specified amount of time when a table is locked. The handler will sleep multiple
times until at least the specified “busy_timeout” duration (in milliseconds) has been
reached. Setting this parameter to a value less than or equal to zero turns off all
busy handlers. (read more in the
SQLite
official documentation)
Default value is 500.
...modparam("db_sqlite", "busy_timeout", 5000)...exec_pragma (string)
Section titled “exec_pragma (string)”This parameter allows configuring an SQLite database with “PRAGMA” statements, (read more in the SQLite official documentation) To use this functionality you must specify the exec_pragma parameter value as “pragma-name=pragma-value”. Multiple parameters with the same name can be specified, and they will be executed one by one on every database connection. If a parameter has an incorrect name or syntax, it will be ignored by SQLite without any error messages.
By default, no PRAGMA statements are executed.
...modparam("db_sqlite", "exec_pragma", "journal_mode=wal")modparam("db_sqlite", "exec_pragma", "synchronous=normal")modparam("db_sqlite", "exec_pragma", "cache_size=-2000")...Exported Functions
Section titled “Exported Functions”No function exported to be used from configuration file.
Installation
Section titled “Installation”Because it dependes on an external library, the sqlite module is not compiled and installed by default. You can use one of the next options.
- edit the “Makefile” and remove “db_sqlite” from “excluded_modules” list. Then follow the standard procedure to install OpenSIPS: “make all; make install”.
- from command line use: ‘make all include_modules=“db_sqlite”; make install include_modules=“db_sqlite”’.
Contributors
Section titled “Contributors”By Commit Statistics
Section titled “By Commit Statistics”Top contributors by DevScore(1), authored commits(2) and lines added/removed(3)
| # | Name | DevScore | Commits | Lines++ | Lines— |
|---|---|---|---|---|---|
| 1. | Ionut Ionita (@ionutrazvanionita) | 82 | 28 | 3763 | 1295 |
| 2. | Razvan Crainea (@razvancrainea) | 20 | 18 | 117 | 44 |
| 3. | Liviu Chircu (@liviuchircu) | 15 | 12 | 57 | 66 |
| 4. | Alexey Vasilyev (@vasilevalex) | 13 | 9 | 165 | 96 |
| 5. | Stefan Darius (@dariusstefan) | 7 | 4 | 205 | 42 |
| 6. | Jarrod Baumann (@jarrodb) | 5 | 3 | 7 | 4 |
| 7. | Vlad Patrascu (@rvlad-patrascu) | 4 | 2 | 3 | 2 |
| 8. | Alexandra Titoc | 4 | 2 | 2 | 3 |
| 9. | Aron Podrigal (@ar45) | 3 | 1 | 10 | 1 |
| 10. | Daniel Fussia | 3 | 1 | 4 | 22 |
All remaining contributors: Maksym Sobolyev (@sobomax), Bogdan-Andrei Iancu (@bogdan-iancu), Eric Green, Peter Lemenkov (@lemenkov).
(1) DevScore = author_commits + author_lines_added / (project_lines_added / project_commits) + author_lines_deleted / (project_lines_deleted / project_commits)
(2) including any documentation-related commits, excluding merge commits
(3) ignoring whitespace edits, renamed files and auto-generated files
By Commit Activity
Section titled “By Commit Activity”| # | Name | Commit Activity |
|---|---|---|
| 1. | Stefan Darius (@dariusstefan) | Jun 2026 - Jul 2026 |
| 2. | Razvan Crainea (@razvancrainea) | Aug 2015 - Jun 2026 |
| 3. | Liviu Chircu (@liviuchircu) | May 2016 - Apr 2026 |
| 4. | Alexey Vasilyev (@vasilevalex) | Dec 2024 - Dec 2024 |
| 5. | Alexandra Titoc | Sep 2024 - Sep 2024 |
| 6. | Maksym Sobolyev (@sobomax) | Feb 2023 - Feb 2023 |
| 7. | Eric Green | Aug 2020 - Aug 2020 |
| 8. | Bogdan-Andrei Iancu (@bogdan-iancu) | Apr 2019 - Apr 2019 |
| 9. | Vlad Patrascu (@rvlad-patrascu) | May 2017 - Apr 2019 |
| 10. | Peter Lemenkov (@lemenkov) | Jun 2018 - Jun 2018 |
All remaining contributors: Ionut Ionita (@ionutrazvanionita), Daniel Fussia, Jarrod Baumann (@jarrodb), Aron Podrigal (@ar45).
(1) including any documentation-related commits, excluding merge commits
Documentation
Section titled “Documentation”Contributors
Section titled “Contributors”Last edited by: Razvan Crainea (@razvancrainea), Alexey Vasilyev (@vasilevalex), Liviu Chircu (@liviuchircu), Peter Lemenkov (@lemenkov), Ionut Ionita (@ionutrazvanionita).
License
Section titled “License”All documentation files (i.e. .md extension) are licensed under the Creative Common License 4.0