Table of Contents
List of Tables
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 (string) - the name of the table to search for the alias
flags (string, optional) - set of character 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 reverse 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 (string) - the name of the table to search for the alias
input_uri (string) - a SIP URI to look up
output_var (var) - a variable to hold the SIP URI result
flags (string, optional) (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, STARTUP_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. |
Table 3.1. Top contributors by DevScore(1), authored commits(2) and lines added/removed(3)
| Name | DevScore | Commits | Lines ++ | Lines -- | |
|---|---|---|---|---|---|
| 1. | Bogdan-Andrei Iancu (@bogdan-iancu) | 32 | 27 | 216 | 170 |
| 2. | Daniel-Constantin Mierla (@miconda) | 15 | 12 | 28 | 64 |
| 3. | Liviu Chircu (@liviuchircu) | 12 | 9 | 48 | 62 |
| 4. | Razvan Crainea (@razvancrainea) | 8 | 6 | 10 | 8 |
| 5. | Henning Westerholt (@henningw) | 6 | 4 | 48 | 49 |
| 6. | Elena-Ramona Modroiu | 5 | 3 | 92 | 39 |
| 7. | Walter Doekes (@wdoekes) | 5 | 3 | 7 | 7 |
| 8. | Vlad Patrascu (@rvlad-patrascu) | 5 | 2 | 38 | 88 |
| 9. | Vladimir Romanov | 4 | 1 | 227 | 51 |
| 10. | Sergey Khripchenko (@shripchenko) | 3 | 1 | 18 | 22 |
All remaining contributors: Sergio Gutierrez, Konstantin Bokarius, Anca Vamanu, Dusan Klinec (@ph4r05), Peter Lemenkov (@lemenkov), 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. Regarding imported patches/code, we do our best to count the work on behalf of the proper owner, as per the "fix_authors" and "mod_renames" arrays in opensips/doc/build-contrib.sh. If you identify any patches/commits which do not get properly attributed to you, please submit a pull request which extends "fix_authors" and/or "mod_renames".
(3) ignoring whitespace edits, renamed files and auto-generated files
Table 3.2. Most recently active contributors(1) to this module
| Name | Commit Activity | |
|---|---|---|
| 1. | Walter Doekes (@wdoekes) | Apr 2010 - Apr 2021 |
| 2. | Bogdan-Andrei Iancu (@bogdan-iancu) | Oct 2005 - Mar 2020 |
| 3. | Razvan Crainea (@razvancrainea) | Jun 2011 - Sep 2019 |
| 4. | Liviu Chircu (@liviuchircu) | Mar 2014 - Apr 2019 |
| 5. | Vlad Patrascu (@rvlad-patrascu) | May 2017 - Apr 2019 |
| 6. | Peter Lemenkov (@lemenkov) | Jun 2018 - Jun 2018 |
| 7. | Dusan Klinec (@ph4r05) | Dec 2015 - Dec 2015 |
| 8. | Sergey Khripchenko (@shripchenko) | Sep 2015 - Sep 2015 |
| 9. | Anca Vamanu | Sep 2009 - Sep 2009 |
| 10. | Vladimir Romanov | May 2009 - May 2009 |
All remaining contributors: Sergio Gutierrez, Henning Westerholt (@henningw), Elena-Ramona Modroiu, Daniel-Constantin Mierla (@miconda), Konstantin Bokarius, Edson Gellert Schubert.
(1) including any documentation-related commits, excluding merge commits
Last edited by: Liviu Chircu (@liviuchircu), Peter Lemenkov (@lemenkov), Sergey Khripchenko (@shripchenko), Razvan Crainea (@razvancrainea), Walter Doekes (@wdoekes), Bogdan-Andrei Iancu (@bogdan-iancu), Sergio Gutierrez, Henning Westerholt (@henningw), Elena-Ramona Modroiu, Daniel-Constantin Mierla (@miconda), Konstantin Bokarius, Edson Gellert Schubert.
Documentation Copyrights:
Copyright © 2005-2009 Voice Sistem SRL