mysql Module

The following modules must be loaded before this module:

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

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

Default value is 0 - disabled.

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

Time interval after which a 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)
...

The maximum number of retries to execute a failed query due to connections problems. If this parameter is set improperly, it is set to default value.

Default value is 2.

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

The maximum number of database connection retries. If this parameter is set improperly, it is set to default value.

Default value is 3.

...
modparam("db_mysql", "max_db_retries", 2)
...

The maximum size of a column's data, when fetched using prepared statements. Particularly relevant for variable-length data, such as CHAR, BLOB, etc.

NOTE: Should a column's data exceed this limit, the value will be silently truncated to fit the buffer, without reporting any errors!

Default value is 1024 (bytes).

...
modparam("db_mysql", "ps_max_col_size", 4096)
...

Setting this parameter will allow you to use TLS for MySQL 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. Additionally, the query string may include the "tls_opts= PKEY,CERT,CA,CA_DIR,CIPHERS" CSV parameter, in order to control/limit the amount of TLS options passed to the TLS library.

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 that 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)

...
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_mysql", "use_tls", 1)
...
modparam("usrloc", "db_url", "mysql://root:1234@localhost/opensips?tls_domain=dom1")
...
modparam("usrloc", "db_url", "mysql://root:1234@localhost/opensips?tls_domain=dom1&tls_opts=PKEY,CERT,CA,CA_DIR,CIPHERS")
...

This event is raised when a MySQL connection is lost or recovered.

Parameters: