Table of Contents
List of Examples
ALIAS_DB module can be used as an alternative for user aliases via usrloc. The main feature is that it does not store all adjacent data as for user location and always uses database for search (no memory caching).
Having no memory caching, search speed might decrease but provisioning is easier. With very fast databases like MySQL, speed penalty can be lowered. Also, search can be performed on different tables in the same script.
The following modules must be loaded before this module:
database module (mysql, dbtext, ...).
Database URL.
Default value is “mysql://opensipsro:opensipsro@localhost/opensips”.
Example 1.1. Set db_url parameter
...
modparam("alias_db", "db_url", "dbdriver://username:password@dbhost/dbname")
...
Name of the column storing username.
Default value is “username”.
Name of the column storing user's domain.
Default value is “domain”.
Name of the column storing alias username.
Default value is “alias_username”.
Example 1.4. Set alias_user_column parameter
...
modparam("alias_db", "alias_user_column", "auser")
...
Name of the column storing alias domain.
Default value is “alias_domain”.
Example 1.5. Set alias_domain_column parameter
...
modparam("alias_db", "alias_domain_column", "adomain")
...
Specifies the prefix to be stripped from the domain in R-URI before doing the search.
Default value is “NULL”.
The function takes the R-URI and search to see whether it is an alias or not. If it is an alias for a local user, the R-URI is replaced with user's SIP uri.
The function returns TRUE if R-URI is alias and it was replaced by user's SIP uri.
Meaning of the parameters is as follows:
table_name - the name of the table where to search for alias. It can include pseudo-variables.
flags (optional) - set of flags (char based flags) to control the alias lookup process:
d - do not use domain URI part in the alias lookup query (use only a username-based lookup). By default, both username and domain are used.
r - do revers alias lookup - lookup for the alias mapped to the current URI (URI 2 alias translation); normally, the function looks up for the URI mapped to the alias (alias 2 URI translation).
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
Example 1.8. alias_db_lookup() usage
...
alias_db_lookup("dbaliases" , "rd");
alias_db_lookup("dba_$(rU{s.substr,0,1})");
...
The function is very similar to alias_db_lookup(),
but instead of using fixed input (RURI) and output (RURI) is able to
get the input SIP URI from a pseudo-variable and place the result back
also in a pseudo-variable.
The function is useful as the alias lookup does not affect the request itself (no RURI changes), can be used in a reply context (as it does not work with RURI only) and can be used for others URI than the RURI (To URI, From URI, custom URI).
The function returns TRUE if any alias mapping was found and returned.
Meaning of the parameters is as follows:
table_name - the name of the table where to search for alias. It can include pseudo-variables.
input - any PV (pseudo-variable) carrying the SIP URI that needs to be looked up.
ouput - PV (AVP or script VAR) where to place the SIP URI resulting from the alias lookup.
flags (optional) - set of flags (char based flags) to control the alias lookup process:
d - do not use domain URI part in the alias lookup query (use only a username-based lookup). By default, both username and domain are used.
r - do revers alias lookup - lookup for the alias mapped to the current URI (URI 2 alias translation); normally, the function looks up for the URI mapped to the alias (alias 2 URI translation).
This function can be used from REQUEST_ROUTE, BRANCH_ROUTE, LOCAL_ROUTE, FAILURE_ROUTE and ONREPLY_ROUTE.
Example 1.9. alias_db_find() usage
...
# do revers alias lookup and find the alias for the FROM URI
alias_db_find("dbaliases" , "$fu", "$avp(from_alias)", "r");
...
2.1. | What happened with old use_domain parameter |
The global parameter (affecting the entire module) was replaced with a per lookup parameter (affecting only current lookup). See the "d" (do not used domain part) flag in the db_alias_lookup() and db_alias_find() functions. | |
2.2. | How can I report a bug? |
Please follow the guidelines provided at: https://github.com/OpenSIPS/opensips/issues. |