<?xml version="1.0" encoding='ISO-8859-1'?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [

<!-- Include general documentation entities -->
<!ENTITY % docentities SYSTEM "../../../docbook/entities.xml">
%docentities;

]>

<!--
WARNING:
This file was autogenerated from the XML source file
../../modules/matrix/doc/kamailio-matrix.xml.
It can be regenerated by running 'make dbdoc' in the db/schema
directory of the source code. You need to have xsltproc and
docbook-xsl stylesheets installed.
ALL CHANGES DONE HERE WILL BE LOST IF THE FILE IS REGENERATED
-->

<chapter>
  <title>Module parameter for database access.</title>
  <section>
    <title><varname>db_url</varname> (String)</title>
    <para>URL to the database containing the data.</para>
    <para>
      <emphasis>Default value is <quote>&defaultrodb;</quote>.</emphasis>
    </para>
    <example>
      <title>Set <varname>db_url</varname> parameter</title>
      <programlisting format="linespecific">
...
modparam("matrix", "db_url", "dbdriver://username:password@dbhost/dbname")
...
</programlisting>
    </example>
  </section>
  <section>
    <title><varname>matrix_table</varname> (String)</title>
    <para>Name of the matrix table for the matrix module.</para>
    <para>
      <emphasis>Default value is <quote>matrix</quote>.</emphasis>
    </para>
    <example>
      <title>Set <varname>matrix_table</varname> parameter</title>
      <programlisting format="linespecific">
...
modparam("matrix", "matrix_table", "matrix")
...
</programlisting>
    </example>
  </section>
  <section>
    <title><varname>matrix_first_col</varname> (string)</title>
    <para>The row index in the matrix</para>
    <example>
      <title>Set <varname>matrix_first_col</varname> parameter</title>
      <programlisting format="linespecific">
...
modparam("matrix", "matrix_first_col", "first")
...
</programlisting>
    </example>
  </section>
  <section>
    <title><varname>matrix_second_col</varname> (string)</title>
    <para>The column index in the matrix</para>
    <example>
      <title>Set <varname>matrix_second_col</varname> parameter</title>
      <programlisting format="linespecific">
...
modparam("matrix", "matrix_second_col", "second")
...
</programlisting>
    </example>
  </section>
  <section>
    <title><varname>matrix_res_col</varname> (string)</title>
    <para>The resource contained in the matrix</para>
    <example>
      <title>Set <varname>matrix_res_col</varname> parameter</title>
      <programlisting format="linespecific">
...
modparam("matrix", "matrix_res_col", "res")
...
</programlisting>
    </example>
  </section>
</chapter>
