[go: up one dir, main page]
Menu ▾ ▴

[r8]: / current / doc / Occi.html  Maximize  Restore  History

Download this file

923 lines (838 with data), 53.4 kB 

  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
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">

<html>

<head>

<link rel="stylesheet" href="style.css" type="text/css">

<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">

<link rel="Start" href="index.html">

<link rel="Up" href="index.html">

<link title="Index of types" rel=Appendix href="index_types.html">

<link title="Index of exceptions" rel=Appendix href="index_exceptions.html">

<link title="Index of values" rel=Appendix href="index_values.html">

<link title="Index of class attributes" rel=Appendix href="index_attributes.html">

<link title="Index of class methods" rel=Appendix href="index_methods.html">

<link title="Index of classes" rel=Appendix href="index_classes.html">

<link title="Index of modules" rel=Appendix href="index_modules.html">

<link title="Occi" rel="Chapter" href="Occi.html"><link title="Types and Exceptions" rel="Section" href="#3_TypesandExceptions">

<link title="Functional API" rel="Section" href="#3_FunctionalAPI">

<link title="Object-Oriented API" rel="Section" href="#3_ObjectOrientedAPI">

<title>Occi</title>

</head>

<body>

<div class="navbar">&nbsp;<a href="index.html">Up</a>

&nbsp;</div>

<center><h1>Module <a href="type_Occi.html">Occi</a></h1></center>

<br>

<pre><span class="keyword">module</span> Occi: <code class="code"><span class="keyword">sig</span></code> <a href="Occi.html">..</a> <code class="code"><span class="keyword">end</span></code></pre>This OCAML library implements an Oracle client interface using OCCI C++ 

  Oracle library built on top of OCI.

<p>



  The library was only tested on Linux, but should work on Windows as well.

  Bug reports should be submitted to the 

  <a href="mailto:Serge Aleynikov <serge@corp.idt.net>">author</a>.

<p>



  <b>Library features</b>

<p>



  The following operations with an Oracle database are supported:

<p>

<ul>

<li>Simple DML operations including SELECT / INSERT / UPDATE / DELETE</li>

<li>Parameterized DML operations including SELECT / INSERT / UPDATE / DELETE</li>

<li>Execution of PL/SQL stored procedures</li>

<li>Execution of bulk DML array INSERT / DELETE / UPDATE operations</li>

<li>Oracle exception handling</li>

<li>Oracle bulk exception handling with specifying failed rows and errors for each row</li>

<li>Transaction control (commit and rollback)</li>

<li>Automatic garbage control of Oracle resources (connections, statements

    and cursors)</li>

<li>Functional and Object-Oriented API included</li>

</ul>



  This library requires Oracle 10g (at least 10g Release 2) instant client library 

  to be installed on a client machine.  OCCI requires only four shared 

  libraries (or dynamic link libraries, as they are called on some operating 

  systems) to be loaded by the dynamic loader of the operating system. 

  Oracle Database 10g Release 2 (10.2) library names are used; the number 

  part of library names will change to remain consistent with future release 

  numbers.

<p>



  <b>Installing Instant Client</b>

<p>



  OCCI requires only four shared libraries (or dynamic link libraries, as 

  they are called on some operating systems) to be loaded by the dynamic loader 

  of the operating system. Oracle Database 10g Release 2 (10.2) library names 

  are used; the number part of library names will change to remain consistent 

  with future release numbers.

<p>

<ul>

<li>OCI Instant Client Data Shared Library (<code class="code">libociei.so</code> on Linux and UNIX 

      and <code class="code">oraociei10.dll</code> on Windows); correct installation of this file 

      determines if you are operating in Instant Client mode</li>

</ul>

<ul>

<li>Client Code Library (<code class="code">libclntsh.so.10.1</code> on Linux and UNIX and 

      <code class="code">oci.dll</code> on Windows)</li>

</ul>

<ul>

<li>Security Library (<code class="code">libnnz10.so</code> on Linux and UNIX and 

      <code class="code">orannzsbb10.dll</code> on Windows)</li>

</ul>

<ul>

<li>OCCI Library (<code class="code">libocci.so.10.1</code> on Linux and UNIX and <code class="code">oraocci10.dll</code> on Windows)</li>

</ul>



  These shared libraries can be obtained from 

  <a href="http://www.oracle.com/technology/tech/oci/instantclient/">Oracle Technology Network</a>.

<p>



  Note: if you are getting a segmentation fault when running

  the test program or the following compilation warning:

  <code class="code">/usr/bin/ld: warning: libstdc++.so.5, needed by ...../libocci.so, may conflict <span class="keyword">with</span> libstdc++.so.6</code>

  this means that you have a <code class="code">gcc</code> version 3.4.3 or later, and the Oracle Instant 

  Client was built with <code class="code">gcc</code> 3.2.3.  Obtain a patch from:

  <a href="http://www.oracle.com/technology/tech/oci/occi/occidownloads.html">OCCI patch</a>.

<p>



  If these four libraries are accessible through the directory on the OS 

  Library Path variable (LD_LIBRARY_PATH on Linux and UNIX and PATH on 

  Windows), then OCCI operates in the Instant Client mode. In this mode, 

  there is no dependency on ORACLE_HOME and none of the other code and data 

  files provided in ORACLE_HOME are needed by OCCI.

<p>



  Also note that when using instant client the TNS_ADMIN variable should point 

  to a directory containing Oracle resolver data (sqlnet.ora and tnsnames.ora).  See

  Oracle documentation on configuring instant client.

<p>



  <b>Example Usage</b>

<p>



  See <code class="code">occi_test.ml</code> for sample test cases.  Below find a simple example 

  illustrating a select statement with bind variables.  A more interesting 

  example can be found <a href="#VALocci_execute_array">here</a>.

<p>



  <pre></pre><code class="code">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">open</span>&nbsp;<span class="constructor">Occi</span>;<br>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<br>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;value&nbsp;con&nbsp;&nbsp;=&nbsp;occi_connect&nbsp;<span class="string">"scott"</span>&nbsp;<span class="string">"tiger"</span>&nbsp;<span class="string">"mydb"</span>;<br>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;value&nbsp;stmt&nbsp;=&nbsp;occi_create_statement&nbsp;con&nbsp;<span class="string">""</span>;<br>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">let</span>&nbsp;(_,&nbsp;records)&nbsp;=&nbsp;<br>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ora_select&nbsp;stmt&nbsp;<span class="string">"select&nbsp;*&nbsp;from&nbsp;test&nbsp;where&nbsp;name&nbsp;like&nbsp;:1"</span>&nbsp;[|&nbsp;<span class="constructor">Var_str</span>&nbsp;<span class="string">"Al%"</span>&nbsp;|]<br>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">in</span>&nbsp;<br>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="constructor">List</span>.iter&nbsp;print_record&nbsp;records;<br>

&nbsp;&nbsp;</code><pre></pre><br>

<b>Author(s):</b> Serge Aleynikov (serge\@corp.idt.net)<br>

<b>Version:</b> $Rev: 448 $ $Date: 2006-10-30 19:09:00 -0500 (Mon, 30 Oct 2006) $<br>

<b>See also</b> <a href="http://download-east.oracle.com/docs/cd/B19306_01/appdev.102/b14294/toc.htm">OCCI docs</a><br>

<hr width="100%">

<br>

<a name="3_TypesandExceptions"></a>

<h3>Types and Exceptions</h3><br>

<pre><span class="keyword">type</span> <a name="TYPEora_env"></a><code class="type"></code>ora_env </pre>



<pre><span class="keyword">type</span> <a name="TYPEora_connection"></a><code class="type"></code>ora_connection </pre>



<pre><span class="keyword">type</span> <a name="TYPEora_statement"></a><code class="type"></code>ora_statement </pre>



<pre><span class="keyword">type</span> <a name="TYPEcursor"></a><code class="type"></code>cursor </pre>



<br><code><span class="keyword">type</span> <a name="TYPEora_value"></a><code class="type"></code>ora_value = </code><table class="typetable">

<tr>

<td align="left" valign="top" >

<code><span class="keyword">|</span></code></td>

<td align="left" valign="top" >

<code><span class="constructor">Null</span></code></td>



</tr>

<tr>

<td align="left" valign="top" >

<code><span class="keyword">|</span></code></td>

<td align="left" valign="top" >

<code><span class="constructor">Int</span> <span class="keyword">of</span> <code class="type">int</code></code></td>



</tr>

<tr>

<td align="left" valign="top" >

<code><span class="keyword">|</span></code></td>

<td align="left" valign="top" >

<code><span class="constructor">Date</span> <span class="keyword">of</span> <code class="type">float</code></code></td>



</tr>

<tr>

<td align="left" valign="top" >

<code><span class="keyword">|</span></code></td>

<td align="left" valign="top" >

<code><span class="constructor">Float</span> <span class="keyword">of</span> <code class="type">float</code></code></td>



</tr>

<tr>

<td align="left" valign="top" >

<code><span class="keyword">|</span></code></td>

<td align="left" valign="top" >

<code><span class="constructor">Str</span> <span class="keyword">of</span> <code class="type">string</code></code></td>



</tr></table>



<div class="info">

This type is for use as a result of a query<br>

</div>



<br><code><span class="keyword">type</span> <a name="TYPEparam_val"></a><code class="type"></code>param_val = </code><table class="typetable">

<tr>

<td align="left" valign="top" >

<code><span class="keyword">|</span></code></td>

<td align="left" valign="top" >

<code><span class="constructor">Null_int</span></code></td>



</tr>

<tr>

<td align="left" valign="top" >

<code><span class="keyword">|</span></code></td>

<td align="left" valign="top" >

<code><span class="constructor">Null_date</span></code></td>



</tr>

<tr>

<td align="left" valign="top" >

<code><span class="keyword">|</span></code></td>

<td align="left" valign="top" >

<code><span class="constructor">Null_float</span></code></td>



</tr>

<tr>

<td align="left" valign="top" >

<code><span class="keyword">|</span></code></td>

<td align="left" valign="top" >

<code><span class="constructor">Null_str</span></code></td>



</tr>

<tr>

<td align="left" valign="top" >

<code><span class="keyword">|</span></code></td>

<td align="left" valign="top" >

<code><span class="constructor">Var_int</span> <span class="keyword">of</span> <code class="type">int</code></code></td>



</tr>

<tr>

<td align="left" valign="top" >

<code><span class="keyword">|</span></code></td>

<td align="left" valign="top" >

<code><span class="constructor">Var_date</span> <span class="keyword">of</span> <code class="type">float</code></code></td>



</tr>

<tr>

<td align="left" valign="top" >

<code><span class="keyword">|</span></code></td>

<td align="left" valign="top" >

<code><span class="constructor">Var_float</span> <span class="keyword">of</span> <code class="type">float</code></code></td>



</tr>

<tr>

<td align="left" valign="top" >

<code><span class="keyword">|</span></code></td>

<td align="left" valign="top" >

<code><span class="constructor">Var_str</span> <span class="keyword">of</span> <code class="type">string</code></code></td>



</tr>

<tr>

<td align="left" valign="top" >

<code><span class="keyword">|</span></code></td>

<td align="left" valign="top" >

<code><span class="constructor">Var_out_int</span></code></td>



</tr>

<tr>

<td align="left" valign="top" >

<code><span class="keyword">|</span></code></td>

<td align="left" valign="top" >

<code><span class="constructor">Var_out_date</span></code></td>



</tr>

<tr>

<td align="left" valign="top" >

<code><span class="keyword">|</span></code></td>

<td align="left" valign="top" >

<code><span class="constructor">Var_out_float</span></code></td>



</tr>

<tr>

<td align="left" valign="top" >

<code><span class="keyword">|</span></code></td>

<td align="left" valign="top" >

<code><span class="constructor">Var_out_str</span> <span class="keyword">of</span> <code class="type">int</code></code></td>



</tr></table>



<div class="info">

This type is for use in parameterized queries<br>

</div>



<br><code><span class="keyword">type</span> <a name="TYPEdescribed_column"></a><code class="type"></code>described_column = {</code><table class="typetable">

<tr>

<td align="left" valign="top" >

<code>&nbsp;&nbsp;</code></td>

<td align="left" valign="top" >

<code>name&nbsp;: <code class="type">string</code>;</code></td>



</tr>

<tr>

<td align="left" valign="top" >

<code>&nbsp;&nbsp;</code></td>

<td align="left" valign="top" >

<code>ctype&nbsp;: <code class="type">string</code>;</code></td>



</tr>

<tr>

<td align="left" valign="top" >

<code>&nbsp;&nbsp;</code></td>

<td align="left" valign="top" >

<code>len&nbsp;: <code class="type">int</code>;</code></td>



</tr>

<tr>

<td align="left" valign="top" >

<code>&nbsp;&nbsp;</code></td>

<td align="left" valign="top" >

<code>scale&nbsp;: <code class="type">int</code>;</code></td>



</tr>

<tr>

<td align="left" valign="top" >

<code>&nbsp;&nbsp;</code></td>

<td align="left" valign="top" >

<code>not_null&nbsp;: <code class="type">bool</code>;</code></td>



</tr></table>

}





<br>

This type is for use by the occi_describe function<br>

<pre><span class="keyword">exception</span> <a name="EXCEPTIONORA_EXCEPTION"></a>ORA_EXCEPTION <span class="keyword">of</span> <code class="type">(int * string)</code></pre>

<div class="info">

Oracle API functions raise this exception containing 

    <code class="code">(err_code * err_message)</code><br>

</div>

<pre><span class="keyword">exception</span> <a name="EXCEPTIONORA_BULK_EXCEPTION"></a>ORA_BULK_EXCEPTION <span class="keyword">of</span> <code class="type">(string * (int * int * string) array)</code></pre>

<div class="info">

<code class="code">occi_execute_array</code> function raises this exception containing 

    <code class="code">(error_message, failed_rows)</code>, where the <code class="code">failed_rows</code> is an array of tuples

    in the form <code class="code">(row_number, err_code, err_message)</code>.  

    The first row in the original array of records has number 0.<br>

</div>

<br>

<a name="3_FunctionalAPI"></a>

<h3>Functional API</h3><br>

<pre><span class="keyword">val</span> <a name="VALdecode_occi_type"></a><a href="code_VALOcci.decode_occi_type.html">decode_occi_type</a> : <code class="type">int -> string</code></pre><div class="info">

<code class="code">decode_occi_type column</code> used to convert the column type to string or 

    <code class="code">ora_column_type</code> type<br>

</div>

<div class="param_info"><table border="0" cellpadding="3" width="100%">

<tr>

<td align="left" valign="top" width="1%"><b>Parameters: </b></td>

<td>

<table class="paramstable">

<tr>

<td align="center" valign="top" width="15%" class="code">

??</td>

<td align="center" valign="top">:</td>

<td><code class="type">int</code><br>



</tr>

</table>

</td>

</tr>

</table></div>

<pre><span class="keyword">val</span> <a name="VALocci_connect"></a><a href="code_VALOcci.occi_connect.html">occi_connect</a> : <code class="type">string -> string -> string -> <a href="Occi.html#TYPEora_connection">ora_connection</a></code></pre><div class="info">

<code class="code">occi_connect user password database <span class="keywordsign">-&gt;</span> connection</code> creates a connection to an 

    Oracle database.  The connection is managed automatically by the CAML garbage

    collector, or it can be disconnected manually by issuing a call to <code class="code">occi_disconnect</code>.

<p>



    <b>Example:</b>

    <pre></pre><code class="code">value&nbsp;con&nbsp;=&nbsp;occi_connect&nbsp;<span class="string">"scott"</span>&nbsp;<span class="string">"tiger"</span>&nbsp;<span class="string">"mydb"</span>;</code><pre></pre><br>

</div>

<pre><span class="keyword">val</span> <a name="VALocci_disconnect"></a><a href="code_VALOcci.occi_disconnect.html">occi_disconnect</a> : <code class="type"><a href="Occi.html#TYPEora_connection">ora_connection</a> -> unit</code></pre><div class="info">

<code class="code">occi_disconnect connection <span class="keywordsign">-&gt;</span> unit</code> disconnects a previously open Oracle

    connection<br>

</div>

<pre><span class="keyword">val</span> <a name="VALocci_create_statement"></a><a href="code_VALOcci.occi_create_statement.html">occi_create_statement</a> : <code class="type"><a href="Occi.html#TYPEora_connection">ora_connection</a> -> string -> <a href="Occi.html#TYPEora_statement">ora_statement</a></code></pre><div class="info">

<code class="code">occi_create_statement con sql</code> creates an Oracle statement.  The sql string can be

    left blank, in which case it must be initialized in the call to <code class="code">occi_prepare_sql</code> or

    any function in the <code class="code">occi_execute*</code> family.  The statement is managed automatically by

    the garbage collector, so it doesn't need to be freed explicitely.

<p>



    <b>Example:</b>

    <pre></pre><code class="code">value&nbsp;stmt&nbsp;=&nbsp;occi_create_statement&nbsp;con&nbsp;<span class="string">""</span>;</code><pre></pre><br>

</div>

<pre><span class="keyword">val</span> <a name="VALocci_free_statement"></a><a href="code_VALOcci.occi_free_statement.html">occi_free_statement</a> : <code class="type"><a href="Occi.html#TYPEora_statement">ora_statement</a> -> unit</code></pre><div class="info">

<code class="code">occi_free_statement stmt</code> frees an Oracle statement created with <code class="code">ora_create_statement</code>.

    Note that it's not necessary to call this function, as the statement object is 

    automatically managed by the garbage collector<br>

</div>

<pre><span class="keyword">val</span> <a name="VALocci_prepare_sql"></a><a href="code_VALOcci.occi_prepare_sql.html">occi_prepare_sql</a> : <code class="type"><a href="Occi.html#TYPEora_statement">ora_statement</a> -> string -> unit</code></pre><div class="info">

<code class="code">occi_prepare_sql stmt sql</code> sets an SQL string for a given statement.<br>

</div>

<pre><span class="keyword">val</span> <a name="VALocci_prepare_plsql"></a><a href="code_VALOcci.occi_prepare_plsql.html">occi_prepare_plsql</a> : <code class="type"><a href="Occi.html#TYPEora_statement">ora_statement</a> -> string -> (int * <a href="Occi.html#TYPEparam_val">param_val</a>) list -> unit</code></pre><div class="info">

<code class="code">occi_prepare_plsql stmt sql [ (pos * param_val) ] </code> 

    sets sql text of a PL/SQL statement, and specifies OUT parameters.  The parameters are given 

    as an array of tuples, where <code class="code">pos</code> indicates the parameter number, <code class="code">param_val</code>

    is one of <code class="code"><span class="constructor">OutInt</span>; <span class="constructor">OutStr</span> <span class="keyword">of</span> int; <span class="constructor">OutFloat</span>; <span class="constructor">OutDate</span></code>, and OutStr specifies the max string

    size in bytes.

<p>



    This function allows to prepare the SQL statement prior to calling <code class="code">occi_execute</code> or 

    <code class="code">occi_execute_plsql</code>.

<p>



    <b>Example:</b>

<p>



    <pre></pre><code class="code">occi_prepare_plsql&nbsp;stmt&nbsp;<span class="string">"begin&nbsp;:1&nbsp;:=&nbsp;my_fun(:2);&nbsp;end;"</span>&nbsp;[(1,&nbsp;<span class="constructor">Var_out_str</span>&nbsp;30)];<br>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">match</span>&nbsp;(occi_execute_plsql&nbsp;stmt&nbsp;[(2,&nbsp;<span class="constructor">Var_int</span>&nbsp;10)])&nbsp;<span class="keyword">with</span><br>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[&nbsp;[(1,&nbsp;<span class="constructor">Var_str</span>&nbsp;s)]&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;print_endline&nbsp;s];<br>

&nbsp;&nbsp;&nbsp;&nbsp;</code><pre></pre><br>

</div>

<pre><span class="keyword">val</span> <a name="VALocci_describe"></a><a href="code_VALOcci.occi_describe.html">occi_describe</a> : <code class="type"><a href="Occi.html#TYPEora_connection">ora_connection</a> -> string -> (string * int * int * int * bool) array</code></pre><pre><span class="keyword">val</span> <a name="VALora_describe"></a><a href="code_VALOcci.ora_describe.html">ora_describe</a> : <code class="type"><a href="Occi.html#TYPEora_connection">ora_connection</a> -> string -> <a href="Occi.html#TYPEdescribed_column">described_column</a> array</code></pre><div class="info">

<code class="code">ora_describe ora_connection table_name</code> descrites a table by returning an array of

    field descriptors.

<p>



    <b>Example:</b>

    <pre></pre><code class="code">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="constructor">Array</span>.iter&nbsp;<br>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(<span class="keyword">fun</span>&nbsp;{name=a;&nbsp;ctype=b;&nbsp;len=c;&nbsp;scale=e;&nbsp;not_null=f}&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<br>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="constructor">Printf</span>.printf&nbsp;<span class="string">"&nbsp;&nbsp;%-30s&nbsp;%-10s&nbsp;%5d&nbsp;%5d&nbsp;%5b\n"</span>&nbsp;a&nbsp;b&nbsp;c&nbsp;e&nbsp;f)<br>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(occi_describe&nbsp;con&nbsp;<span class="string">"test"</span>);<br>

&nbsp;&nbsp;&nbsp;&nbsp;</code><pre></pre><br>

</div>

<div class="param_info"><table border="0" cellpadding="3" width="100%">

<tr>

<td align="left" valign="top" width="1%"><b>Parameters: </b></td>

<td>

<table class="paramstable">

<tr>

<td align="center" valign="top" width="15%" class="code">

con</td>

<td align="center" valign="top">:</td>

<td><code class="type"><a href="Occi.html#TYPEora_connection">ora_connection</a></code><br>



</tr>

<tr>

<td align="center" valign="top" width="15%" class="code">

table</td>

<td align="center" valign="top">:</td>

<td><code class="type">string</code><br>



</tr>

</table>

</td>

</tr>

</table></div>

<pre><span class="keyword">val</span> <a name="VALocci_execute"></a><a href="code_VALOcci.occi_execute.html">occi_execute</a> : <code class="type"><a href="Occi.html#TYPEora_statement">ora_statement</a> -><br>       string -> (int * <a href="Occi.html#TYPEparam_val">param_val</a>) list -> (int * <a href="Occi.html#TYPEora_value">ora_value</a>) list</code></pre><div class="info">

<code class="code">occi_execute stmt sql params <span class="keywordsign">-&gt;</span> out_values</code> executes a PL/SQL block

    by preparing an <code class="code">sql</code> text, binding it with a list of <code class="code">params</code> where each element is

    a tuple (position:int * value:param_val), and returns the <code class="code">out_values</code> result

    as a list of (position:int * value:ora_value) tuples where each value represents the 

    value of an OUT parameter at a given position.

<p>



    <b>Example:</b>  <pre></pre><code class="code">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">let</span>&nbsp;lst&nbsp;=&nbsp;occi_execute&nbsp;stmt&nbsp;<span class="string">"begin&nbsp;:1&nbsp;=&nbsp;my_fun(:2);&nbsp;end;"</span><br>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[(1,&nbsp;<span class="constructor">Var_out_int</span>),&nbsp;(2,&nbsp;<span class="constructor">Var_float</span>&nbsp;2.0)]<br>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">in</span>&nbsp;<span class="constructor">List</span>.iter&nbsp;(<span class="keyword">fun</span>&nbsp;(i,&nbsp;v)&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Printf</span>.printf&nbsp;<span class="string">"%d,&nbsp;%s\n"</span>&nbsp;i&nbsp;(field_to_string&nbsp;v))&nbsp;lst;<br>

&nbsp;&nbsp;&nbsp;&nbsp;</code><pre></pre><br>

</div>

<pre><span class="keyword">val</span> <a name="VALocci_fetch"></a><a href="code_VALOcci.occi_fetch.html">occi_fetch</a> : <code class="type"><a href="Occi.html#TYPEcursor">cursor</a> -> <a href="Occi.html#TYPEora_value">ora_value</a> array</code></pre><div class="info">

<code class="code">occi_fetch rs</code> returns data as an array of fields. This is an internal function, so 

    it's recommended to use the occi_fetch_foreach instead.<br>

<b>Raises</b> <code>End_of_file</code> when there are no more rows in the cursor.<br>

</div>

<pre><span class="keyword">val</span> <a name="VALora_fetch_foreach"></a><a href="code_VALOcci.ora_fetch_foreach.html">ora_fetch_foreach</a> : <code class="type"><a href="Occi.html#TYPEcursor">cursor</a> -> (<a href="Occi.html#TYPEora_value">ora_value</a> array -> unit) -> unit</code></pre><div class="info">

<code class="code">ora_fetch_foreach cursor f</code> applies the function <code class="code">f: array ora_values <span class="keywordsign">-&gt;</span> unit</code> to 

    each record in the <code class="code">cursor</code>.<br>

<b>Raises</b> <code>End_of_file</code> when there are no more rows in the cursor.

<p>



    <b>Example:</b>

    <pre></pre><code class="code">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">let</span>&nbsp;(cursor,&nbsp;_)&nbsp;=&nbsp;occi_execute_query&nbsp;stmt&nbsp;<span class="string">"select&nbsp;*&nbsp;from&nbsp;test"</span>&nbsp;<span class="keyword">in</span>&nbsp;<br>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">try</span><br>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ora_fetch_foreach&nbsp;cursor&nbsp;(<span class="keyword">fun</span>&nbsp;[|&nbsp;<span class="constructor">Int</span>&nbsp;i;&nbsp;<span class="constructor">Str</span>&nbsp;s&nbsp;|]&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Printf</span>.printf&nbsp;<span class="string">"%d&nbsp;-&nbsp;%s\n"</span>&nbsp;i&nbsp;s)<br>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">with</span><br>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[&nbsp;<span class="constructor">End_of_file</span>&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;()&nbsp;];&nbsp;</code><pre></pre><br>

</div>

<div class="param_info"><table border="0" cellpadding="3" width="100%">

<tr>

<td align="left" valign="top" width="1%"><b>Parameters: </b></td>

<td>

<table class="paramstable">

<tr>

<td align="center" valign="top" width="15%" class="code">

rs</td>

<td align="center" valign="top">:</td>

<td><code class="type"><a href="Occi.html#TYPEcursor">cursor</a></code><br>



</tr>

<tr>

<td align="center" valign="top" width="15%" class="code">

f</td>

<td align="center" valign="top">:</td>

<td><code class="type"><a href="Occi.html#TYPEora_value">ora_value</a> array -> unit</code><br>



