[sr-dev] git:master: db_cluster Add section IDs to XML file and update some text

Module: sip-router Branch: master Commit: 43d59fe1093e7319848794a7c266d3605f764d1a URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=43d59fe… Author: Olle E. Johansson &lt;oej(a)edvina.net&gt; Committer: Olle E. Johansson &lt;oej(a)edvina.net&gt; Date: Tue Apr 2 20:31:07 2013 +0200 db_cluster Add section IDs to XML file and update some text --- modules/db_cluster/README | 21 +++++++++++++-------- modules/db_cluster/doc/db_cluster_admin.xml | 25 +++++++++++++++---------- 2 files changed, 28 insertions(+), 18 deletions(-) diff --git a/modules/db_cluster/README b/modules/db_cluster/README index 6ece6af..cbdf261 100644 --- a/modules/db_cluster/README +++ b/modules/db_cluster/README @@ -62,10 +62,10 @@ Chapter 1. Admin Guide used as a middle layer between modules and database connectors. Via clustering, database operations can be executed across multiple - servers, based on policies such as paraller write, serial or round + servers, based on policies such as parallel write, serial or round robin write and read. - Following database commands are considered to be write operations: + The following database commands are considered to be write operations: INSERT, DELETE, UPDATE, REPLACE, INSERT-DELAYED, INSERT-UPDATE. The read operations are done for database commands: QUERY and RAW-QUERY. @@ -94,7 +94,8 @@ Chapter 1. Admin Guide 3.1. connection (str) Specify the connection to a real database system. The format is - 'conid=>DBURL' - providing a connection id and the database URL. + 'conid=>DBURL' - providing a connection id and the database URL used by + the database driver used. Default value is NULL. @@ -112,18 +113,22 @@ modparam("db_cluster", "connection", 'clsid=>conid1=def1;conid2=def2' - providing a cluster id and the list of database connections to be used. For each connection you have to provide a usage definition. The usage definition is a 4-char long - string, specifying priority and command mode for read an write - operations to be done on that connection. + string, specifying priority and command mode for read and write + operations to be performed on that connection. - The priority is a digit between 0 and 9, higher value is higher - priority. Priority 0 means that connection is not going to be used in - that cluster. + The priority is a digit between 0 and 9, where a higher value means + higher priority. Priority 0 means that the connection is not going to + be used in that cluster. Command mode is a character among s, r and p. s is for doing serial operations (try first and if fails, try next); r is for doing round robin operations; p - is for doing parallel operations (this is valid only for write operations). + The first two characters is priority and mode for read, followed by two + characters for priority and mode for write operations. "p" is only used + for write operations. + Default value is NULL. Example 1.2. Set cluster parameter diff --git a/modules/db_cluster/doc/db_cluster_admin.xml b/modules/db_cluster/doc/db_cluster_admin.xml index eef8eb9..d95cdaf 100644 --- a/modules/db_cluster/doc/db_cluster_admin.xml +++ b/modules/db_cluster/doc/db_cluster_admin.xml @@ -21,11 +21,11 @@ </para> <para> Via clustering, database operations can be executed across multiple - servers, based on policies such as paraller write, serial or round + servers, based on policies such as parallel write, serial or round robin write and read. </para> <para> - Following database commands are considered to be write operations: + The following database commands are considered to be write operations: INSERT, DELETE, UPDATE, REPLACE, INSERT-DELAYED, INSERT-UPDATE. The read operations are done for database commands: QUERY and RAW-QUERY. </para> @@ -63,12 +63,12 @@ </section> <section> <title>Parameters</title> - <section> + <section id="db_cluster.p.connection"> <title><varname>connection</varname> (str)</title> <para> Specify the connection to a real database system. The format is 'conid=>DBURL' - providing a connection id and the database - URL. + URL used by the database driver used. </para> <para> <emphasis> @@ -87,19 +87,19 @@ modparam("db_cluster", "connection", </programlisting> </example> </section> - <section> + <section id="db_cluster.p.cluster"> <title><varname>cluster</varname> (str)</title> <para> Specify the cluster definition. The format is 'clsid=>conid1=def1;conid2=def2' - providing a cluster id and the list of database connections to be used. For each connection you have to provide a usage definition. The usage definition is a 4-char long string, - specifying priority and command mode for read an write operations to be - done on that connection. + specifying priority and command mode for read and write operations to be + performed on that connection. </para> <para> - The priority is a digit between 0 and 9, higher value is higher priority. - Priority 0 means that connection is not going to be used in that cluster. + The priority is a digit between 0 and 9, where a higher value means higher priority. + Priority 0 means that the connection is not going to be used in that cluster. </para> <para> Command mode is a character among s, r and p. s is for doing serial @@ -108,6 +108,11 @@ modparam("db_cluster", "connection", only for write operations). </para> <para> + <para> + The first two characters is priority and mode for read, followed by + two characters for priority and mode for write operations. "p" is + only used for write operations. + </para> <emphasis> Default value is NULL. </emphasis> @@ -121,7 +126,7 @@ modparam("db_cluster", "cluster", "cls1=>con1=9s8p;con2=9s8p") </programlisting> </example> </section> - <section> + <section id="db_cluster.p.inactive_interval"> <title><varname>inactive_interval</varname> (int)</title> <para> How long (seconds) a connection is considered inactive after a DB