1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<appendix xml:id="oci8.constants" xmlns="http://docbook.org/ns/docbook">
&reftitle.constants;
&extension.constants;
<table>
<title>OCI8 Function and Method Modes</title>
<tgroup cols="2">
<thead>
<row>
<entry>Constant</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row xml:id="constant.oci-assoc">
<entry><constant>OCI_ASSOC</constant></entry>
<entry>
Used with <function>oci_fetch_all</function> and
<function>oci_fetch_array</function> to get results as an associative
array.
</entry>
</row>
<row xml:id="constant.oci-both">
<entry><constant>OCI_BOTH</constant></entry>
<entry>
Used with <function>oci_fetch_all</function> and
<function>oci_fetch_array</function> to get results as an
array with both associative and number indices.
</entry>
</row>
<row xml:id="constant.oci-commit-on-success">
<entry><constant>OCI_COMMIT_ON_SUCCESS</constant></entry>
<entry>
Statement execution mode for <function>oci_execute</function>
call. Automatically commit changes when the statement has
succeeded.
</entry>
</row>
<row xml:id="constant.oci-cred-ext">
<entry><constant>OCI_CRED_EXT</constant></entry>
<entry>
Used with <function>oci_connect</function> for using
Oracles' External or OS authentication.
</entry>
</row>
<row xml:id="constant.oci-default">
<entry><constant>OCI_DEFAULT</constant></entry>
<entry>
See <constant>OCI_NO_AUTO_COMMIT</constant>.
</entry>
</row>
<row xml:id="constant.oci-describe-only">
<entry><constant>OCI_DESCRIBE_ONLY</constant></entry>
<entry>
Statement execution mode
for <function>oci_execute</function>. Use this mode if you
want meta data such as the column names but don't want to
fetch rows from the query.
</entry>
</row>
<row xml:id="constant.oci-exact-fetch">
<entry><constant>OCI_EXACT_FETCH</constant></entry>
<entry>
Obsolete. Statement fetch mode. Used when the application
knows in advance exactly how many rows it will be fetching.
This mode turns prefetching off for Oracle release 8 or
later mode. The cursor is canceled after the desired rows
are fetched which may result in reduced server-side
resource usage.
</entry>
</row>
<row xml:id="constant.oci-fetchstatement-by-column">
<entry><constant>OCI_FETCHSTATEMENT_BY_COLUMN</constant></entry>
<entry>
Default mode of <function>oci_fetch_all</function>.
</entry>
</row>
<row xml:id="constant.oci-fetchstatement-by-row">
<entry><constant>OCI_FETCHSTATEMENT_BY_ROW</constant></entry>
<entry>
Alternative mode of <function>oci_fetch_all</function>.
</entry>
</row>
<row xml:id="constant.ocilob-buffer-free">
<entry><constant>OCI_LOB_BUFFER_FREE</constant></entry>
<entry>
Used with <xref linkend="ocilob.flush"/> to free
buffers used.
</entry>
</row>
<row xml:id="constant.oci-no-auto-commit">
<entry><constant>OCI_NO_AUTO_COMMIT</constant></entry>
<entry>
Statement execution mode
for <function>oci_execute</function>. The transaction is not
automatically committed when using this mode. For
readability in new code, use this value instead of the
older, equivalent <constant>OCI_DEFAULT</constant> constant.
</entry>
</row>
<row xml:id="constant.oci-num">
<entry><constant>OCI_NUM</constant></entry>
<entry>
Used with <function>oci_fetch_all</function> and
<function>oci_fetch_array</function> to get results as an
enumerated array.
</entry>
</row>
<row xml:id="constant.oci-return-lobs">
<entry><constant>OCI_RETURN_LOBS</constant></entry>
<entry>
Used with <function>oci_fetch_array</function> to get the
data value of the LOB instead of the descriptor.
</entry>
</row>
<row xml:id="constant.oci-return-nulls">
<entry><constant>OCI_RETURN_NULLS</constant></entry>
<entry>
Used with <function>oci_fetch_array</function> to get empty
array elements if the row items value is &null;.
</entry>
</row>
<row xml:id="constant.oci-seek-cur">
<entry><constant>OCI_SEEK_CUR</constant></entry>
<entry>
Used with <xref linkend="ocilob.seek" /> to set the seek position.
</entry>
</row>
<row xml:id="constant.oci-seek-end">
<entry><constant>OCI_SEEK_END</constant></entry>
<entry>
Used with <xref linkend="ocilob.seek" /> to set the seek position.
</entry>
</row>
<row xml:id="constant.oci-seek-set">
<entry><constant>OCI_SEEK_SET</constant></entry>
<entry>
Used with <xref linkend="ocilob.seek" /> to set the seek position.
</entry>
</row>
<row xml:id="constant.oci-sysdate">
<entry><constant>OCI_SYSDATE</constant></entry>
<entry>
Obsolete.
</entry>
</row>
<row xml:id="constant.oci-sysdba">
<entry><constant>OCI_SYSDBA</constant></entry>
<entry>
Used with <function>oci_connect</function> to connect with
the SYSDBA privilege. The &php.ini; setting
<link linkend="ini.oci8.privileged-connect">oci8.privileged_connect</link>
should be enabled to use this.
</entry>
</row>
<row xml:id="constant.oci-sysoper">
<entry><constant>OCI_SYSOPER</constant></entry>
<entry>
Used with <function>oci_connect</function> to connect with
the SYSOPER privilege. The &php.ini; setting
<link linkend="ini.oci8.privileged-connect">oci8.privileged_connect</link>
should be enabled to use this.
</entry>
</row>
<row xml:id="constant.oci-temp-blob">
<entry><constant>OCI_TEMP_BLOB</constant></entry>
<entry>
Used with <xref linkend="ocilob.writetemporary"/>
to indicate that a temporary BLOB should be created.
</entry>
</row>
<row xml:id="constant.oci-temp-clob">
<entry><constant>OCI_TEMP_CLOB</constant></entry>
<entry>
Used with <xref linkend="ocilob.writetemporary"/>
to indicate that a temporary CLOB should be created.
</entry>
</row>
</tbody>
</tgroup>
</table>
<table>
<title>OCI8 Bind and Define Types</title>
<tgroup cols="2">
<thead>
<row>
<entry>Constant</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row xml:id="constant.oci-b-bfile">
<entry><constant>OCI_B_BFILE</constant></entry>
<entry>
Used with <function>oci_bind_by_name</function> when binding
BFILEs.
</entry>
</row>
<row xml:id="constant.oci-b-bin">
<entry><constant>OCI_B_BIN</constant></entry>
<entry>
Used with <function>oci_bind_by_name</function> to bind RAW values.
</entry>
</row>
<row xml:id="constant.oci-b-blob">
<entry><constant>OCI_B_BLOB</constant></entry>
<entry>
Used with <function>oci_bind_by_name</function> when
binding BLOBs.
</entry>
</row>
<row xml:id="constant.oci-b-bol">
<entry><constant>OCI_B_BOL</constant></entry>
<entry>
Used with <function>oci_bind_by_name</function> to bind a PL/SQL BOOLEAN
variable.
</entry>
</row>
<row xml:id="constant.oci-b-cfilee">
<entry><constant>OCI_B_CFILEE</constant></entry>
<entry>
Used with <function>oci_bind_by_name</function> when binding
CFILEs.
</entry>
</row>
<row xml:id="constant.oci-b-clob">
<entry><constant>OCI_B_CLOB</constant></entry>
<entry>
Used with <function>oci_bind_by_name</function> when binding
CLOBs.
</entry>
</row>
<row xml:id="constant.oci-b-cursor">
<entry><constant>OCI_B_CURSOR</constant></entry>
<entry>
Used with <function>oci_bind_by_name</function> when binding
cursors, previously allocated
with <function>oci_new_descriptor</function>.
</entry>
</row>
<row xml:id="constant.oci-b-int">
<entry><constant>OCI_B_INT</constant></entry>
<entry>
Used with <function>oci_bind_array_by_name</function> to bind arrays of
INTEGER.
</entry>
</row>
<row xml:id="constant.oci-b-nty">
<entry><constant>OCI_B_NTY</constant></entry>
<entry>
Used with <function>oci_bind_by_name</function> when binding
named data types.
</entry>
</row>
<row xml:id="constant.oci-b-num">
<entry><constant>OCI_B_NUM</constant></entry>
<entry>
Used with <function>oci_bind_array_by_name</function> to bind arrays of
NUMBER.
</entry>
</row>
<row xml:id="constant.oci-b-rowid">
<entry><constant>OCI_B_ROWID</constant></entry>
<entry>
Used with <function>oci_bind_by_name</function> when binding
ROWIDs.
</entry>
</row>
<row xml:id="constant.sqlt-afc">
<entry><constant>SQLT_AFC</constant></entry>
<entry>
Used with <function>oci_bind_array_by_name</function> to bind arrays of
CHAR.
</entry>
</row>
<row xml:id="constant.sqlt-avc">
<entry><constant>SQLT_AVC</constant></entry>
<entry>
Used with <function>oci_bind_array_by_name</function> to bind arrays of
VARCHAR2.
</entry>
</row>
<row xml:id="constant.sqlt-bdouble">
<entry><constant>SQLT_BDOUBLE</constant></entry>
<entry>
Not supported.
</entry>
</row>
<row xml:id="constant.sqlt-bfilee">
<entry><constant>SQLT_BFILEE</constant></entry>
<entry>
The same as <constant>OCI_B_BFILE</constant>.
</entry>
</row>
<row xml:id="constant.sqlt-bfloat">
<entry><constant>SQLT_BFLOAT</constant></entry>
<entry>
Not supported.
</entry>
</row>
<row xml:id="constant.sqlt-bin">
<entry><constant>SQLT_BIN</constant></entry>
<entry>
The same as <constant>OCI_B_BIN</constant>.
</entry>
</row>
<row xml:id="constant.sqlt-blob">
<entry><constant>SQLT_BLOB</constant></entry>
<entry>
The same as <constant>OCI_B_BLOB</constant>.
</entry>
</row>
<row xml:id="constant.sqlt-bol">
<entry><constant>SQLT_BOL</constant></entry>
<entry>
The same as <constant>OCI_B_BOL</constant>.
</entry>
</row>
<row xml:id="constant.sqlt-cfilee">
<entry><constant>SQLT_CFILEE</constant></entry>
<entry>
The same as <constant>OCI_B_CFILEE</constant>.
</entry>
</row>
<row xml:id="constant.sqlt-chr">
<entry><constant>SQLT_CHR</constant></entry>
<entry>
Used with <function>oci_bind_array_by_name</function> to bind arrays of
VARCHAR2.
Also used with <function>oci_bind_by_name</function>.
</entry>
</row>
<row xml:id="constant.sqlt-clob">
<entry><constant>SQLT_CLOB</constant></entry>
<entry>
The same as <constant>OCI_B_CLOB</constant>.
</entry>
</row>
<row xml:id="constant.sqlt-flt">
<entry><constant>SQLT_FLT</constant></entry>
<entry>
Used with <function>oci_bind_array_by_name</function> to bind arrays of
FLOAT.
</entry>
</row>
<row xml:id="constant.sqlt-int">
<entry><constant>SQLT_INT</constant></entry>
<entry>
The same as <constant>OCI_B_INT</constant>.
</entry>
</row>
<row xml:id="constant.sqlt-lbi">
<entry><constant>SQLT_LBI</constant></entry>
<entry>
Used with <function>oci_bind_by_name</function> to bind LONG RAW values.
</entry>
</row>
<row xml:id="constant.sqlt-lng">
<entry><constant>SQLT_LNG</constant></entry>
<entry>
Used with <function>oci_bind_by_name</function> to bind LONG values.
</entry>
</row>
<row xml:id="constant.sqlt-lvc">
<entry><constant>SQLT_LVC</constant></entry>
<entry>
Used with <function>oci_bind_array_by_name</function> to bind arrays of
LONG VARCHAR.
</entry>
</row>
<row xml:id="constant.sqlt-nty">
<entry><constant>SQLT_NTY</constant></entry>
<entry>
The same as <constant>OCI_B_NTY</constant>.
</entry>
</row>
<row xml:id="constant.sqlt-num">
<entry><constant>SQLT_NUM</constant></entry>
<entry>
The same as <constant>OCI_B_NUM</constant>.
</entry>
</row>
<row xml:id="constant.sqlt-odt">
<entry><constant>SQLT_ODT</constant></entry>
<entry>
Used with <function>oci_bind_array_by_name</function> to bind arrays of
LONG.
</entry>
</row>
<row xml:id="constant.sqlt-rdd">
<entry><constant>SQLT_RDD</constant></entry>
<entry>
The same as <constant>OCI_B_ROWID</constant>.
</entry>
</row>
<row xml:id="constant.sqlt-rset">
<entry><constant>SQLT_RSET</constant></entry>
<entry>
The same as <constant>OCI_B_CURSOR</constant>.
</entry>
</row>
<row xml:id="constant.sqlt-str">
<entry><constant>SQLT_STR</constant></entry>
<entry>
Used with <function>oci_bind_array_by_name</function> to bind arrays of
STRING.
</entry>
</row>
<row xml:id="constant.sqlt-uin">
<entry><constant>SQLT_UIN</constant></entry>
<entry>
Not supported.
</entry>
</row>
<row xml:id="constant.sqlt-vcs">
<entry><constant>SQLT_VCS</constant></entry>
<entry>
Used with <function>oci_bind_array_by_name</function> to bind arrays of
VARCHAR.
</entry>
</row>
</tbody>
</tgroup>
</table>
<table>
<title>OCI8 Descriptor Types</title>
<tgroup cols="2">
<thead>
<row>
<entry>Constant</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row xml:id="constant.oci-dtype-file">
<entry><constant>OCI_DTYPE_FILE</constant></entry>
<entry>
This flag tells <function>oci_new_descriptor</function> to
initialize a new FILE descriptor.
</entry>
</row>
<row xml:id="constant.oci-dtype-lob">
<entry><constant>OCI_DTYPE_LOB</constant></entry>
<entry>
This flag tells <function>oci_new_descriptor</function> to
initialize a new LOB descriptor.
</entry>
</row>
<row xml:id="constant.oci-dtype-rowid">
<entry><constant>OCI_DTYPE_ROWID</constant></entry>
<entry>
This flag tells <function>oci_new_descriptor</function> to
initialize a new ROWID descriptor.
</entry>
</row>
<row xml:id="constant.oci-d-file">
<entry><constant>OCI_D_FILE</constant></entry>
<entry>
The same as <constant>OCI_DTYPE_FILE</constant>.
</entry>
</row>
<row xml:id="constant.oci-d-lob">
<entry><constant>OCI_D_LOB</constant></entry>
<entry>
The same as <constant>OCI_DTYPE_LOB</constant>.
</entry>
</row>
<row xml:id="constant.oci-d-rowid">
<entry><constant>OCI_D_ROWID</constant></entry>
<entry>
The same as <constant>OCI_DTYPE_ROWID</constant>.
</entry>
</row>
</tbody>
</tgroup>
</table>
<variablelist role="constant_list">
<title>OCI8 Transparent Application Failover (TAF) Constants</title>
<varlistentry xml:id="constant.oci-fo-abort">
<term>
<constant>OCI_FO_ABORT</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Failover was unsuccessful and there is no option of retrying.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.oci-fo-begin">
<term>
<constant>OCI_FO_BEGIN</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Failover has detected a lost connection and failover is starting.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.oci-fo-end">
<term>
<constant>OCI_FO_END</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Failover completed successfully.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.oci-fo-error">
<term>
<constant>OCI_FO_ERROR</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Failover was unsuccessful but it gives the application the opportunity
to handle the error and return <constant>OCI_FO_RETRY</constant> to retry failover.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.oci-fo-none">
<term>
<constant>OCI_FO_NONE</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
The user has not requested a failover type.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.oci-fo-reauth">
<term>
<constant>OCI_FO_REAUTH</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
An Oracle user has been re-authenticated.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.oci-fo-retry">
<term>
<constant>OCI_FO_RETRY</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
The failover should be attempted again by Oracle.
In case of an error while failing over to a new
connection, TAF is able to retry the failover.
Typically, the application code should sleep for
a while before returning <constant>OCI_FO_RETRY</constant>.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.oci-fo-select">
<term>
<constant>OCI_FO_SELECT</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
The user has requested SELECT failover as well.
It allows users with open cursors to continue fetching from them after failure.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.oci-fo-session">
<term>
<constant>OCI_FO_SESSION</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
The user has requested only session failover.
For example, if a user's connection is lost,
then a new session is automatically created for the user on the backup.
This type of failover does not attempt to recover SELECTs.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.oci-fo-txnal">
<term>
<constant>OCI_FO_TXNAL</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
The user has requested a transaction failover.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</appendix>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
|