</tr>

</table>

</td>

</tr>

</table></div>

<pre><span class="keyword">val</span> <a name="VALora_fetch_foreach_list"></a><a href="code_VALOcci.ora_fetch_foreach_list.html">ora_fetch_foreach_list</a> : <code class="type">?max_rows:int option -><br>       <a href="Occi.html#TYPEcursor">cursor</a> -> (<a href="Occi.html#TYPEora_value">ora_value</a> array list -> bool) -> unit</code></pre><div class="info">

<code class="code">ora_fetch_foreach_list cursor max_rows f</code> fetches up to max_rows of 

    records from an open cursor to list, and applies function <code class="code">f</code> to that 

    list.  Function <code class="code">f</code> should return <code class="code"><span class="constructor">False</span></code> if there's no need to continue 

    fetching records, or <code class="code"><span class="constructor">True</span></code> otherwise.  If max_rows is <code class="code"><span class="constructor">None</span></code> then all 

    records are retrieved and passed to the <code class="code">f</code> function.  If max_rows is 

    <code class="code"><span class="constructor">Some</span> n</code> then the list passed to the <code class="code">f</code> function will contain at most 

    <code class="code">n</code> elements.

<p>



    <b>Example:</b> <pre></pre><code class="code">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">let</span>&nbsp;(cursor,&nbsp;_)&nbsp;=&nbsp;occi_execute_query&nbsp;stmt&nbsp;<span class="string">"select&nbsp;*&nbsp;from&nbsp;test"</span>&nbsp;<span class="keyword">in</span>&nbsp;<br>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="comment">(*&nbsp;Process&nbsp;records&nbsp;10-elements&nbsp;at&nbsp;a&nbsp;time&nbsp;*)</span><br>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ora_fetch_foreach_list&nbsp;cursor&nbsp;(<span class="keyword">fun</span>&nbsp;data&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="keyword">do</span>&nbsp;{<span class="constructor">List</span>.iter&nbsp;process_record&nbsp;data;&nbsp;<span class="constructor">True</span>})&nbsp;~max_rows:10;<br>

&nbsp;&nbsp;&nbsp;&nbsp;</code><pre></pre><br>

</div>

<div class="param_info"><table border="0" cellpadding="3" width="100%">

<tr>

<td align="left" valign="top" width="1%"><b>Parameters: </b></td>

<td>

<table class="paramstable">

<tr>

<td align="center" valign="top" width="15%" class="code">

max_rows</td>

<td align="center" valign="top">:</td>

<td><code class="type">int option</code><br>



</tr>

<tr>

<td align="center" valign="top" width="15%" class="code">

cur</td>

<td align="center" valign="top">:</td>

<td><code class="type"><a href="Occi.html#TYPEcursor">cursor</a></code><br>



</tr>

<tr>

<td align="center" valign="top" width="15%" class="code">

f</td>

<td align="center" valign="top">:</td>

<td><code class="type"><a href="Occi.html#TYPEora_value">ora_value</a> array list -> bool</code><br>



</tr>

</table>

</td>

</tr>

</table></div>

<pre><span class="keyword">val</span> <a name="VALora_fetch_list"></a><a href="code_VALOcci.ora_fetch_list.html">ora_fetch_list</a> : <code class="type">?max_rows:int option -><br>       <a href="Occi.html#TYPEcursor">cursor</a> -> <a href="Occi.html#TYPEcursor">cursor</a> option * <a href="Occi.html#TYPEora_value">ora_value</a> array list</code></pre><div class="info">

<code class="code">ora_fetch_list cursor max_rows</code> fetches up to max_rows of records from an 

    open cursor to list.  If max_rows is <code class="code"><span class="constructor">None</span></code> and/or all records are retrieved then

    result will contain <code class="code">(<span class="constructor">None</span>, data_list)</code>.  If max_rows is <code class="code"><span class="constructor">Some</span> n</code> then 

    after fetching <code class="code">max_rows</code> rows, the function will return <code class="code">(<span class="constructor">Some</span> cursor, data_list)</code>,

    and the <code class="code">cursor</code> could be used in successive calls to <code class="code">ora_fetch_list</code>.

<p>



    <b>Example:</b> <pre></pre><code class="code">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">let</span>&nbsp;(cursor,&nbsp;_)&nbsp;=&nbsp;occi_execute_query&nbsp;stmt&nbsp;<span class="string">"select&nbsp;*&nbsp;from&nbsp;test"</span>&nbsp;<span class="keyword">in</span>&nbsp;<br>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">let</span>&nbsp;(_,&nbsp;data)&nbsp;&nbsp;&nbsp;=&nbsp;ora_fetch_list&nbsp;cursor&nbsp;<span class="constructor">None</span>&nbsp;<span class="keyword">in</span><br>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="constructor">List</span>.iter&nbsp;process_record&nbsp;data;&nbsp;&nbsp;</code><pre></pre><br>

</div>

<div class="param_info"><table border="0" cellpadding="3" width="100%">

<tr>

<td align="left" valign="top" width="1%"><b>Parameters: </b></td>

<td>

<table class="paramstable">

<tr>

<td align="center" valign="top" width="15%" class="code">

max_rows</td>

<td align="center" valign="top">:</td>

<td><code class="type">int option</code><br>



</tr>

<tr>

<td align="center" valign="top" width="15%" class="code">

cur</td>

<td align="center" valign="top">:</td>

<td><code class="type"><a href="Occi.html#TYPEcursor">cursor</a></code><br>



</tr>

</table>

</td>

</tr>

</table></div>

<pre><span class="keyword">val</span> <a name="VALocci_execute_query"></a><a href="code_VALOcci.occi_execute_query.html">occi_execute_query</a> : <code class="type"><a href="Occi.html#TYPEora_statement">ora_statement</a> -> string -> <a href="Occi.html#TYPEcursor">cursor</a> * string array</code></pre><div class="info">

<code class="code">occi_execute_query stmt sql <span class="keywordsign">-&gt;</span> (cursor * field_names)</code> executes an Oracle query

    and returns an open cursor and an array of field names.  The cursor can be fetched

    using <code class="code">occi_fetch</code> function.  <code class="code">sql</code> can be empty, in which case the sql value is 

    taken from the <code class="code">occi_statement con sql</code> call.<br>

<b>Returns</b> an opaque cursor object that can be fetched from using occi_fetch and an

            array of field names.<br>

</div>

<pre><span class="keyword">val</span> <a name="VALocci_execute_param_query"></a><a href="code_VALOcci.occi_execute_param_query.html">occi_execute_param_query</a> : <code class="type"><a href="Occi.html#TYPEora_statement">ora_statement</a> -><br>       string -> <a href="Occi.html#TYPEparam_val">param_val</a> array -> <a href="Occi.html#TYPEcursor">cursor</a> * string array</code></pre><div class="info">

