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
|
// file : odb/oracle/oracle-types.hxx
// author : Constantin Michael <constantin@codesynthesis.com>
// copyright : Copyright (c) 2005-2011 Code Synthesis Tools CC
// license : ODB NCUEL; see accompanying LICENSE file
#ifndef ODB_ORACLE_ORACLE_TYPES_HXX
#define ODB_ORACLE_ORACLE_TYPES_HXX
#include <odb/pre.hxx>
#include <odb/oracle/version.hxx>
#include <odb/oracle/oracle-fwd.hxx>
#include <odb/oracle/auto-descriptor.hxx>
namespace odb
{
namespace oracle
{
enum chunk_position
{
one_chunk,
first_chunk,
next_chunk,
last_chunk
};
// Callback function signature used to specify LOB parameters that are
// passed to the database. If false is returned from the callback,
// statement execution is aborted.
//
typedef bool (*param_callback_type) (
const void* context, // [in] The user context.
ub4* position_context, // [in] A position context. A callback is free to
// use this to track position information. This is
// initialized to zero before the callback is
// invoked for the first time.
const void** buffer, // [out] On return, a pointer to a buffer
// containing parameter data.
ub4* size, // [out] The parameter data size in bytes.
chunk_position*, // [out] The position of the chunk of data in
// buffer.
void* temp_buffer, // [in] A temporary buffer that may be used if
// required. The buffer argument should specify
// this buffer on return if it is used.
ub4 capacity); // [in] The temporary buffer size in bytes.
// Callback function signature used to specify LOB values returned from
// the database. If false is returned, database_exception is thrown.
//
typedef bool (*result_callback_type) (
void* context, // [in] The user context.
void* buffer, // [in] A buffer containing the result data.
ub4 size, // [in] The result data size in bytes.
chunk_position); // [in] The position of this chunk.
union lob_callback
{
param_callback_type param;
result_callback_type result;
};
union lob_context
{
const void* param;
void* result;
};
struct bind
{
// This enumeration identifies the possible buffer types that can be
// bound to a bind instance. In most cases, these map directly to
// SQLT_XXX codes, identifying an external OCI type. nstring and nclob
// however have no equivalent OCI typecode. These additional identifiers
// allow for a consistent interface across all types. Note that these
// values are mapped to their corresponding external OCI typecodes (if
// any) using their integer values, and should therefore not be
// rearranged or explicitly assigned without also adjusting the
// sqlt_lookup array in odb/oracle/statement.cxx.
//
enum buffer_type
{
integer, // Buffer is an integer type of size specified by size.
uinteger, // Buffer is an unsigned integer of size specified by
// size.
binary_float, // Buffer is a float.
binary_double, // Buffer is a double.
number, // Buffer is a variable length char array.
date, // Buffer is a 7-byte char array.
timestamp, // Buffer is a variable length char array.
string, // Buffer is a variable length char array.
nstring, // Buffer is a variable length char array.
raw, // Buffer is a variable length char array.
blob, // Bind is a callback.
clob, // Bind is a callback.
nclob, // Bind is a callback.
last // Used as an end of list marker.
};
buffer_type type; // The type stored by buffer.
void* buffer; // Data buffer pointer. When result callbacks are in
// use, this is interpreted as an
// auto_descriptor<OCILobLocator>*.
ub2* size; // The number of bytes in buffer. When parameter
// callbacks are in use, this is interpreted as a ub4*
// indicating the current position.
ub4 capacity; // The maximum number of bytes that can be stored in
// buffer.
sb2* indicator; // Pointer to an OCI indicator variable.
lob_callback* callback;
// This pointer is provided to the user through the context argument
// in both parameter and result callback functions.
//
lob_context* context;
};
}
}
#include <odb/post.hxx>
#endif // ODB_ORACLE_ORACLE_TYPES_HXX
|
