[sr-dev] git:master: db_cassandra Minor edits and typo fixes to README

Module: sip-router Branch: master Commit: e1306157b324d2ad21d97af0edf14072769787d7 URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=e130615… Author: Olle E. Johansson &lt;oej(a)edvina.net&gt; Committer: Olle E. Johansson &lt;oej(a)edvina.net&gt; Date: Wed Jan 9 14:00:32 2013 +0100 db_cassandra Minor edits and typo fixes to README --- modules/db_cassandra/README | 29 ++++++++++++----------- modules/db_cassandra/doc/db_cassandra_admin.xml | 18 +++++++------- 2 files changed, 24 insertions(+), 23 deletions(-) diff --git a/modules/db_cassandra/README b/modules/db_cassandra/README index 97df44e..f7806c8 100644 --- a/modules/db_cassandra/README +++ b/modules/db_cassandra/README @@ -14,7 +14,7 @@ Anca Vamanu &lt;anca.vamanu(a)1and1.ro&gt; - Copyright © 2012 1&1 Internet AG + Copyright � 2012 1&1 Internet AG __________________________________________________________________ Table of Contents @@ -61,9 +61,9 @@ Chapter 1. Admin Guide 1. Overview - Db_cassandra is one of the SIP Router database modules. It does not + Db_cassandra is one of the Kamailio database modules. It does not export any functions executable from the configuration scripts, but it - exports a subset of functions from the database API, and thus, other + exports a subset of functions using the database API, and thus, other modules can use it as a database driver, instead of, for example, the Mysql module. @@ -76,13 +76,14 @@ Chapter 1. Admin Guide two indexing levels. These issues will be explained in an example below. - Cassandra DB is especially suited for storing large data or data that - requires distribution, redundancy or replication. One usage example is - a distributed location system in a platform that has a cluster of SIP - Router servers, with more proxies and registration servers accessing - the same location database. This was actually the main use case we had - in mind when implementing this module. Please NOTE that it has only - been tested with the usrloc, auth_db and domain modules. + Cassandra DB is especially suited for storing large amounts of data or + data that requires distribution, redundancy or replication. One usage + example is a distributed location system in a platform that has a + cluster of SIP Router servers, with several proxies and registration + servers accessing the same location database. This was actually the + main use case we had in mind when implementing this module. Please NOTE + that it has only been tested with the usrloc, auth_db and domain + modules. You can find a configuration file example for this usage in the module - kamailio_cassa.cfg. @@ -157,14 +158,14 @@ default_validation_class='UTF8Type' and key_validation_class='UTF8Type'; The directory where the files with the table schemas are located. This directory has to contain the subdirectories corresponding to the - databases' names (name of the directory = name of the database). These + database name (name of the directory = name of the database). These directories, in turn, contain the files with the table schemas. See the schemas in utils/kamctl/dbcassandra directory. Example 1.1. Set schema_path parameter ... modparam("db_cassandra", "schema_path", - "/usr/local/sip-router/etc/kamctl/dbcassandra") + "/usr/local/kamailio/etc/kamctl/dbcassandra") ... 4. Functions @@ -173,7 +174,7 @@ default_validation_class='UTF8Type' and key_validation_class='UTF8Type'; 5. Installation - Because it dependes on an external library, the db_cassandra module is + Because the db_cassandra module dependes on an external library, it is not compiled and installed by default. You can use one of these options: * - edit the "Makefile" and remove "db_cassandra" from @@ -210,7 +211,7 @@ default_validation_class='UTF8Type' and key_validation_class='UTF8Type'; * Third row: the columns that form the secondary key separated by space. - Bellow you can see the schema for the location table (when use_domain + Below you can see the schema for the location table (when use_domain not set): ... diff --git a/modules/db_cassandra/doc/db_cassandra_admin.xml b/modules/db_cassandra/doc/db_cassandra_admin.xml index d52c907..78c8c9b 100644 --- a/modules/db_cassandra/doc/db_cassandra_admin.xml +++ b/modules/db_cassandra/doc/db_cassandra_admin.xml @@ -17,9 +17,9 @@ <section> <title>Overview</title> <para> - Db_cassandra is one of the &siprouter; database modules. It does + Db_cassandra is one of the &kamailio; database modules. It does not export any functions executable from the configuration scripts, - but it exports a subset of functions from the database API, and thus, + but it exports a subset of functions using the database API, and thus, other modules can use it as a database driver, instead of, for example, the Mysql module. </para> @@ -34,10 +34,10 @@ below. </para> <para> - Cassandra DB is especially suited for storing large data or data that requires - distribution, redundancy or replication. One usage example is + Cassandra DB is especially suited for storing large amounts of data or data + that requires distribution, redundancy or replication. One usage example is a distributed location system in a platform that has a cluster of &siprouter; - servers, with more proxies and registration servers accessing the same location + servers, with several proxies and registration servers accessing the same location database. This was actually the main use case we had in mind when implementing this module. Please NOTE that it has only been tested with the <emphasis>usrloc</emphasis>, <emphasis>auth_db</emphasis> and <emphasis>domain</emphasis> modules. @@ -143,7 +143,7 @@ default_validation_class='UTF8Type' and key_validation_class='UTF8Type'; <para> The directory where the files with the table schemas are located. This directory has to contain the subdirectories corresponding to the - databases' names (name of the directory = name of the database). + database name (name of the directory = name of the database). These directories, in turn, contain the files with the table schemas. See the schemas in utils/kamctl/dbcassandra directory. </para> @@ -152,7 +152,7 @@ default_validation_class='UTF8Type' and key_validation_class='UTF8Type'; <programlisting format="linespecific"> ... modparam("db_cassandra", "schema_path", - "/usr/local/sip-router/etc/kamctl/dbcassandra") + "/usr/local/kamailio/etc/kamctl/dbcassandra") ... </programlisting> </example> @@ -169,7 +169,7 @@ default_validation_class='UTF8Type' and key_validation_class='UTF8Type'; <section> <title>Installation</title> <para> - Because it dependes on an external library, the db_cassandra module is not + Because the db_cassandra module dependes on an external library, it is not compiled and installed by default. You can use one of these options: </para> <itemizedlist> @@ -232,7 +232,7 @@ default_validation_class='UTF8Type' and key_validation_class='UTF8Type'; </itemizedlist> </para> <para> - Bellow you can see the schema for the <emphasis>location</emphasis> + Below you can see the schema for the <emphasis>location</emphasis> table (when use_domain not set): </para> <para>