# &adminguide;

## Overview

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.

## 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

### `db_url` (string)

URL of the database server to be used.

Default value is &defaultdb;.

#### Set `db_url` parameter

    ...
    modparam("mtree", "db_url", "&exampledb;")
    ...

### `db_table` (string)

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).

#### Set `db_table` parameter

    ...
    modparam("mtree", "db_table", "mtrees")
    ...

### `mtree` (string)

Definition of memory tree with using a parameters format string. The parameter names can be:

- name - the name of the tree to be used for referencing inside configuration file.

- mode - the mode of items management. If set to 0 (default), the items are (re)loaded from database. If set to 1, it is an in-memory only tree, the items can be added with modparam 'item'.

- 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, 1 = d:w, 2 = integer). None-zero is valid only when the (tprefix, tvalue) pairs are loaded (not for multi-column values).

  When the type is 1, the value in database has to be two integers separated by colon, the first one (d - dstid) will be stored in pv_dstid AVP and the second (w - weight) will be stored in pv_weight AVP. If in the matching records are many with the same dstid, it will keep only the one with the longest prefix. Then the records are ordered by the weight and stored in the specified AVPs. The number of stored records is saved in pv_count variable.

- 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.

#### 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'")
    ...

### `tname_column` (string)

Name of 'tname' column.

Default value is tname.

#### Set `tname_column` parameter

    ...
    modparam("mtree", "tname_column", "name")
    ...

### `tprefix_column` (string)

Name of 'tprefix' column.

Default value is tprefix.

#### Set `tprefix_column` parameter

    ...
    modparam("mtree", "tprefix_column", "prefix")
    ...

### `tvalue_column` (string)

Name of 'tvalue' column.

Default value is tvalue.

#### Set `tvalue_column` parameter

    ...
    modparam("mtree", "tvalue_column", "ipaddr")
    ...

### `fetch_rows` (integer)

Number of rows to be loaded in one step from database.

Default value is 1000.

#### Set `fetch_rows` parameter

    ...
    modparam("mtree", "fetch_rows", 4000)
    ...

### `char_list` (string)

The list with characters allowed in prefix.

Default value is 0123456789.

#### Set `char_list` parameter

    ...
    modparam("mtree", "char_list", "0123456789*+")
    ...

### `item` (string)

Add items to a mtree. The value has to contain the tree name, prefix and value, separated by the first character of the value. For example, if the wanted separator is ':', then the value format is ':tname:tprefix:tvalue'.

If parameter "char_list" has to be set, it must be done before "item".

Default value is .

#### Set `item` parameter

    ...
    # modparam("mtree", "item", ":tname:tprefix:tvalue")

    modparam("mtree", "item", ":mytree:12345:alice")
    modparam("mtree", "item", ":mytree:54321:carol")
    ...

### `pv_value` (string)

The PV spec where to store the matched value. It can be any writable PV.

Default value is $avp(s:tvalue).

#### Set `pv_value` parameter

    ...
    modparam("mtree", "pv_value", "$var(mtval)")
    ...

### `pv_values` (string)

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).

#### Set `pv_values` parameter

    ...
    modparam("mtree", "pv_values", "$avp(mtvals)")
    ...

### `pv_dstid` (string)

The AVP name where to store the first integer value when tree type is 1.

Default value is $avp(tdstid).

#### Set `pv_dstid` parameter

    ...
    modparam("mtree", "pv_dstid", "$var(dstid)")
    ...

### `pv_weight` (string)

The AVP name where to store the second integer value when tree type is 1.

Default value is $avp(tweight).

#### Set `pv_weight` parameter

    ...
    modparam("mtree", "pv_dstid", "$var(weight)")
    ...

### `pv_count` (string)

The PV spec where to store the count of matched values when tree type is 1. It can be any writable PV.

Default value is $avp(tcount).

#### Set `pv_count` parameter

    ...
    modparam("mtree", "pv_count", "$var(count)")
    ...

### `mt_tree_type` (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 `mt_tree_type` parameter

    ...
    modparam("mtree", "mt_tree_type", 2)
    ...

### `mt_ignore_duplicates` (integer)

Ignore duplicated prefixes when loading data.

Default value is 0.

#### Set `mt_ignore_duplicates` parameter

    ...
    modparam("mtree", "mt_ignore_duplicates", 1)
    ...

### `mt_allow_duplicates` (integer)

Allow duplicate prefixes when loading data.

Default value is 0.

#### Set `mt_allow_duplicates` parameter

    ...
    modparam("mtree", "mt_allow_duplicates", 1)
    ...

## Functions

### `mt_match(mtree, pv, mode)`

Match 'pv' value against 'mtree'. If 'mtree' type is 0 or 2 and value of 'mode' is NOT 2, sets associated 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.

#### `mt_match` usage

    ...
    mt_match("mytree", "$rU", "0");
    ...

## RPC Commands

### `mtree.list`

List content of one or all trees.

Name: mtree.list

Parameters:

- _mtree_ : name of tree to list (optional).

#### `mtree.list` rpc usage

    ...
    &kamctl; rpc mtree.list
    &kamctl; rpc mtree.list mytree
    ...

### `mtree.summary`

List usage summary for all trees or for the tree whose name is given as parameter.

Parameters:

- _mtree_ - (optional) the name of the tree.

### `mtree.reload`

Reload mtree from database to memory.

Parameters:

- _mtree_

  - name of mtree or empty string meaning all mtrees

### `mtree.match`

Match prefix value against mtree

Parameters:

- _mtree_

  - name of mtree

- _prefix_

  - match prefix

- _mode_

  - matching mode