modules/db_mongodb/README
53771bd5
 DB_MONGODB Module
 
 Daniel-Constantin Mierla
 
    <miconda@gmail.com>
 
 Edited by
 
 Daniel-Constantin Mierla
 
    <miconda@gmail.com>
 
59daee29
    Copyright � 2014 asipto.com
53771bd5
      __________________________________________________________________
 
    Table of Contents
 
    1. Admin Guide
 
         1. Overview
fc0711c6
         2. Limitations
         3. Dependencies
53771bd5
 
fc0711c6
               3.1. Kamailio Modules
               3.2. External Libraries or Applications
53771bd5
 
fc0711c6
         4. Usage
53771bd5
 
    List of Examples
 
    1.1. Usage
 
 Chapter 1. Admin Guide
 
    Table of Contents
 
    1. Overview
fc0711c6
    2. Limitations
    3. Dependencies
53771bd5
 
fc0711c6
         3.1. Kamailio Modules
         3.2. External Libraries or Applications
53771bd5
 
fc0711c6
    4. Usage
53771bd5
 
 1. Overview
 
    This module provides DB APIv1 connector for MongoDB NoSQL server.
 
    It can be used as a replacement for other database modules such as
    db_mysql, db_postgres, a.s.o. Not all the specs of DB APIv1 are
    implemented, thus the usage of this module might be restricted to
    specific modules.
 
    You can read more about MongoDB at: http://www.mongodb.org.
 
fc0711c6
 2. Limitations
53771bd5
 
fc0711c6
    This module has implemented the equivalent operations for INSERT,
    UPDATE, DELETE and SELECT. The match condition (WHERE clause) works
    with the operators: equal, not equal, greater than, less than, equal or
    greater than, equal or less than. Raw query is not implemented inside
    this module, use ndb_mongodb for sending any kind of command to a
    MongoDB server.
53771bd5
 
fc0711c6
 3. Dependencies
53771bd5
 
fc0711c6
    3.1. Kamailio Modules
    3.2. External Libraries or Applications
53771bd5
 
fc0711c6
 3.1. Kamailio Modules
53771bd5
 
    The following modules must be loaded before this module:
      * none.
 
fc0711c6
 3.2. External Libraries or Applications
53771bd5
 
    The following libraries or applications must be installed before
    running Kamailio with this module loaded:
      * mongo-c-driver - available at
        https://github.com/mongodb/mongo-c-driver
59daee29
        Note: if you use tls module, use at least mongo-c-driver v1.2.1 -
        there were reports of issues inside earlier versions of the driver.
53771bd5
 
fc0711c6
 4. Usage
53771bd5
 
    Load the module and set the the DB URL for specific modules to:
    mongodb://username:password@host:port/database. Username, password and
    port are optional.
 
    Example 1.1. Usage
 ...
 loadmodule "db_mongodb.so"
 ...
 #!define DBURL "mongodb://localhost/kamailio"
 modparam("acc", "db_url", DBURL)
 ...