"Fossies" - the Fresh Open Source Software Archive

Member "opensips-3.0.1/modules/db_oracle/README" (1 Oct 2019, 6308 Bytes) of package /linux/misc/opensips-3.0.1.tar.gz:


As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file. See also the latest Fossies "Diffs" side-by-side code changes report for "README": 3.0.0_vs_3.0.1.

    1 oracle Module
    2      __________________________________________________________
    3 
    4    Table of Contents
    5 
    6    1. User's Guide
    7 
    8         1.1. Overview
    9         1.2. Dependencies
   10 
   11               1.2.1. OpenSIPS Modules
   12               1.2.2. External Libraries or Applications
   13 
   14         1.3. Exported Parameters
   15 
   16               1.3.1. timeout (fixedpoint)
   17               1.3.2. reconnect (fixedpoint)
   18 
   19         1.4. Exported Functions
   20         1.5. Installation
   21         1.6. Utility opensips_orasel
   22 
   23    2. Contributors
   24 
   25         2.1. By Commit Statistics
   26         2.2. By Commit Activity
   27 
   28    3. Documentation
   29 
   30         3.1. Contributors
   31 
   32    List of Tables
   33 
   34    2.1. Top contributors by DevScore^(1), authored commits^(2) and
   35           lines added/removed^(3)
   36 
   37    2.2. Most recently active contributors^(1) to this module
   38 
   39    List of Examples
   40 
   41    1.1. Set timeout parameter
   42    1.2. Disable asynchronous mode
   43    1.3. Set reconnect parameter
   44 
   45 Chapter 1. User's Guide
   46 
   47 1.1. Overview
   48 
   49    This is a module which provides Oracle connectivity for
   50    OpenSIPS. It implements the DB API defined in OpenSIPS. If you
   51    want to use the nathelper module, or any other modules that
   52    calls the get_all_ucontacts API export from usrloc, then you
   53    need to set the DORACLE_USRLOC define in the Makefile.defs file
   54    before compilation.
   55 
   56 1.2. Dependencies
   57 
   58 1.2.1. OpenSIPS Modules
   59 
   60    The following modules must be loaded before this module:
   61      * No dependencies on other OpenSIPS modules.
   62 
   63 1.2.2. External Libraries or Applications
   64 
   65    The following libraries or applications must be installed
   66    before running OpenSIPS with this module loaded:
   67      * instantclient-sdk-10.2.0.3 - the development headers and
   68        libraries of OCI.
   69 
   70 1.3. Exported Parameters
   71 
   72 1.3.1. timeout (fixedpoint)
   73 
   74    Timeout value for any operation with BD.
   75 
   76    Possible values is from 0.1 to 10.0 seconds.
   77 
   78    Default value is 3.0 (3 second).
   79 
   80    If value of timeout parameter set to 0, module use synchronous
   81    mode (without timeout).
   82 
   83    Example 1.1. Set timeout parameter
   84 ...
   85 modparam("db_oracle", "timeout", 1.5)
   86 ...
   87 
   88    Example 1.2. Disable asynchronous mode
   89 ...
   90 modparam("db_oracle", "timeout", 0)
   91 ...
   92 
   93 1.3.2. reconnect (fixedpoint)
   94 
   95    Timeout value for connect (create session) operation.
   96 
   97    Possible values is from 0.1 to 10.0 seconds.
   98 
   99    Default value is 0.2 (200 milliseconds).
  100 
  101    Example 1.3. Set reconnect parameter
  102 ...
  103 modparam("db_oracle", "reconnect", 0.5)
  104 ...
  105 
  106 1.4. Exported Functions
  107 
  108    No function exported to be used from configuration file.
  109 
  110 1.5. Installation
  111 
  112    Because it dependes on an external library, the oracle module
  113    is not compiled and installed by default. You can use one of
  114    the next options.
  115      * - edit the "Makefile" and remove "db_oracle" from
  116        "excluded_modules" list. Then follow the standard procedure
  117        to install OpenSIPS: "make all; make install".
  118      * - from command line use: 'make all
  119        include_modules="db_oracle"; make install
  120        include_modules="db_oracle"'.
  121 
  122 1.6. Utility opensips_orasel
  123 
  124    For working with opensips-cli tool, should be able to print the
  125    'query' results to the terminal in a user-readable form. The
  126    standard command-line Oracle client (sqlplus) is not quite
  127    suitable for this, as it cannot align row width to real
  128    (received) data's (it always prints a cell width as described
  129    in the db scheme). This problem has been solved by inclusion
  130    the utility opensips_orasel, which formats printing
  131    approximately in the same way as the 'mysql' client utility. In
  132    addition, this utility known about the "agreements and types"
  133    in DB that are used in OpenSIPS for the work with Oracle and
  134    formats printing taking these into account.
  135 
  136 Chapter 2. Contributors
  137 
  138 2.1. By Commit Statistics
  139 
  140    Table 2.1. Top contributors by DevScore^(1), authored
  141    commits^(2) and lines added/removed^(3)
  142      Name DevScore Commits Lines ++ Lines --
  143    1. Iouri Kharon 20 1 2363 0
  144    2. Bogdan-Andrei Iancu (@bogdan-iancu) 17 14 93 86
  145    3. Liviu Chircu (@liviuchircu) 11 8 23 81
  146    4. Razvan Crainea (@razvancrainea) 9 7 103 32
  147    5. Peter Lemenkov (@lemenkov) 7 5 41 5
  148    6. Henning Westerholt (@henningw) 5 3 19 7
  149    7. Vlad Patrascu (@rvlad-patrascu) 4 2 3 3
  150    8. fabriziopicconi 3 1 18 2
  151    9. Ovidiu Sas (@ovidiusas) 3 1 12 12
  152    10. Sergio Gutierrez 3 1 4 1
  153 
  154    All remaining contributors: Julián Moreno Patiño, Razvan
  155    Pistolea.
  156 
  157    (1) DevScore = author_commits + author_lines_added /
  158    (project_lines_added / project_commits) + author_lines_deleted
  159    / (project_lines_deleted / project_commits)
  160 
  161    (2) including any documentation-related commits, excluding
  162    merge commits. Regarding imported patches/code, we do our best
  163    to count the work on behalf of the proper owner, as per the
  164    "fix_authors" and "mod_renames" arrays in
  165    opensips/doc/build-contrib.sh. If you identify any
  166    patches/commits which do not get properly attributed to you,
  167    please submit a pull request which extends "fix_authors" and/or
  168    "mod_renames".
  169 
  170    (3) ignoring whitespace edits, renamed files and auto-generated
  171    files
  172 
  173 2.2. By Commit Activity
  174 
  175    Table 2.2. Most recently active contributors^(1) to this module
  176                       Name                   Commit Activity
  177    1.  Razvan Crainea (@razvancrainea)     Oct 2011 - Sep 2019
  178    2.  Bogdan-Andrei Iancu (@bogdan-iancu) Jul 2008 - May 2019
  179    3.  Liviu Chircu (@liviuchircu)         Mar 2014 - May 2019
  180    4.  Vlad Patrascu (@rvlad-patrascu)     May 2017 - Apr 2019
  181    5.  Peter Lemenkov (@lemenkov)          Aug 2012 - Jun 2018
  182    6.  Julián Moreno Patiño                Feb 2016 - Feb 2016
  183    7.  fabriziopicconi                     Jun 2013 - Jun 2013
  184    8.  Ovidiu Sas (@ovidiusas)             Jun 2012 - Jun 2012
  185    9.  Razvan Pistolea                     Jul 2009 - Jul 2009
  186    10. Sergio Gutierrez                    Feb 2009 - Feb 2009
  187 
  188    All remaining contributors: Henning Westerholt (@henningw),
  189    Iouri Kharon.
  190 
  191    (1) including any documentation-related commits, excluding
  192    merge commits
  193 
  194 Chapter 3. Documentation
  195 
  196 3.1. Contributors
  197 
  198    Last edited by: Liviu Chircu (@liviuchircu), Peter Lemenkov
  199    (@lemenkov), Bogdan-Andrei Iancu (@bogdan-iancu), Henning
  200    Westerholt (@henningw), Iouri Kharon.
  201 
  202    Documentation Copyrights:
  203 
  204    Copyright © 2007-2008 TRUNK MOBILE, INC.