@@ -1,4 +1,4 @@

-Oracle Module

+oracle Module

 Iouri Kharon

@@ -12,17 +12,20 @@ Iakov Kharon

    <jyh@trunkmobile.com>

-

 Edited by

 Iouri Kharon

    <yjh@styx.cabel.net>

-   Copyright � 2007,2008 TRUNK MOBILE, INC

+   Copyright � 2007,2008 TRUNK MOBILE, INC.

+   Revision History

+   Revision $Revision: 3936 $ $Date: 2008-03-07 13:57:32 +0300

+                              (Fri, 07 Mar 2008) $

      __________________________________________________________

    Table of Contents

+

    1. User's Guide

         1.1. Overview

@@ -38,158 +41,97 @@ Iouri Kharon

         1.4. Exported Functions

         1.5. Installation

-	1.6. Utility openser_orasel

-

-   2. Developer's Guide

-   3. Frequently Asked Questions

+        1.6. Utility openser_orasel

    List of Examples

-   1-1. Set timeout parameter

-   1-2. Set reconnect parameter

-   1-3. Disable asynchronous mode

-   1-4. Specify database url with use Oracle TNS service (alias)

-     __________________________________________________________

+

+   1.1. Set timeout parameter

+   1.2. Disable asynchronous mode

+   1.3. Set reconnect parameter

 Chapter 1. User's Guide

 1.1. Overview

-   This is a module which provides Oracle connectivity for OpenSER.

-   It's implements the DB API defined in OpenSER.

-     __________________________________________________________

+   This is a module which provides Oracle connectivity for

+   OpenSER. It implements the DB API defined in OpenSER.

 1.2. Dependencies

 1.2.1. OpenSER Modules

    The following modules must be loaded before this module:

-

      * No dependencies on other OpenSER modules.

-     __________________________________________________________

 1.2.2. External Libraries or Applications

    The following libraries or applications must be installed

    before running OpenSER with this module loaded:

+     * instantclient-sdk-10.2.0.3 - the development headers and

+       libraries of OCI.

-     * Oracle Instance Client OR Oracle Instance Client Light.

-     __________________________________________________________

+1.3. Exported Parameters

 1.3.1. timeout (fixedpoint)

-   Specify timeout value for any operation with BD.

+   Timeout value for any operation with BD.

-   Possible values is from 0.1 to 10.0 seconds

+   Possible values is from 0.1 to 10.0 seconds.

    Default value is 3.0 (3 second).

-   If timeout parameter value seted to 0, module use synchronous mode

-   (without timeout's).

+   If value of timeout parameter set to 0, module use synchronous

+   mode (without timeout).

-   Example 1-1. Set timeount parameter

+   Example 1.1. Set timeout parameter

 ...

 modparam("db_oracle", "timeout", 1.5)

 ...

-   Example 1-2. Disable asynchronous mode

+   Example 1.2. Disable asynchronous mode

 ...

 modparam("db_oracle", "timeout", 0)

 ...

-     __________________________________________________________

 1.3.2. reconnect (fixedpoint)

-   Specify timeout value for connect (create session) operation.

+   Timeout value for connect (create session) operation.

-   Possible values is from 0.1 to 10.0 seconds

+   Possible values is from 0.1 to 10.0 seconds.

    Default value is 0.2 (200 milliseconds).

-   Example 1-3. Set reconnect parameter

+   Example 1.3. Set reconnect parameter

 ...

 modparam("db_oracle", "reconnect", 0.5)

 ...

-     __________________________________________________________

-

 1.4. Exported Functions

    No function exported to be used from configuration file.

-     __________________________________________________________

 1.5. Installation

-   Because it depends on an external library, the oracle module is

-   not compiled and installed by default. You can use one of the

-   next options.

-

+   Because it dependes on an external library, the oracle module

+   is not compiled and installed by default. You can use one of

+   the next options.

      * - edit the "Makefile" and remove "db_oracle" from

        "excluded_modules" list. Then follow the standard procedure

        to install OpenSER: "make all; make install".

-     * - from command line use: 'make all include_modules="db_oracle";

-       make install include_modules="db_oracle"'.

-

-     __________________________________________________________

+     * - from command line use: 'make all

+       include_modules="db_oracle"; make install

+       include_modules="db_oracle"'.

 1.6. Utility openser_orasel

-    For working with openserctl script, should be able to print the 'query' 

-    results to the terminal in a user-readable form. The standard command-line 

-    Oracle client (sqlplus) is not quite suitable for this, as it cannot align 

-    row width to real (received) data's (it always prints a cell width as 

-    described in the db scheme). This problem has been solved by inclusion the 

