DB_POSTGRES module

Admin Guide

Overview

Module description

Dependencies

OpenSIPS Modules

The following modules must be loaded before this module:

• No dependencies on other OpenSIPS modules.

External Libraries or Applications

The following libraries or applications must be installed before running OpenSIPS with this module loaded:

• PostgreSQL library - e.g., libpq5.
• PostgreSQL devel library - to compile the module (e.g., libpq-dev).

Exported Parameters

exec_query_threshold (integer)

If queries take longer than ‘exec_query_threshold’ microseconds, warning messages will be written to logging facility.

Default value is 0 - disabled.

Set exec_query_threshold parameter

...
modparam("db_postgres", "exec_query_threshold", 60000)
...

max_db_queries (integer)

The maximum number of database queries to be executed. If this parameter is set improperly, it is set to default value.

Default value is 2.

Set max_db_queries parameter

...
modparam("db_postgres", "max_db_queries", 2)
...

timeout (integer)

The number of seconds the PostgreSQL library waits to connect and query the server. If the connection does not succeed within the given timeout, the connection fails.

Note

If the timeout is a negative value and connection does not succeed, OpenSIPS will block until the connection becomes back available and gets successfully established. This is the default behavior of the library and is the behavior prior to the addition of this parameter.

Default value is 5.

Set timeout parameter

...
modparam("db_postgres", "timeout", 2)
...

use_tls (integer)

Parameter to control the way the SSL support is used when connecting to the Postgres server, as follows:

• use_tls=0 (default) - the SSL support is disabled and there is no attempt to use it;
• use_tls=1 with “tls_domain” present in the DB URL - the SSL support is enabled, either “require”, either “verify-ca”, depending on the certificate settings;
• use_tls=1 with no “tls_domain” present in the DB URL - the SSL support is enabled in best effort mode (or “prefer”); if supported by the server, it will be used, otherwise it will fall back to non-SSL.

Danger

The tls_openssl module cannot be used when setting this parameter. Use the tls_wolfssl module instead if a TLS/SSL Library is required.

Setting this parameter will allow you to use TLS for PostgreSQL connections. In order to enable TLS for a specific connection, you can use the “tls_domain=dom_name” URL parameter in the db_url of the respective OpenSIPS module. This should be placed at the end of the URL after the ’?’ character.

When using this parameter, you must also ensure that tls_mgm is loaded and properly configured. Refer to the the module for additional info regarding TLS client domains.

Note

If you want to use this feature, the TLS domain must be provisioned in the configuration file, NOT in the database. In case you are loading TLS certificates from the database, you must at least define one domain in the configuration script, to use for the initial connection to the DB.

Also, you can NOT enable TLS for the connection to the database of the tls_mgm module itself.

Default value is 0 (not enabled)

Set the use_tls parameter

...
modparam("tls_mgm", "client_domain", "dom1")
modparam("tls_mgm", "certificate", "[dom1]/etc/pki/tls/certs/opensips.pem")
modparam("tls_mgm", "private_key", "[dom1]/etc/pki/tls/private/opensips.key")
modparam("tls_mgm", "ca_list",     "[dom1]/etc/pki/tls/certs/ca.pem")
...
modparam("db_postgres", "use_tls", 1)
...
modparam("usrloc", "db_url", "postgres://root:1234@localhost/opensips?tls_domain=dom1")
...

Exported Functions

NONE

Installation and Running

Notes about installation and running.

Contributors

By Commit Statistics

Top contributors by DevScore⁽¹⁾, authored commits⁽²⁾ and lines added/removed⁽³⁾

#	Name	DevScore	Commits	Lines++	Lines—
1.	Henning Westerholt (@henningw)	122	31	2721	4094
2.	Bogdan-Andrei Iancu (@bogdan-iancu)	78	45	1225	1282
3.	Norman Brandinger (@NormB)	58	6	1501	2299
4.	Greg Fausak	42	3	4472	2
5.	Daniel-Constantin Mierla (@miconda)	28	20	375	228
6.	Liviu Chircu (@liviuchircu)	19	15	115	157
7.	Razvan Crainea (@razvancrainea)	16	13	212	29
8.	Jan Janak (@janakj)	12	8	308	31
9.	Vlad Paiu (@vladpaiu)	11	7	134	66
10.	Klaus Darilion	10	6	139	67

All remaining contributors: Maksym Sobolyev (@sobomax), Vlad Patrascu (@rvlad-patrascu), Stefan Darius (@dariusstefan), Ancuta Onofrei, Dusan Klinec (@ph4r05), Andrei Pelinescu-Onciul, Ruslan Bukin, Eseanu Marius Cristian (@eseanucristian), Ryan Bullock (@rrb3942), Razvan Pistolea, Konstantin Bokarius, Ken Rice, Dan Pascu (@danpascu), Peter Lemenkov (@lemenkov), Aron Podrigal (@ar45), Edson Gellert Schubert, Jarrod Baumann (@jarrodb).

(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

#	Name	Commit Activity
1.	Stefan Darius (@dariusstefan)	Jun 2026 - Jul 2026
2.	Razvan Crainea (@razvancrainea)	Oct 2011 - Jun 2026
3.	Ken Rice	Sep 2025 - Sep 2025
4.	Liviu Chircu (@liviuchircu)	Sep 2012 - May 2024
5.	Bogdan-Andrei Iancu (@bogdan-iancu)	Jul 2005 - Feb 2024
6.	Maksym Sobolyev (@sobomax)	Apr 2004 - Feb 2023
7.	Vlad Patrascu (@rvlad-patrascu)	May 2017 - Oct 2021
8.	Norman Brandinger (@NormB)	Aug 2006 - Oct 2021
9.	Dan Pascu (@danpascu)	May 2019 - May 2019
10.	Ryan Bullock (@rrb3942)	Mar 2019 - Mar 2019

All remaining contributors: Vlad Paiu (@vladpaiu), Peter Lemenkov (@lemenkov), Jarrod Baumann (@jarrodb), Dusan Klinec (@ph4r05), Aron Podrigal (@ar45), Eseanu Marius Cristian (@eseanucristian), Razvan Pistolea, Ruslan Bukin, Henning Westerholt (@henningw), Daniel-Constantin Mierla (@miconda), Konstantin Bokarius, Edson Gellert Schubert, Ancuta Onofrei, Klaus Darilion, Jan Janak (@janakj), Greg Fausak, Andrei Pelinescu-Onciul.

(1) including any documentation-related commits, excluding merge commits

Documentation

Contributors

Last edited by: Razvan Crainea (@razvancrainea), Bogdan-Andrei Iancu (@bogdan-iancu), Vlad Patrascu (@rvlad-patrascu), Norman Brandinger (@NormB), Liviu Chircu (@liviuchircu), Peter Lemenkov (@lemenkov), Aron Podrigal (@ar45), Eseanu Marius Cristian (@eseanucristian), Vlad Paiu (@vladpaiu), Daniel-Constantin Mierla (@miconda), Konstantin Bokarius, Edson Gellert Schubert, Henning Westerholt (@henningw), Jan Janak (@janakj).

License

All documentation files (i.e. .md extension) are licensed under the Creative Common License 4.0