Table of Contents
db_url (string)
db_table (string)
mtree (string)
tname_column (string)
tprefix_column (string)
tvalue_column (string)
fetch_rows (integer)
char_list (string)
pv_value (string)
pv_values (string)
mt_tree_type (integer)
mt_ignore_duplicates (integer)
mt_allow_duplicates (integer)
List of Examples
db_url parameterdb_table parametermtree parametertname_column parametertprefix_column parametertvalue_column parameterfetch_rows parameterchar_list parameterpv_value parameterpv_values parametermt_tree_type parametermt_ignore_duplicates parametermt_allow_duplicates parametermt_match usagemtree.list rpc usageTable of Contents
db_url (string)
db_table (string)
mtree (string)
tname_column (string)
tprefix_column (string)
tvalue_column (string)
fetch_rows (integer)
char_list (string)
pv_value (string)
pv_values (string)
mt_tree_type (integer)
mt_ignore_duplicates (integer)
mt_allow_duplicates (integer)
This module loads (prefix, value) records from database and indexes them in a named memory tree. Name of the tree is specified for each record or as module parameter.
It exports to configuration file functions to match against in-memory trees and return the values (raw or precompiled) associated with matched prefixes.
The maximum size of the prefix is limited internally to 63, database table definition may enforce lower maximum size.
The following modules must be loaded before this module:
A Kamailio database module (e.g., mysql).
URL of the database server to be used.
Default value is “mysql://kamailio:kamailiorw@localhost/kamailio”.
Example 1.1. Set db_url parameter
...
modparam("mtree", "db_url", "dbdriver://username:password@dbhost/dbname")
...
Name of database table where data for many trees is stored. It is ignored if a 'mtree' parameter is defined. The SQL scripts creates a table named 'mtrees' that can be used for this parameter.
Default value is “” (no table name).
Definition of memory tree with using a prameters format string. The parameter names can be:
name - the name of the tree to be used for referencing inside configuration file.
dbtable - the name of the database table from where to load the records stored in the tree.
cols - the column names of the database table. They must be enclosed in quotes in order to form a valid SIP parameter value and be separated by comma. The first column corresponds to tprefix. When specified, there must be at least two columns. If this attribute is not specified, then the global module parameters for tprefix and tvalue are used. If more than one value columns are specified, the tree will pack the column values in a comma separated string, which will be associated with the prefix (string transformation {s.select,...) can be used in configuration file to extract a specific column value).
type - the type of tree elements (0 = string, 2 = integer). It is valid only when the (tprefix, tvalue) pairs are loaded (not for multi-column values).
multi - tells if dbtable can contain more than one tree (0 = one tree, 1 = more than one tree identified by tname column). It is valid only when the (tprefix, tvalue) pairs are loaded (not for multi-column values).
This parameter can be set many times to add more trees in memory.
Default value is “none”.
Example 1.3. Set mtree parameter
...
modparam("mtree", "mtree", "name=mytree1;dbtable=routes1;type=0")
modparam("mtree", "mtree", "name=mytree2;dbtable=routes2;type=0;multi=1")
modparam("mtree", "mtree",
"name=mytree1;dbtable=routes1;cols='key1,val1,val2,val3'")
...
Name of 'tname' column.
Default value is “tname”.
Name of 'tprefix' column.
Default value is “tprefix”.
Name of 'tvalue' column.
Default value is “tvalue”.
Number of rows to be loaded in one step from database.
Default value is 1000.
The list with characters allowed in prefix.
Default value is “0123456789”.
The PV spec where to store the matched value. It can be any writable PV.
Default value is “$avp(s:tvalue)”.
The AVP where to store the matched values when mtree is of type 0 or 2 and mode of mt_match() call has value 2.
Default value is “$avp(s:tvalues)”.
Default payload type for trees data stored in 'db_table'. Documented values are 0 for string payloads and 2 for integer payloads.
Default value is 0.
Match 'pv' value against 'mtree'. If 'mtree' type is 0 or 2 and value of 'mode' is NOT 2, sets a value of the longest matching prefix to pseudo variable specified by pv_value parameter. If 'mtree' type is 0 or 2 and value of 'mode' is 2, sets values of all matching prefixes to avp specified by pv_values parameter so that a value of longest matching prefix is in avp index 0. Parameter 'mode' can be an integer constant or a pseudo variable with integer value.
Returns 1 if match succeeded and -1 otherwise.
List content of one or all trees.
Name: mtree.list
Parameters:
_mtree_ : name of tree to list (optional).
List usage summary for all trees or for the tree whose name is given as parameter.
Parameters:
_mtree_ - (optional) the name of the tree.
Reload mtree from database to memory.
Parameters:
_mtree_
- name of mtree or empty string meaning all mtreesTable of Contents
The function imports all API functions that are exported by the mtree module (see sections below).
Meaning of the parameters is as follows:
mtree_api_t* api - mtree API