Browse code

- fix entities for db_oracle documentation

git-svn-id: https://openser.svn.sourceforge.net/svnroot/openser/trunk@4079 689a6050-402a-0410-94f2-e92a70836424

Henning Westerholt authored on 24/04/2008 10:29:31
Showing 3 changed files
... ...
@@ -1,4 +1,4 @@
1
-Oracle Module
1
+oracle Module
2 2
 
3 3
 Iouri Kharon
4 4
 
... ...
@@ -12,17 +12,20 @@ Iakov Kharon
12 12
 
13 13
    <jyh@trunkmobile.com>
14 14
 
15
-
16 15
 Edited by
17 16
 
18 17
 Iouri Kharon
19 18
 
20 19
    <yjh@styx.cabel.net>
21 20
 
22
-   Copyright � 2007,2008 TRUNK MOBILE, INC
21
+   Copyright � 2007,2008 TRUNK MOBILE, INC.
22
+   Revision History
23
+   Revision $Revision: 3936 $ $Date: 2008-03-07 13:57:32 +0300
24
+                              (Fri, 07 Mar 2008) $
23 25
      __________________________________________________________
24 26
 
25 27
    Table of Contents
28
+
26 29
    1. User's Guide
27 30
 
28 31
         1.1. Overview
... ...
@@ -38,158 +41,97 @@ Iouri Kharon
38 38
 
39 39
         1.4. Exported Functions
40 40
         1.5. Installation
41
-	1.6. Utility openser_orasel
42
-
43
-   2. Developer's Guide
44
-   3. Frequently Asked Questions
41
+        1.6. Utility openser_orasel
45 42
 
46 43
    List of Examples
47
-   1-1. Set timeout parameter
48
-   1-2. Set reconnect parameter
49
-   1-3. Disable asynchronous mode
50
-   1-4. Specify database url with use Oracle TNS service (alias)
51
-     __________________________________________________________
44
+
45
+   1.1. Set timeout parameter
46
+   1.2. Disable asynchronous mode
47
+   1.3. Set reconnect parameter
52 48
 
53 49
 Chapter 1. User's Guide
54 50
 
55 51
 1.1. Overview
56 52
 
57
-   This is a module which provides Oracle connectivity for OpenSER.
58
-   It's implements the DB API defined in OpenSER.
59
-     __________________________________________________________
53
+   This is a module which provides Oracle connectivity for
54
+   OpenSER. It implements the DB API defined in OpenSER.
60 55
 
61 56
 1.2. Dependencies
62 57
 
63 58
 1.2.1. OpenSER Modules
64 59
 
65 60
    The following modules must be loaded before this module:
66
-
67 61
      * No dependencies on other OpenSER modules.
68
-     __________________________________________________________
69 62
 
70 63
 1.2.2. External Libraries or Applications
71 64
 
72 65
    The following libraries or applications must be installed
73 66
    before running OpenSER with this module loaded:
67
+     * instantclient-sdk-10.2.0.3 - the development headers and
68
+       libraries of OCI.
74 69
 
75
-     * Oracle Instance Client OR Oracle Instance Client Light.
76
-     __________________________________________________________
70
+1.3. Exported Parameters
77 71
 
78 72
 1.3.1. timeout (fixedpoint)
79 73
 
80
-   Specify timeout value for any operation with BD.
74
+   Timeout value for any operation with BD.
81 75
 
82
-   Possible values is from 0.1 to 10.0 seconds
76
+   Possible values is from 0.1 to 10.0 seconds.
83 77
 
84 78
    Default value is 3.0 (3 second).
85 79
 
