MYSQL module
Admin Guide
Section titled “Admin Guide”Overview
Section titled “Overview”This is a module which provides MySQL connectivity 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.
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:
- libmysqlclient-dev - the development libraries of mysql-client.
Exported Parameters
Section titled “Exported Parameters”ping_interval (integer)
Section titled “ping_interval (integer)”Time interval to send ping messages to MySQL server in order to keep the connection open.
Default value is 300 (5 min).
...modparam("db_mysql", "ping_interval", 600)...timeout_interval (integer)
Section titled “timeout_interval (integer)”Time interval after that an connection attempt, read or write request is aborted. The value counts three times, as several retries are done from the driver before it gives up.
The read timeout parameter is ignored on driver versions prior to “5.1.12”, “5.0.25” and “4.1.22”. The write timeout parameter is ignored on version prior to “5.1.12” and “5.0.25”, the “4.1” release don’t support it at all.
Default value is 2 (6 sec).
...modparam("db_mysql", "timeout_interval", 2)...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 mysql module is not compiled and installed by default. You can use one of the next options.
- edit the “Makefile” and remove “db_mysql” 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_mysql”; make install include_modules=“db_mysql”’.
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. | Jan Janak (@janakj) | 154 | 53 | 5406 | 3260 |
| 2. | Henning Westerholt (@henningw) | 108 | 32 | 2630 | 3176 |
| 3. | Bogdan-Andrei Iancu (@bogdan-iancu) | 83 | 57 | 1446 | 741 |
| 4. | Daniel-Constantin Mierla (@miconda) | 28 | 20 | 574 | 157 |
| 5. | Andrei Pelinescu-Onciul | 16 | 14 | 54 | 51 |
| 6. | Jiri Kuthan (@jiriatipteldotorg) | 11 | 6 | 393 | 2 |
| 7. | Stefan Darius (@dariusstefan) | 7 | 4 | 120 | 16 |
| 8. | Nils Ohlmeier | 5 | 3 | 24 | 3 |
| 9. | Norman Brandinger (@NormB) | 4 | 2 | 5 | 3 |
| 10. | Dan Pascu (@danpascu) | 3 | 1 | 25 | 5 |
All remaining contributors: Andreas Heise, Razvan Crainea (@razvancrainea), Konstantin Bokarius, Sergio Gutierrez, Edson Gellert Schubert.
(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) | Jun 2026 - Jun 2026 |
| 3. | Bogdan-Andrei Iancu (@bogdan-iancu) | Aug 2002 - Aug 2010 |
| 4. | Norman Brandinger (@NormB) | Aug 2006 - Feb 2009 |
| 5. | Sergio Gutierrez | Feb 2009 - Feb 2009 |
| 6. | Henning Westerholt (@henningw) | May 2007 - Jun 2008 |
| 7. | Daniel-Constantin Mierla (@miconda) | Oct 2002 - Mar 2008 |
| 8. | Konstantin Bokarius | Mar 2008 - Mar 2008 |
| 9. | Edson Gellert Schubert | Feb 2008 - Feb 2008 |
| 10. | Andreas Heise | Oct 2007 - Oct 2007 |
All remaining contributors: Jan Janak (@janakj), Andrei Pelinescu-Onciul, Dan Pascu (@danpascu), Jiri Kuthan (@jiriatipteldotorg), Nils Ohlmeier.
(1) including any documentation-related commits, excluding merge commits
Documentation
Section titled “Documentation”Contributors
Section titled “Contributors”Last edited by: Razvan Crainea (@razvancrainea), Bogdan-Andrei Iancu (@bogdan-iancu), Daniel-Constantin Mierla (@miconda), Konstantin Bokarius, Edson Gellert Schubert, Henning Westerholt (@henningw), Jan Janak (@janakj).
License
Section titled “License”All documentation files (i.e. .md extension) are licensed under the Creative Common License 4.0