ALIAS_DB module
Admin Guide
Section titled “Admin Guide”Overview
Section titled “Overview”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, the search can be performed on different tables in the same script.
Dependencies
Section titled “Dependencies”OpenSIPS Modules
Section titled “OpenSIPS Modules”The following modules must be loaded before this module:
- database module (mysql, dbtext, …).
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:
- None.
Exported Parameters
Section titled “Exported Parameters”db_url (str)
Section titled “db_url (str)”Database URL.
Default value is “mysql://opensipsro:opensipsro@localhost/opensips”.
...modparam("alias_db", "db_url", "dbdriver://username:password@dbhost/dbname")...user_column (str)
Section titled “user_column (str)”Name of the column storing username.
Default value is “username”.
...modparam("alias_db", "user_column", "susername")...domain_column (str)
Section titled “domain_column (str)”Name of the column storing user’s domain.
Default value is “domain”.
...modparam("alias_db", "domain_column", "sdomain")...alias_user_column (str)
Section titled “alias_user_column (str)”Name of the column storing alias username.
Default value is “alias_username”.
...modparam("alias_db", "alias_user_column", "auser")...alias_domain_column (str)
Section titled “alias_domain_column (str)”Name of the column storing alias domain.
Default value is “alias_domain”.
...modparam("alias_db", "alias_domain_column", "adomain")...use_domain (int)
Section titled “use_domain (int)”Specifies whether to use or not the domain from R-URI when searching for alias. If set to 0, the domain from R-URI is not used, if set to 1 the domain from R-URI is used.
Default value is “0”.
...modparam("alias_db", "use_domain", 1)...domain_prefix (str)
Section titled “domain_prefix (str)”Specifies the prefix to be stripped from the domain in R-URI before doing the search.
Default value is “NULL”.
...modparam("alias_db", "domain_prefix", "sip.")...append_branches (int)
Section titled “append_branches (int)”If the alias resolves to many SIP IDs, the first is replacing the R-URI, the rest are added as branches.
Default value is “0” (0 - don’t add branches; 1 - add branches).
...modparam("alias_db", "append_branches", 1)...Exported Functions
Section titled “Exported Functions”alias_db_lookup(table_name)
Section titled “alias_db_lookup(table_name)”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.
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
...alias_db_lookup("dbaliases");alias_db_lookup("dba_$(rU{s.substr,0,1})");...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. | Bogdan-Andrei Iancu (@bogdan-iancu) | 18 | 12 | 161 | 205 |
| 2. | Daniel-Constantin Mierla (@miconda) | 15 | 12 | 28 | 64 |
| 3. | Stefan Darius (@dariusstefan) | 7 | 3 | 242 | 25 |
| 4. | Elena-Ramona Modroiu | 7 | 3 | 142 | 89 |
| 5. | Henning Westerholt (@henningw) | 6 | 4 | 51 | 52 |
| 6. | Sergio Gutierrez | 3 | 1 | 3 | 3 |
| 7. | Razvan Crainea (@razvancrainea) | 3 | 1 | 2 | 2 |
| 8. | Konstantin Bokarius | 3 | 1 | 2 | 5 |
| 9. | Edson Gellert Schubert | 3 | 1 | 0 | 104 |
(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. | Sergio Gutierrez | Feb 2009 - Feb 2009 |
| 4. | Bogdan-Andrei Iancu (@bogdan-iancu) | Oct 2005 - Jul 2008 |
| 5. | Henning Westerholt (@henningw) | Dec 2007 - Jun 2008 |
| 6. | Elena-Ramona Modroiu | Oct 2005 - May 2008 |
| 7. | Daniel-Constantin Mierla (@miconda) | Jun 2005 - Mar 2008 |
| 8. | Konstantin Bokarius | Mar 2008 - Mar 2008 |
| 9. | Edson Gellert Schubert | Feb 2008 - Feb 2008 |
(1) including any documentation-related commits, excluding merge commits
Documentation
Section titled “Documentation”Contributors
Section titled “Contributors”Last edited by: Razvan Crainea (@razvancrainea), Sergio Gutierrez, Bogdan-Andrei Iancu (@bogdan-iancu), Henning Westerholt (@henningw), Elena-Ramona Modroiu, Daniel-Constantin Mierla (@miconda), Konstantin Bokarius, Edson Gellert Schubert.
License
Section titled “License”All documentation files (i.e. .md extension) are licensed under the Creative Common License 4.0