&adminguide;

Overview This module loads data indexed by prefixes from database and returns associated string or precompiled value.

Dependencies

&kamailio; Modules The following modules must be loaded before this module: A &kamailio; database module (e.g., mysql).

External Libraries or Applications The following libraries or applications must be installed before running &kamailio; with this module loaded: None.

Parameters

<varname>db_url</varname> (string) URL of the database server to be used. Default value is &defaultdb;. Set <varname>db_url</varname> parameter ... modparam("mtree", "db_url", "&exampledb;") ...

<varname>db_table</varname> (string) Name of DB table where data for trees is store. It is ignored if a 'mtree' parameter is defined. Default value is mtrees. Set <varname>db_table</varname> parameter ... modparam("mtree", "db_table", "mymtrees") ...

<varname>mtree</varname> (string) Definition of memory tree Default value is none. Set <varname>mtree</varname> parameter ... modparam("mtree", "mtree", "name=mytable;dbtable=routes;type=0;") ...

<varname>tname_column</varname> (string) Name of 'tname' column. Default value is tname. Set <varname>tname_column</varname> parameter ... modparam("mtree", "tname_column", "name") ...

<varname>tprefix_column</varname> (string) Name of 'tprefix' column. Default value is tprefix. Set <varname>tprefix_column</varname> parameter ... modparam("mtree", "tprefix_column", "prefix") ...

<varname>tvalue_column</varname> (string) Name of 'tvalue' column. Default value is tvalue. Set <varname>tvalue_column</varname> parameter ... modparam("mtree", "tvalue_column", "ipaddr") ...

<varname>fetch_rows</varname> (integer) Number of rows to be loaded in one step from database. Default value is 1000. Set <varname>fetch_rows</varname> parameter ... modparam("mtree", "fetch_rows", 4000) ...

<varname>char_list</varname> (string) The list with characters allowed in prefix. Default value is 0123456789. Set <varname>char_list</varname> parameter ... modparam("mtree", "char_list", "0123456789*+") ...

<varname>pv_value</varname> (string) The PV spec where to store the matched value. It can be any writtable PV. Default value is $avp(s:tvalue). Set <varname>pv_value</varname> parameter ... modparam("mtree", "pv_value", "$var(mtval)") ...

<varname>pv_values</varname> (string) The PV spec where to store the matched values when mtree is of type 0 or 2 and mode of mt_match() call has value 2. It can be any AVP. Default value is $avp(s:tvalues). Set <varname>pv_values</varname> parameter ... modparam("mtree", "pv_values", "$avp(mtvals)") ...

<varname>mt_tree_type</varname> (integer) 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. Set <varname>mt_tree_type</varname> parameter ... modparam("mtree", "mt_tree_type", 2) ...

<varname>mt_ignore_duplicates</varname> (integer) Ignore duplicated prefixes when loading data. Default value is 0. Set <varname>mt_ignore_duplicates</varname> parameter ... modparam("mtree", "mt_ignore_duplicates", 1) ...

<varname>mt_allow_duplicates</varname> (integer) Allow duplicate prefixes when loading data. Default value is 0. Set <varname>mt_allow_duplicates</varname> parameter ... modparam("mtree", "mt_allow_duplicates", 1) ...

Functions

<function moreinfo="none">mt_match(mtree, pv, mode)</function> Match 'pv' value against 'mtree'. If 'mtree' type is 0 or 2 and value of 'mode' is NOT 2, sets a value of 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. <function>mt_match</function> usage ... mt_match("mytree", "$rU", "0"); ...

MI Commands

<function moreinfo="none">mt_list</function> List content of a tree. Name: mt_list Parameters: _mtree_ : name of tree to list. MI FIFO Command Format: :mt_list:_reply_fifo_file_ _mtname_ _empty_line_

<function moreinfo="none">mt_reload</function> Reload mtree from database. Name: mt_mtree Parameters: _mtname_ - name of mem tree MI FIFO Command Format: :mt_reload:_reply_fifo_file_ _mtname_ _empty_line_

<function moreinfo="none">mt_summary</function> List usage summary for all trees. Name: mt_summary Parameters: none. MI FIFO Command Format: :mt_summary:_reply_fifo_file_ _empty_line_