<code class="code">occi_execute_param_query stmt sql params <span class="keywordsign">-&gt;</span> (cursor * field_names)</code> executes an Oracle query.

    It is the same as <code class="code">occi_execute_query</code> with the exception that it takes an array of parameter

    values.  The query should be a SELECT statement with bind variables in the form: ":1" ... ":N"

    where each ":i" will represent the i-th parameter from the <code class="code">params</code> array. 

<p>



    <b>Example:</b>

    <pre></pre><code class="code">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">let</span>&nbsp;stmt&nbsp;=&nbsp;occi_create_statement&nbsp;con&nbsp;<span class="string">""</span>&nbsp;<span class="keyword">in</span>&nbsp;<br>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">let</span>&nbsp;(cursor,&nbsp;fields)&nbsp;=&nbsp;occi_execute_param_query&nbsp;stmt<br>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="string">"SELECT&nbsp;*&nbsp;FROM&nbsp;TEST&nbsp;WHERE&nbsp;ID&nbsp;&lt;&nbsp;:1&nbsp;and&nbsp;NAME&nbsp;LIKE&nbsp;:2"</span>&nbsp;<br>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[|&nbsp;<span class="constructor">Var_int</span>&nbsp;100;&nbsp;<span class="constructor">Var_str</span>&nbsp;<span class="string">"S%"</span>&nbsp;|]<br>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">in</span>&nbsp;<span class="constructor">List</span>.iter&nbsp;do_fetch_record&nbsp;cursor;&nbsp;</code><pre></pre><br>

</div>

<pre><span class="keyword">val</span> <a name="VALora_select"></a><a href="code_VALOcci.ora_select.html">ora_select</a> : <code class="type"><a href="Occi.html#TYPEora_statement">ora_statement</a> -><br>       string -><br>       ?max_rows:int option -><br>       <a href="Occi.html#TYPEparam_val">param_val</a> array -><br>       <a href="Occi.html#TYPEcursor">cursor</a> option * string array * <a href="Occi.html#TYPEora_value">ora_value</a> array list</code></pre><div class="info">

This function selects records given a SELECT SQL command, and returns result in a 

    form of a list.  Note that this function doesn't raise <code class="code"><span class="constructor">End_of_file</span></code> exception upon

    reaching the end of a cursor.<br>

<b>Returns</b> <code class="code">(cursor, list_of_records)</code>, where the <code class="code">cursor</code> is either None or a value that

            can be passed to <code class="code">ora_fetch_list</code> function to process remaining records.

<p>



    <b>Example:</b> <pre></pre><code class="code">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">let</span>&nbsp;(_,&nbsp;_,&nbsp;lst)&nbsp;=&nbsp;<br>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ora_select&nbsp;stmt&nbsp;<span class="string">"select&nbsp;*&nbsp;from&nbsp;test&nbsp;where&nbsp;id&nbsp;&lt;&nbsp;:1"</span>&nbsp;[|&nbsp;<span class="constructor">Var_int</span>&nbsp;10&nbsp;|])<br>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">in</span><br>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="constructor">List</span>.iter&nbsp;print_record&nbsp;lst;<br>

&nbsp;&nbsp;&nbsp;&nbsp;</code><pre></pre><br>

</div>

<div class="param_info"><table border="0" cellpadding="3" width="100%">

<tr>

<td align="left" valign="top" width="1%"><b>Parameters: </b></td>

<td>

<table class="paramstable">

<tr>

<td align="center" valign="top" width="15%" class="code">

stmt</td>

<td align="center" valign="top">:</td>

<td><code class="type"><a href="Occi.html#TYPEora_statement">ora_statement</a></code><br>



</tr>

<tr>

<td align="center" valign="top" width="15%" class="code">

sql</td>

<td align="center" valign="top">:</td>

<td><code class="type">string</code><br>



</tr>

<tr>

<td align="center" valign="top" width="15%" class="code">

max_rows</td>

<td align="center" valign="top">:</td>

<td><code class="type">int option</code><br>

defines the maximum number of rows to return (<code class="code"><span class="constructor">None</span></code> means all, 

           which is the default).

</tr>

<tr>

<td align="center" valign="top" width="15%" class="code">

params</td>

<td align="center" valign="top">:</td>

<td><code class="type"><a href="Occi.html#TYPEparam_val">param_val</a> array</code><br>

is an array of bind paramerer values.  If it's not empty, the query is

           expected to contain parameters in the form ":1" ... ":N" that will be bound

           using values from the array at corresponding positions.  The bind parameter

           indexes begin with ":1".

</tr>

</table>

</td>

</tr>

</table></div>

<pre><span class="keyword">val</span> <a name="VALocci_execute_array"></a><a href="code_VALOcci.occi_execute_array.html">occi_execute_array</a> : <code class="type"><a href="Occi.html#TYPEora_statement">ora_statement</a> -> string -> <a href="Occi.html#TYPEparam_val">param_val</a> array list -> int</code></pre><div class="info">

<code class="code">occi_execute_array stmt</code> executes an SQL INSERT/UPDATE/DELETE bulk operation.  The

    parameter list contains arrays of field values.  Each array can be thought of a 

    record in an Oracle table associated with the INSERT/UPDATE/DELETE operation.  This 

    function uses a bulk interface, so that only one network roundtrip is performed 

    for the entire list of parameter values.<br>

<b>Raises</b> <code>ORA_BULK_EXCEPTION</code> See example below on how to 

    retrieve the error codes for the failed rows.

<p>



    <b>Example:</b> <pre></pre><code class="code">&nbsp;<br>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">try</span><br>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">match</span>&nbsp;occi_execute_array&nbsp;stmt&nbsp;<br>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[<br>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[|&nbsp;<span class="constructor">Var_int</span>&nbsp;1,&nbsp;<span class="constructor">Null_str</span>,&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="constructor">Var_date</span>&nbsp;(encode_date&nbsp;(2006,1,1,0,0,0))&nbsp;|],<br>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[|&nbsp;<span class="constructor">Var_int</span>&nbsp;1,&nbsp;<span class="constructor">Var_str</span>&nbsp;<span class="string">"abc"</span>,&nbsp;<span class="constructor">Null_date</span>&nbsp;|],<br>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;...<br>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;]<br>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">with</span>&nbsp;[n&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Printf</span>.printf&nbsp;<span class="string">"Inserted&nbsp;%d&nbsp;records\n"</span>&nbsp;n]<br>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">with</span>&nbsp;[<br>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="constructor">ORA_BULK_EXCEPTION</span>&nbsp;(err_message,&nbsp;failed_rows)&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="keyword">do</span>&nbsp;{<br>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="constructor">Printf</span>.printf&nbsp;<span class="string">"Failed&nbsp;%d&nbsp;rows.&nbsp;Reason:&nbsp;%s\n"</span>&nbsp;(<span class="constructor">Array</span>.length&nbsp;failed_rows)&nbsp;err_message;<br>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="constructor">Array</span>.iter&nbsp;(<span class="keyword">fun</span>&nbsp;(i,&nbsp;e,&nbsp;m)&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Printf</span>.printf&nbsp;<span class="string">"&nbsp;&nbsp;Row&nbsp;%d&nbsp;error&nbsp;[%d]:&nbsp;%s\n"</span>&nbsp;i&nbsp;e&nbsp;m)&nbsp;failed_rows<br>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}<br>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;];<br>