86
-   If timeout parameter value seted to 0, module use synchronous mode
87
-   (without timeout's).
80
+   If value of timeout parameter set to 0, module use synchronous
81
+   mode (without timeout).
88 82
 
89
-   Example 1-1. Set timeount parameter
83
+   Example 1.1. Set timeout parameter
90 84
 ...
91 85
 modparam("db_oracle", "timeout", 1.5)
92 86
 ...
93 87
 
94
-   Example 1-2. Disable asynchronous mode
88
+   Example 1.2. Disable asynchronous mode
95 89
 ...
96 90
 modparam("db_oracle", "timeout", 0)
97 91
 ...
98
-     __________________________________________________________
99 92
 
100 93
 1.3.2. reconnect (fixedpoint)
101 94
 
102
-   Specify timeout value for connect (create session) operation.
95
+   Timeout value for connect (create session) operation.
103 96
 
104
-   Possible values is from 0.1 to 10.0 seconds
97
+   Possible values is from 0.1 to 10.0 seconds.
105 98
 
106 99
    Default value is 0.2 (200 milliseconds).
107 100
 
108
-   Example 1-3. Set reconnect parameter
101
+   Example 1.3. Set reconnect parameter
109 102
 ...
110 103
 modparam("db_oracle", "reconnect", 0.5)
111 104
 ...
112 105
 
113
-     __________________________________________________________
114
-
115 106
 1.4. Exported Functions
116 107
 
117 108
    No function exported to be used from configuration file.
118
-     __________________________________________________________
119 109
 
120 110
 1.5. Installation
121 111
 
122
-   Because it depends on an external library, the oracle module is
123
-   not compiled and installed by default. You can use one of the
124
-   next options.
125
-
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.
126 115
      * - edit the "Makefile" and remove "db_oracle" from
127 116
        "excluded_modules" list. Then follow the standard procedure
128 117
        to install OpenSER: "make all; make install".
129
-     * - from command line use: 'make all include_modules="db_oracle";
130
-       make install include_modules="db_oracle"'.
131
-
132
-     __________________________________________________________
118
+     * - from command line use: 'make all
119
+       include_modules="db_oracle"; make install
120
+       include_modules="db_oracle"'.
133 121
 
134 122
 1.6. Utility openser_orasel
135 123
 
136
-    For working with openserctl script, should be able to print the 'query' 
137
-    results to the terminal in a user-readable form. The standard command-line 
138
-    Oracle client (sqlplus) is not quite suitable for this, as it cannot align 
139
-    row width to real (received) data's (it always prints a cell width as 
140
-    described in the db scheme). This problem has been solved by inclusion the 
141
-    utility openser_orasel, which formats printing approximately in the same 
142
-    way as the 'mysql' client utility. In addition, this utility known about 
143
-    the "agreements and types" in DB that are used in OpenSER for the work 
144
-    with Oracle and formats printing taking these into account.
145
-     __________________________________________________________
146
-
147
-Chapter 2. Developer's Guide
148
-
149
-   The module does not provide any API to use in other OpenSER
150
-   modules.
151
-     __________________________________________________________
152
-
153
-Chapter 3. Frequently Asked Questions
154
-
155
-   3.1. Where can I find more about OpenSER?
156
-   3.2. Where can I post a question about this module?
157
-   3.3. How can I report a bug?
158
-   3.4. Can I specify database url with use Oracle TNS (alias)?
159
-
160
-   3.1. Where can I find more about OpenSER?
161
-
162
-   Take a look at http://openser.org/.
163
-
164
-   3.2. Where can I post a question about this module?
165
-
166
-   First at all check if your question was already answered on one
167
-   of our mailing lists:
168
-
169
-     * User Mailing List -
170
-       http://openser.org/cgi-bin/mailman/listinfo/users
171
-     * Developer Mailing List -
172
-       http://openser.org/cgi-bin/mailman/listinfo/devel
173
-
174
-   E-mails regarding any stable OpenSER release should be sent to
175
-   <users@openser.org> and e-mails regarding development versions
176
-   should be sent to <devel@openser.org>.
177
-
178
-   If you want to keep the mail private, send it to
179
-   <team@openser.org>.
180
-
181
-   3.3. How can I report a bug?
182
-
183
-   Please follow the guidelines provided at:
184
-   http://sourceforge.net/tracker/?group_id=139143.
185
-
186
-   3.4. Can I specify database url using Oracle TNS (alias)?
187
-
188
-   Yes, you can. For specifiing database url with use Oracle TNS serfice use
189
-   following syntax:
190
-
191
-   Example 1-4. Specify database url with Oracle TNS service (alias)
192
-...
193
-modparam("your_module", "db_url", "oracle://openser:openserrw@/openser")
194
-...
195
-
124
+   For working with openserctl script, 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 openser_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 OpenSER for the work with Oracle and
134
+   formats printing taking these into account.
... ...
@@ -15,7 +15,7 @@
15 15
 <book>
16 16
     <bookinfo>
17 17
 	<title>oracle Module</title>
18
-	<productname class="trade">&sername;</productname>
18
+	<productname class="trade">&opensername;</productname>
19 19
 	<authorgroup>
20 20
 	    <author>
21 21
 		<firstname>Iouri</firstname>
... ...
@@ -15,13 +15,13 @@
15 15
 	<section>
16 16
 	<title>Dependencies</title>
17 17
 	<section>
18
-		<title>&ser; Modules</title>
18
+		<title>&openser; Modules</title>
19 19
 		<para>
20 20
 		The following modules must be loaded before this module:
21 21
 			<itemizedlist>
22 22
 			<listitem>
23 23
 			<para>
24
-				<emphasis>No dependencies on other &ser; modules</emphasis>.
24
+				<emphasis>No dependencies on other &openser; modules</emphasis>.
25 25
 			</para>
26 26
 			</listitem>
27 27
 			</itemizedlist>
... ...
@@ -31,7 +31,7 @@
31 31
 		<title>External Libraries or Applications</title>
32 32
 		<para>
33 33
 		The following libraries or applications must be installed before running
34
-		&ser; with this module loaded:
34
+		&openser; with this module loaded:
35 35
 			<itemizedlist>
36 36
 			<listitem>
37 37
 			<para>
... ...
@@ -117,7 +117,7 @@ modparam("db_oracle", "reconnect", 0.5)
117 117
 			<listitem>
118 118
 			<para>
119 119
 			- edit the "Makefile" and remove "db_oracle" from "excluded_modules"
120
-			list. Then follow the standard procedure to install &ser;:
120
+			list. Then follow the standard procedure to install &openser;:
121 121
 			"make all; make install".
122 122
 			</para>
123 123
 			</listitem>