-    utility openser_orasel, which formats printing approximately in the same 

-    way as the 'mysql' client utility. In addition, this utility known about 

-    the "agreements and types" in DB that are used in OpenSER for the work 

-    with Oracle and formats printing taking these into account.

-     __________________________________________________________

-

-Chapter 2. Developer's Guide

-

-   The module does not provide any API to use in other OpenSER

-   modules.

-     __________________________________________________________

-

-Chapter 3. Frequently Asked Questions

-

-   3.1. Where can I find more about OpenSER?

-   3.2. Where can I post a question about this module?

-   3.3. How can I report a bug?

-   3.4. Can I specify database url with use Oracle TNS (alias)?

-

-   3.1. Where can I find more about OpenSER?

-

-   Take a look at http://openser.org/.

-

-   3.2. Where can I post a question about this module?

-

-   First at all check if your question was already answered on one

-   of our mailing lists:

-

-     * User Mailing List -

-       http://openser.org/cgi-bin/mailman/listinfo/users

-     * Developer Mailing List -

-       http://openser.org/cgi-bin/mailman/listinfo/devel

-

-   E-mails regarding any stable OpenSER release should be sent to

-   <users@openser.org> and e-mails regarding development versions

-   should be sent to <devel@openser.org>.

-

-   If you want to keep the mail private, send it to

-   <team@openser.org>.

-

-   3.3. How can I report a bug?

-

-   Please follow the guidelines provided at:

-   http://sourceforge.net/tracker/?group_id=139143.

-

-   3.4. Can I specify database url using Oracle TNS (alias)?

-

-   Yes, you can. For specifiing database url with use Oracle TNS serfice use

-   following syntax:

-

-   Example 1-4. Specify database url with Oracle TNS service (alias)

-...

-modparam("your_module", "db_url", "oracle://openser:openserrw@/openser")

-...

-

+   For working with openserctl script, should be able to print the

+   'query' results to the terminal in a user-readable form. The

+   standard command-line Oracle client (sqlplus) is not quite

+   suitable for this, as it cannot align row width to real

+   (received) data's (it always prints a cell width as described

+   in the db scheme). This problem has been solved by inclusion

+   the utility openser_orasel, which formats printing

+   approximately in the same way as the 'mysql' client utility. In

+   addition, this utility known about the "agreements and types"

+   in DB that are used in OpenSER for the work with Oracle and

+   formats printing taking these into account.

@@ -15,7 +15,7 @@

 <book>

     <bookinfo>

 	<title>oracle Module</title>

-	<productname class="trade">&sername;</productname>

+	<productname class="trade">&opensername;</productname>

 	<authorgroup>

 	    <author>

 		<firstname>Iouri</firstname>

@@ -15,13 +15,13 @@

 	<section>

 	<title>Dependencies</title>

 	<section>

-		<title>&ser; Modules</title>

+		<title>&openser; Modules</title>

 		<para>

 		The following modules must be loaded before this module:

 			<itemizedlist>

 			<listitem>

 			<para>

-				<emphasis>No dependencies on other &ser; modules</emphasis>.

+				<emphasis>No dependencies on other &openser; modules</emphasis>.

 			</para>

 			</listitem>

 			</itemizedlist>

@@ -31,7 +31,7 @@

 		<title>External Libraries or Applications</title>

 		<para>

 		The following libraries or applications must be installed before running

-		&ser; with this module loaded:

+		&openser; with this module loaded:

 			<itemizedlist>

 			<listitem>

 			<para>

@@ -117,7 +117,7 @@ modparam("db_oracle", "reconnect", 0.5)

 			<listitem>

 			<para>

 			- edit the "Makefile" and remove "db_oracle" from "excluded_modules"

-			list. Then follow the standard procedure to install &ser;:

+			list. Then follow the standard procedure to install &openser;:

 			"make all; make install".

 			</para>

 			</listitem>