&nbsp;&nbsp;&nbsp;&nbsp;</code><pre></pre><br>

</div>

<pre><span class="keyword">val</span> <a name="VALocci_execute_update"></a><a href="code_VALOcci.occi_execute_update.html">occi_execute_update</a> : <code class="type"><a href="Occi.html#TYPEora_statement">ora_statement</a> -> <a href="Occi.html#TYPEparam_val">param_val</a> array -> int</code></pre><div class="info">

<code class="code">occi_execute_update stmt params <span class="keywordsign">-&gt;</span> num_rows</code> executes an INSERT/UPDATE/DELETE 

    operation on a previously bound statement

<p>



    <b>Example:</b>

<p>



    <pre></pre><code class="code">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;occi_prepare_sql&nbsp;stmt&nbsp;<span class="string">"insert&nbsp;into&nbsp;test&nbsp;(id,&nbsp;name)&nbsp;values&nbsp;(:1,&nbsp;:2)"</span>;<br>

<br>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">match</span>&nbsp;occi_execute_update&nbsp;stmt&nbsp;[|&nbsp;(1,&nbsp;<span class="constructor">Var_int</span>&nbsp;1);&nbsp;(2,&nbsp;<span class="string">"test"</span>)&nbsp;|]&nbsp;<span class="keyword">with</span><br>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[&nbsp;n&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Printf</span>.printf&nbsp;<span class="string">"Inserted&nbsp;%d&nbsp;record\n"</span>&nbsp;n];<br>

&nbsp;&nbsp;&nbsp;&nbsp;</code><pre></pre><br>

</div>

<pre><span class="keyword">val</span> <a name="VALocci_execute_plsql"></a><a href="code_VALOcci.occi_execute_plsql.html">occi_execute_plsql</a> : <code class="type"><a href="Occi.html#TYPEora_statement">ora_statement</a> -><br>       (int * <a href="Occi.html#TYPEparam_val">param_val</a>) list -> (int * <a href="Occi.html#TYPEora_value">ora_value</a>) list</code></pre><div class="info">

<code class="code">occi_execute_plsql stmt params <span class="keywordsign">-&gt;</span> out_param_values</code> executes a PL/SQL block given 

    a list of bind parameter values and returns the list of OUT parameter tuples.  In 

    the <code class="code">params</code> list, and <code class="code">out_param_values</code> list the first element represents the 

    position of the OUT parameter.<br>

<b>See also</b> <a href="#VALocci_prepare_plsql">occi_prepare_plsql for an example</a><br>

</div>

<div class="param_info"><table border="0" cellpadding="3" width="100%">

<tr>

<td align="left" valign="top" width="1%"><b>Parameters: </b></td>

<td>

<table class="paramstable">

<tr>

<td align="center" valign="top" width="15%" class="code">

stmt</td>

<td align="center" valign="top">:</td>

<td><code class="type"><a href="Occi.html#TYPEora_statement">ora_statement</a></code><br>



</tr>

<tr>

<td align="center" valign="top" width="15%" class="code">

params</td>

<td align="center" valign="top">:</td>

<td><code class="type">(int * <a href="Occi.html#TYPEparam_val">param_val</a>) list</code><br>



</tr>

</table>

</td>

</tr>

</table></div>

<pre><span class="keyword">val</span> <a name="VALocci_commit"></a><a href="code_VALOcci.occi_commit.html">occi_commit</a> : <code class="type"><a href="Occi.html#TYPEora_connection">ora_connection</a> -> unit</code></pre><div class="info">

<code class="code">occi_commit con</code> commit a transaction<br>

</div>

<pre><span class="keyword">val</span> <a name="VALocci_rollback"></a><a href="code_VALOcci.occi_rollback.html">occi_rollback</a> : <code class="type"><a href="Occi.html#TYPEora_connection">ora_connection</a> -> unit</code></pre><div class="info">

<code class="code">occi_rollback con</code> rollback a transaction<br>

</div>

<pre><span class="keyword">val</span> <a name="VALdate_to_tm"></a><a href="code_VALOcci.date_to_tm.html">date_to_tm</a> : <code class="type">float -> Unix.tm</code></pre><div class="info">

<code class="code">date_to_tm float</code> convert a float date to a <code class="code"><span class="constructor">Unix</span>.tm</code> record.<br>

<b>Raises</b> <code>Failure</code> for other argument types.<br>

</div>

<div class="param_info"><table border="0" cellpadding="3" width="100%">

<tr>

<td align="left" valign="top" width="1%"><b>Parameters: </b></td>

<td>

<table class="paramstable">

<tr>

<td align="center" valign="top" width="15%" class="code">

d</td>

<td align="center" valign="top">:</td>

<td><code class="type">float</code><br>



</tr>

</table>

</td>

</tr>

</table></div>

<pre><span class="keyword">val</span> <a name="VALdecode_date"></a><a href="code_VALOcci.decode_date.html">decode_date</a> : <code class="type">float -> int * int * int * int * int * int</code></pre><div class="info">

<code class="code">decode_date d</code> convert a date to a tuple 

    <code class="code">(year:int, mon:int, day:int, hour:int, min:int, sec:int)</code>.<br>

<b>Raises</b> <code>Failure</code> for other argument types.<br>

</div>

<div class="param_info"><table border="0" cellpadding="3" width="100%">

<tr>

<td align="left" valign="top" width="1%"><b>Parameters: </b></td>

<td>

<table class="paramstable">

<tr>

<td align="center" valign="top" width="15%" class="code">

d</td>

<td align="center" valign="top">:</td>

<td><code class="type">float</code><br>



</tr>

</table>

</td>

</tr>

</table></div>

<pre><span class="keyword">val</span> <a name="VALencode_date"></a><a href="code_VALOcci.encode_date.html">encode_date</a> : <code class="type">int * int * int * int * int * int -> float</code></pre><div class="info">

