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
|
// file : odb/oracle/statement.cxx
// author : Constantin Michael <constantin@codesynthesis.com>
// copyright : Copyright (c) 2005-2011 Code Synthesis Tools CC
// license : ODB NCUEL; see accompanying LICENSE file
#include <cassert>
#include <oci.h>
#include <odb/exceptions.hxx> // object_not_persistent
#include <odb/details/unused.hxx>
#include <odb/oracle/database.hxx>
#include <odb/oracle/statement.hxx>
#include <odb/oracle/connection.hxx>
#include <odb/oracle/auto-descriptor.hxx>
#include <odb/oracle/error.hxx>
#include <odb/oracle/exceptions.hxx>
using namespace std;
namespace odb
{
namespace oracle
{
// Mapping of bind::buffer_type values for parameter buffers to their
// equivalent external OCI typecode identifiers.
//
static ub4 param_sqlt_lookup[bind::last] =
{
SQLT_INT, // bind::integer
SQLT_UIN, // bind::uinteger
SQLT_BFLOAT, // bind::binary_float
SQLT_BDOUBLE, // bind::binary_double
SQLT_VNU, // bind::number
SQLT_DAT, // bind::date
SQLT_TIMESTAMP, // bind::timestamp
SQLT_CHR, // bind::string
SQLT_CHR, // bind::nstring
SQLT_BIN, // bind::raw
SQLT_LBI, // bind::blob
SQLT_LNG, // bind::clob
SQLT_LNG // bind::nclob
};
// Mapping of bind::buffer_type values for result buffers to their
// equivalent external OCI typecode identifiers.
//
static ub4 result_sqlt_lookup[bind::last] =
{
SQLT_INT, // bind::integer
SQLT_UIN, // bind::uinteger
SQLT_BFLOAT, // bind::binary_float
SQLT_BDOUBLE, // bind::binary_double
SQLT_VNU, // bind::number
SQLT_DAT, // bind::date
SQLT_TIMESTAMP, // bind::timestamp
SQLT_CHR, // bind::string
SQLT_CHR, // bind::nstring
SQLT_BIN, // bind::raw
SQLT_BLOB, // bind::blob
SQLT_CLOB, // bind::clob
SQLT_CLOB // bind::nclob
};
static sb4
param_callback_proxy (void* context,
OCIBind*,
ub4, // iteration
ub4, // index
void** buffer,
ub4* size,
ub1* piece,
void** indicator)
{
bind& b (*static_cast<bind*> (context));
// Only call the callback if the parameter is not NULL.
//
if (*b.indicator != -1)
{
chunk_position pos;
if (!(*b.callback.param) (&b.callback_context,
reinterpret_cast<ub4*> (b.size),
const_cast<const void**> (buffer),
size,
&pos,
b.buffer,
b.capacity))
return OCI_ERROR;
switch (pos)
{
case one_chunk:
{
*piece = OCI_ONE_PIECE;
break;
}
case first_chunk:
{
*piece = OCI_FIRST_PIECE;
break;
}
case next_chunk:
{
*piece = OCI_NEXT_PIECE;
break;
}
case last_chunk:
{
*piece = OCI_LAST_PIECE;
break;
}
}
}
else
*piece = OCI_ONE_PIECE;
*indicator = b.indicator;
return OCI_CONTINUE;
}
//
// statement
//
statement::
statement (connection& conn, const string& s)
: conn_ (conn)
{
OCIError* err (conn_.error_handle ());
OCIStmt* handle (0);
sword r (OCIStmtPrepare2 (conn_.handle (),
&handle,
err,
reinterpret_cast<const text*> (s.c_str ()),
static_cast<ub4> (s.size ()),
0,
0,
OCI_NTV_SYNTAX,
OCI_DEFAULT));
if (r == OCI_ERROR || r == OCI_INVALID_HANDLE)
translate_error (err, r);
stmt_.reset (handle, OCI_STRLS_CACHE_DELETE, err);
}
void statement::
bind_param (bind* b, size_t c, size_t o)
{
OCIError* err (conn_.error_handle ());
// The parameter position in OCIBindByPos is specified as a 1-based
// index. Convert o to a 1-based offset.
//
++o;
for (size_t e (o + c); o < e; ++o, ++b)
{
#if OCI_MAJOR_VERSION < 11 || \
(OCI_MAJOR_VERSION == 11 && OCI_MINOR_VERSION < 2)
// Assert if a 64 bit integer buffer type is provided and the OCI
// version is unable to implicitly convert the NUMBER binary data
// to the relevant type.
//
assert ((b->type != bind::integer && b->type != bind::uinteger) ||
b->capacity <= 4);
#endif
bool callback (b->callback != 0);
OCIBind* h (0);
sword r (OCIBindByPos (stmt_,
&h,
err,
o,
callback ? 0 : b->buffer,
static_cast<sb4> (b->capacity),
param_sqlt_lookup[b->type],
callback ? 0 : b->indicator,
callback ? 0 : b->size,
0,
0,
0,
callback ? OCI_DATA_AT_EXEC : OCI_DEFAULT));
if (r == OCI_ERROR || r == OCI_INVALID_HANDLE)
translate_error (err, r);
if (b->type == bind::nstring || b->type == bind::nclob)
{
ub1 form (SQLCS_NCHAR);
r = OCIAttrSet (h,
OCI_HTYPE_BIND,
&form,
0,
OCI_ATTR_CHARSET_FORM,
err);
if (r == OCI_ERROR || r == OCI_INVALID_HANDLE)
translate_error (err, r);
}
if (callback)
{
r = OCIBindDynamic (h, err, b, ¶m_callback_proxy, 0, 0);
if (r == OCI_ERROR || r == OCI_INVALID_HANDLE)
translate_error (err, r);
}
}
}
void statement::
bind_result (bind* b, size_t c, size_t p)
{
ODB_POTENTIALLY_UNUSED (p);
OCIError* err (conn_.error_handle ());
for (size_t i (1); i <= c; ++i, ++b)
{
OCIDefine* h (0);
if (b->type == bind::blob ||
b->type == bind::clob ||
b->type == bind::nclob)
{
// When binding a LOB result, the bind::size member is reinterpreted
// as a pointer to an auto_descriptor<OCILobLocator>. If the
// descriptor has not yet been allocated, it is allocated now.
//
auto_descriptor<OCILobLocator>* lob (
reinterpret_cast<auto_descriptor<OCILobLocator>*> (b->size));
if (lob->get () == 0)
{
OCILobLocator* h (0);
sword r (OCIDescriptorAlloc (conn_.database ().environment (),
reinterpret_cast<void**> (&h),
OCI_DTYPE_LOB,
0,
0));
// OCIDescriptorAlloc will return OCI_SUCCESS on success, or
// OCI_INVALID_HANDLE on an out-of-memory condition.
//
if (r != OCI_SUCCESS)
throw invalid_oci_handle ();
lob->reset (h);
}
sword r (OCIDefineByPos (stmt_,
&h,
err,
i,
lob,
sizeof (OCILobLocator*),
result_sqlt_lookup[b->type],
b->indicator,
0,
0,
OCI_DEFAULT));
if (r == OCI_ERROR || r == OCI_INVALID_HANDLE)
translate_error (err, r);
// LOB prefetching is only supported in OCI version 11.1 and greater
// and in Oracle server 11.1 and greater. If this code is called
// against a pre 11.1 server, the call to OCIAttrSet will return an
// error code.
//
#if (OCI_MAJOR_VERSION == 11 && OCI_MINOR_VERSION >= 1) \
|| OCI_MAJOR_VERSION > 11
if (p != 0)
{
r = OCIAttrSet (h,
OCI_HTYPE_DEFINE,
&p,
0,
OCI_ATTR_LOBPREFETCH_SIZE,
err);
if (r == OCI_ERROR || r == OCI_INVALID_HANDLE)
translate_error (err, r);
}
#endif
}
else
{
#if OCI_MAJOR_VERSION < 11 || \
(OCI_MAJOR_VERSION == 11 && OCI_MINOR_VERSION < 2)
// Assert if a 64 bit integer buffer type is provided and the OCI
// version is unable to implicitly convert the NUMBER binary data
// to the relevant type.
//
assert ((b->type != bind::integer && b->type != bind::uinteger) ||
b->capacity <= 4);
#endif
sword r (OCIDefineByPos (stmt_,
&h,
err,
i,
b->buffer,
static_cast<sb4> (b->capacity),
result_sqlt_lookup[b->type],
b->indicator,
b->size,
0,
OCI_DEFAULT));
if (r == OCI_ERROR || r == OCI_INVALID_HANDLE)
translate_error (err, r);
if (b->type == bind::nstring)
{
ub1 form (SQLCS_NCHAR);
r = OCIAttrSet (h,
OCI_HTYPE_DEFINE,
&form,
0,
OCI_ATTR_CHARSET_FORM,
err);
if (r == OCI_ERROR || r == OCI_INVALID_HANDLE)
translate_error (err, r);
}
}
}
}
void statement::
stream_result (bind* b, size_t c)
{
OCIError* err (conn_.error_handle());
for (size_t i (0); i < c; ++i, ++b)
{
// Only stream if the bind specifies a LOB type, and the LOB value is
// not NULL, and a result callback has been provided.
//
if ((b->type == bind::blob ||
b->type == bind::clob ||
b->type == bind::nclob) &&
*b->indicator != -1 &&
b->callback.result != 0)
{
// If b->capacity is 0, we will be stuck in an infinite loop.
//
assert (b->capacity != 0);
auto_descriptor<OCILobLocator>& locator (
*reinterpret_cast<auto_descriptor<OCILobLocator>* > (b->size));
ub1 piece (OCI_FIRST_PIECE);
// Setting the value pointed to by the byte_amt argument to 0 on the
// first call to OCILobRead2 instructs OCI to remain in a polling
// state until the EOF is reached, at which point OCILobRead2 will
// return OCI_SUCCESS.
//
ub8 read (0);
ub1 cs_form (b->type == bind::nclob ? SQLCS_NCHAR : SQLCS_IMPLICIT);
sword r;
do
{
r = OCILobRead2 (conn_.handle (),
err,
locator,
&read,
0,
1,
b->buffer,
b->capacity,
piece,
0,
0,
0,
cs_form);
if (r == OCI_ERROR || r == OCI_INVALID_HANDLE)
translate_error (err, r);
chunk_position cp;
if (piece == OCI_FIRST_PIECE)
cp = r == OCI_SUCCESS ? one_chunk : first_chunk;
else if (r == OCI_NEED_DATA)
cp = next_chunk;
else
cp = last_chunk;
piece = OCI_NEXT_PIECE;
// OCI generates and ORA-24343 error when an error code is
// returned from a user callback. We simulate this.
//
if (!(*b->callback.result) (b->callback_context,
b->buffer,
static_cast<ub4> (read),
cp))
throw database_exception (24343, "user defined callback error");
} while (r == OCI_NEED_DATA);
}
}
}
statement::
~statement ()
{
}
//
// select_statement
//
select_statement::
~select_statement ()
{
}
select_statement::
select_statement (connection& conn,
const string& s,
binding& cond,
binding& data,
size_t lob_prefetch_size)
: statement (conn, s),
data_ (data),
done_ (false)
{
bind_param (cond.bind, cond.count, 0);
bind_result (data.bind, data.count, lob_prefetch_size);
}
select_statement::
select_statement (connection& conn,
const string& s,
binding& data,
size_t lob_prefetch_size)
: statement (conn, s),
data_ (data),
done_ (false)
{
bind_result (data.bind, data.count, lob_prefetch_size);
}
void select_statement::
execute ()
{
if (!done_)
free_result ();
OCIError* err (conn_.error_handle ());
// @@ Retrieve a single row into the already bound output buffers as an
// optimization? This will avoid multiple server round-trips in the case
// of a single object load.
//
sword r (OCIStmtExecute (conn_.handle (),
stmt_,
err,
0,
0,
0,
0,
OCI_DEFAULT));
if (r == OCI_ERROR || r == OCI_INVALID_HANDLE)
translate_error (err, r);
#ifndef NDEBUG
ub4 n (0);
r = OCIAttrGet(stmt_, OCI_HTYPE_STMT, &n, 0, OCI_ATTR_PARAM_COUNT, err);
if (r == OCI_ERROR || r == OCI_INVALID_HANDLE)
translate_error (err, r);
// Make sure that the number of columns in the result returned by
// the database matches the number that we expect. A common cause
// of this assertion is a native view with a number of data members
// not matching the number of columns in the SELECT-list.
//
assert (n == data_.count);
#endif
}
select_statement::result select_statement::
fetch ()
{
if (!done_)
{
sword r (OCIStmtFetch2 (stmt_,
conn_.error_handle (),
1,
OCI_FETCH_NEXT,
0,
OCI_DEFAULT));
if (r == OCI_ERROR || r == OCI_INVALID_HANDLE)
translate_error (conn_.error_handle (), r);
else if (r == OCI_NO_DATA)
done_ = true;
}
return done_ ? no_data : success;
}
void select_statement::
free_result ()
{
if (!done_)
{
sword r (OCIStmtFetch2 (stmt_,
conn_.error_handle (),
0,
OCI_FETCH_NEXT,
0,
OCI_DEFAULT));
if (r == OCI_ERROR || r == OCI_INVALID_HANDLE)
translate_error (conn_.error_handle (), r);
done_ = true;
}
}
//
// insert_statement
//
static sb4
returning_in (void* context,
OCIBind*, // bind
ub4, // iter
ub4, // index
void** buffer,
ub4* size,
ub1* piece,
void** indicator)
{
typedef insert_statement::id_bind_type bind;
bind& b (*static_cast<bind*> (context));
*buffer = 0;
*size = 0;
*piece = OCI_ONE_PIECE;
b.indicator = -1;
*indicator = &b.indicator;
return OCI_CONTINUE;
}
static sb4
returning_out (void* context,
OCIBind*, // bind
ub4, // iter
ub4, // index
void** buffer,
ub4** size,
ub1*, // piece
void** indicator,
ub2** rcode)
{
typedef insert_statement::id_bind_type bind;
bind& b (*static_cast<bind*> (context));
#if (OCI_MAJOR_VERSION == 11 && OCI_MINOR_VERSION >=2) \
|| OCI_MAJOR_VERSION > 11
*buffer = &b.id.value64;
**size = sizeof (unsigned long long);
#else
*buffer = &b.id.value32;
**size = sizeof (unsigned int);
#endif
*indicator = &b.indicator;
*rcode = 0;
return OCI_CONTINUE;
}
insert_statement::
~insert_statement ()
{
}
insert_statement::
insert_statement (connection& conn,
const string& s,
binding& data,
bool returning)
: statement (conn, s)
{
bind_param (data.bind, data.count, 0);
if (returning)
{
OCIError* err (conn_.error_handle ());
OCIBind* h (0);
sword r (OCIBindByPos (stmt_,
&h,
err,
data.count,
0,
#if (OCI_MAJOR_VERSION == 11 && OCI_MINOR_VERSION >=2) \
|| OCI_MAJOR_VERSION > 11
sizeof (unsigned long long),
#else
sizeof (unsigned int),
#endif
SQLT_UIN,
0,
0,
0,
0,
0,
OCI_DATA_AT_EXEC));
if (r == OCI_ERROR || r == OCI_INVALID_HANDLE)
translate_error (err, r);
r = OCIBindDynamic (h,
err,
&id_bind_,
&returning_in,
&id_bind_,
&returning_out);
if (r == OCI_ERROR || r == OCI_INVALID_HANDLE)
translate_error (err, r);
}
}
bool insert_statement::
execute ()
{
OCIError* err (conn_.error_handle ());
sword r (OCIStmtExecute (conn_.handle (),
stmt_,
err,
1,
0,
0,
0,
OCI_DEFAULT));
if (r == OCI_ERROR || r == OCI_INVALID_HANDLE)
translate_error (err, r);
ub4 row_count (0);
r = OCIAttrGet (stmt_,
OCI_HTYPE_STMT,
&row_count,
0,
OCI_ATTR_ROW_COUNT,
err);
if (r == OCI_ERROR || r == OCI_INVALID_HANDLE)
translate_error (err, r);
// The value of the OCI_ATTR_ROW_COUNT attribute associated with an
// INSERT statment represents the number of rows inserted.
//
return row_count != 0;
}
unsigned long long insert_statement::
id ()
{
#if (OCI_MAJOR_VERSION == 11 && OCI_MINOR_VERSION >=2) \
|| OCI_MAJOR_VERSION > 11
return id_bind_.id.value64;
#else
return id_bind_.id.value32;
#endif
}
//
// update_statement
//
update_statement::
~update_statement ()
{
}
update_statement::
update_statement (connection& conn,
const string& s,
binding& cond,
binding& data)
: statement (conn, s)
{
bind_param (data.bind, data.count, 0);
bind_param (cond.bind, cond.count, data.count);
}
void update_statement::
execute ()
{
OCIError* err (conn_.error_handle ());
sword r (OCIStmtExecute (conn_.handle (),
stmt_,
err,
1,
0,
0,
0,
OCI_DEFAULT));
if (r == OCI_ERROR || r == OCI_INVALID_HANDLE)
translate_error (err, r);
ub4 row_count (0);
r = OCIAttrGet (stmt_,
OCI_HTYPE_STMT,
&row_count,
0,
OCI_ATTR_ROW_COUNT,
err);
if (r == OCI_ERROR || r == OCI_INVALID_HANDLE)
translate_error (err, r);
// The value of the OCI_ATTR_ROW_COUNT attribute associated with an
// UPDATE statment represents the number of matching rows found. Zero
// indicates no match.
//
if (row_count == 0)
throw object_not_persistent ();
}
//
// delete_statement
//
delete_statement::
~delete_statement ()
{
}
delete_statement::
delete_statement (connection& conn,
const string& s,
binding& cond)
: statement (conn, s)
{
bind_param (cond.bind, cond.count, 0);
}
unsigned long long delete_statement::
execute ()
{
OCIError* err (conn_.error_handle ());
sword r (OCIStmtExecute (conn_.handle (),
stmt_,
err,
1,
0,
0,
0,
OCI_DEFAULT));
if (r == OCI_ERROR || r == OCI_INVALID_HANDLE)
translate_error (err, r);
ub4 row_count (0);
r = OCIAttrGet (stmt_,
OCI_HTYPE_STMT,
&row_count,
0,
OCI_ATTR_ROW_COUNT,
err);
if (r == OCI_ERROR || r == OCI_INVALID_HANDLE)
translate_error (err, r);
return static_cast<unsigned long long> (row_count);
}
}
}
|