<code class="code">encode_date date_tuple</code> converts a tuple from 

    <code class="code">(year, mon, day, hour, min, sec)</code> to a float value representing the 

    number of days since epoch and fractional part representing

    the number of seconds since midnight. <code class="code">year</code> is the calendar year, 

    <code class="code">mon</code> is between <code class="code">1</code> and <code class="code">12</code>, <code class="code">day</code> is between <code class="code">1</code> and <code class="code">31</code>, 

    <code class="code">hour</code> is between <code class="code">0</code> and <code class="code">23</code>, and <code class="code">min</code> and <code class="code">sec</code> are between <code class="code">0</code> and

    <code class="code">59</code>.<br>

</div>

<div class="param_info"><table border="0" cellpadding="3" width="100%">

<tr>

<td align="left" valign="top" width="1%"><b>Parameters: </b></td>

<td>

<table class="paramstable">

<tr>

<td align="center" valign="top" width="15%" class="code">

(year,mon,day,hour,min,sec)</td>

<td align="center" valign="top">:</td>

<td><code class="type">int * int * int * int * int * int</code><br>



</tr>

</table>

</td>

</tr>

</table></div>

<pre><span class="keyword">val</span> <a name="VALdate_to_string"></a><a href="code_VALOcci.date_to_string.html">date_to_string</a> : <code class="type">float -> string</code></pre><div class="info">

<code class="code">date_to_string d</code> convert a date string in the "MM/DD/YYYY HH:MI:SS" format. 

    Failure is raised for other argument types.<br>

</div>

<div class="param_info"><table border="0" cellpadding="3" width="100%">

<tr>

<td align="left" valign="top" width="1%"><b>Parameters: </b></td>

<td>

<table class="paramstable">

<tr>

<td align="center" valign="top" width="15%" class="code">

d</td>

<td align="center" valign="top">:</td>

<td><code class="type">float</code><br>



</tr>

</table>

</td>

</tr>

</table></div>

<pre><span class="keyword">val</span> <a name="VALsysdate"></a><a href="code_VALOcci.sysdate.html">sysdate</a> : <code class="type">unit -> float</code></pre><div class="info">

<code class="code">sysdate</code> returns the current local time encoded in the internal date format.<br>

</div>

<div class="param_info"><table border="0" cellpadding="3" width="100%">

<tr>

<td align="left" valign="top" width="1%"><b>Parameters: </b></td>

<td>

<table class="paramstable">

<tr>

<td align="center" valign="top" width="15%" class="code">

()</td>

<td align="center" valign="top">:</td>

<td><code class="type">unit</code><br>



</tr>

</table>

</td>

</tr>

</table></div>

<pre><span class="keyword">val</span> <a name="VALfield_to_string"></a><a href="code_VALOcci.field_to_string.html">field_to_string</a> : <code class="type"><a href="Occi.html#TYPEora_value">ora_value</a> -> string</code></pre><div class="info">

<code class="code">field_to_string fld</code> convert an ora_value to string.

<p>



    <b>Example:</b>   <pre></pre><code class="code">&nbsp;field_to_string(<span class="constructor">Date</span>&nbsp;d)&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="string">"2006/03/10&nbsp;15:00:00"</span>&nbsp;</code><pre></pre><br>

</div>

<div class="param_info"><table border="0" cellpadding="3" width="100%">

<tr>

<td align="left" valign="top" width="1%"><b>Parameters: </b></td>

<td>

<table class="paramstable">

<tr>

<td align="center" valign="top" width="15%" class="code">

fld</td>

<td align="center" valign="top">:</td>

<td><code class="type"><a href="Occi.html#TYPEora_value">ora_value</a></code><br>



</tr>

</table>

</td>

</tr>

</table></div>

<pre><span class="keyword">val</span> <a name="VALprint_date"></a><a href="code_VALOcci.print_date.html">print_date</a> : <code class="type">float -> unit</code></pre><div class="info">

Print a date in the format returned by the <code class="code">date_to_string</code> function<br>

</div>

<div class="param_info"><table border="0" cellpadding="3" width="100%">

<tr>

<td align="left" valign="top" width="1%"><b>Parameters: </b></td>

<td>

<table class="paramstable">

<tr>

<td align="center" valign="top" width="15%" class="code">

d</td>

<td align="center" valign="top">:</td>

<td><code class="type">float</code><br>



</tr>

</table>

</td>

</tr>

</table></div>

<pre><span class="keyword">val</span> <a name="VALprint_field"></a><a href="code_VALOcci.print_field.html">print_field</a> : <code class="type">int -> <a href="Occi.html#TYPEora_value">ora_value</a> -> unit</code></pre><div class="info">

Print a field.  If <code class="code">n</code> is greater than 0, a comma will be printed in 

    front of the field's value<br>

</div>

<div class="param_info"><table border="0" cellpadding="3" width="100%">

<tr>

<td align="left" valign="top" width="1%"><b>Parameters: </b></td>

<td>

<table class="paramstable">

<tr>

<td align="center" valign="top" width="15%" class="code">

n</td>

<td align="center" valign="top">:</td>

<td><code class="type">int</code><br>



</tr>

<tr>

<td align="center" valign="top" width="15%" class="code">

fld</td>

<td align="center" valign="top">:</td>

<td><code class="type"><a href="Occi.html#TYPEora_value">ora_value</a></code><br>



</tr>

</table>

</td>

</tr>

</table></div>

<pre><span class="keyword">val</span> <a name="VALprint_record"></a><a href="code_VALOcci.print_record.html">print_record</a> : <code class="type"><a href="Occi.html#TYPEora_value">ora_value</a> array -> unit</code></pre><div class="info">

Print a record containing <code class="code">ora_value</code> fields separated by commas.<br>

</div>

<div class="param_info"><table border="0" cellpadding="3" width="100%">

<tr>

<td align="left" valign="top" width="1%"><b>Parameters: </b></td>

<td>

<table class="paramstable">

<tr>

<td align="center" valign="top" width="15%" class="code">

r</td>

<td align="center" valign="top">:</td>

<td><code class="type"><a href="Occi.html#TYPEora_value">ora_value</a> array</code><br>



</tr>

</table>

</td>

</tr>

</table></div>

<br>

<a name="3_ObjectOrientedAPI"></a>

<h3>Object-Oriented API</h3><br>

<pre><span class="keyword">class</span> <a name="TYPEstatement"></a><a href="Occi.statement.html">statement</a> : <code class="type">?sql:string -> <a href="Occi.html#TYPEora_connection">ora_connection</a> -> </code><code class="code"><span class="keyword">object</span></code> <a href="Occi.statement.html">..</a> <code class="code"><span class="keyword">end</span></code></pre><div class="info">

This class implements DML and DDL Oracle operations on a given 

    connection descriptor.

</div>

<pre><span class="keyword">class</span> <a name="TYPEconnection"></a><a href="Occi.connection.html">connection</a> : <code class="type">string -> string -> string -> </code><code class="code"><span class="keyword">object</span></code> <a href="Occi.connection.html">..</a> <code class="code"><span class="keyword">end</span></code></pre></body></html>