Skip Headers

Oracle Call Interface Programmer's Guide
Release 2 (9.2)
Part Number A96584-01
Go To Documentation Library
Home		 Go To Product List
Book List		 Go To Table Of Contents
Contents
Master Index
Feedback

Go to previous page

Index

A  B  C  D  E  F  G  H  I  K  L  M  N  O  P  Q  R  S  T  U  V  W  X 

A

ADO. See attribute descriptor object
ADT. See object type
Advanced Queuing
dequeue function, 16-90
description, 9-49
enqueue function, 16-92
examples, 16-93
functions, 16-89
OCI and, 9-49
OCI descriptors for, 9-50
OCI functions for, 9-50
OCI versus PL/SQL, 9-51
advantages
OCI, 1-3
allocation duration
example, 13-15
of objects, 13-15
application failover
callback example, 9-45
callback registration, 9-45
OCI callbacks, 9-42
AQ. See Advanced Queuing.
argument attributes, 6-16
arrays
binds, 11-38
defines, 11-41
skip parameter for, 5-28
arrays of structures, 5-26
indicator variables, 5-29
OCI calls used, 5-29
skip parameters, 5-27
atomic nulls, 10-30
attribute descriptor object, 11-29
attributes
of handles, 2-13
of objects, 10-17
of parameter descriptors, 6-5
of parameters, 6-5
authentication
by Distinguished Name, 8-16
by X.509 Certificate, 8-17
management, 8-12
authentication information handle attributes, A-19
authorize functions, 15-4

B

batch error mode, 4-9
BFILE
datatype, 3-21
bind functions, 15-66
bind handle
attributes, A-36
description, 2-10
bind operation, 4-6, 5-2, 11-36
associations made, 5-3
example, 5-7
initializing variables, 5-4
LOBs, 5-11
named datatypes, 5-10, 11-36
named versus positional, 5-4
OCI array interface, 5-5
OCI_DATA_AT_EXEC mode, 5-17
PL/SQL, 5-5
positional versus named, 5-4
REF cursor variables, 5-17
REFs, 5-10, 11-37
steps used, 5-6
binding
arrays, 11-38
buffer expansion, 5-39
OCINumber, 11-43
PL/SQL placeholders, 2-44
summary, 5-18
BLOB
datatype, 3-22
BLOBs (binary large objects)
datatype, 3-22
blocking modes, 2-41
branches
detaching, 8-7
resuming, 8-7
buffer expansion during binding, 5-39
buffering LOB operations, 7-12
building OCI applications on Unix, B-1

C

C datatypes
manipulating with OCI, 11-4
C language
support for OCI, xxxv
C++ language
support for OCI, xxxv
cache functions
server round-trips, C-4
callbacks
application failover, 9-42
dynamic registrations, 9-37
for LOB operations, 7-14
for reading LOBs, 7-15
for writing LOBs, 7-16
from external procedures, 9-42
LOB streaming interface, 7-15
parameter modes, 15-90
registration for application failover, 9-45
restrictions, 9-40
user-defined functions, 9-32
canceling OCI calls, 2-38
cartridge functions, 19-1
CASE OTT parameter, 14-32
CHAR
external datatype, 3-17
character length semantics, 2-46, 5-39, 5-40, 6-21
character set form, 5-35
character set ID, 5-35
Unicode, A-36, A-39
CHARZ
external datatype, 3-18
checkerr() function
code listing, 2-32
CLOB
datatype, 3-22
code
example programs, B-1
list of demonstration programs, B-1
CODE OTT parameter, 14-30
coding guidelines
function names, 2-41
reserved words, 2-40
coherency
of object cache, 13-4
collections
attributes, 6-12
data manipulation functions, 11-22
describing, 6-2
description, 11-21
functions for manipulating, 11-22
multi level, 11-26
scanning functions, 11-23
column objects
direct path loading of, 12-18
columns
attributes, 6-5, 6-15
commit, 2-29
in object applications, 13-15
one-phase for global transactions, 8-8
two-phase for global transactions, 8-8
complex object retrieval, 10-21
implementing, 10-24
navigational prefetching, 10-25
complex object retrieval (COR) descriptor, 2-19
attributes, A-44
complex object retrieval (COR) handle, 2-12
attributes, A-44
CONFIG OTT parameter, 14-31
connect functions, 15-4
connection mode
nonblocking, 2-41
connection pooling, 9-13
code example, 9-20
consistency
of object cache, 13-4
copying
objects, 10-33
COR, see complex object retrieval
creating
objects, 10-33

D

data cartridges
OCI functions, xl, 2-2, 19-1
data definition language
SQL statements, 1-7
data manipulation language
SQL statements, 1-8
data structures
new for 8.0, 2-5
database connection
for object applications, 10-10
databases
attributes, 6-19
describing, 6-2
datatypes
ANSI DATE, 3-23
BFILE, 3-21
binding and defining, 11-41
BLOBs (binary large objects), 3-22
CLOB, 3-22
conversions, 3-25
direct path loading, 12-3, A-74
external, 3-4, 3-7
FILE, 3-21
for piecewise operations, 5-45
internal, 3-4
internal codes, 3-5
INTERVAL DAY TO SECOND, 3-24
INTERVAL YEAR TO MONTH, 3-24
manipulating with OCI, 11-4
mapping and manipulation functions, C-6
mapping from Oracle to C, 11-2
mapping, Oracle methodology, 11-4
mapping, OTT, 14-10
NCLOB, 3-22
Oracle, 3-2
TIMESTAMP, 3-23
TIMESTAMP WITH LOCAL TIME ZONE, 3-24
TIMESTAMP WITH TIME ZONE, 3-23
DATE
external datatype, 3-14
date cache, 12-14
DATE, ANSI
datatype, 3-23
datetime
avoiding unexpected results, 3-25
datetime and date
migration rules, 3-29
DDL. See data definition language
default file name extensions
OTT, 14-41
default name mapping
OTT, 14-41
define
arrays, 11-41
return and error codes, 2-33
define functions, 15-66
define handle
attributes, A-39
description, 2-10
define operation, 4-15, 5-19, 11-38
example, 5-20
LOBs, 5-22
named datatypes, 5-22, 11-38
piecewise fetch, 5-25
PL/SQL output variables, 5-25
REFs, 5-22, 11-39
steps used, 5-20
defining
OCINumber, 11-43
deletes
positioned, 2-39
demonstration programs, B-1
list, B-1
describe
explicit, 4-14
explicit and implicit, 6-5
implicit, 4-13
of collections, 6-2
of databases, 6-2
of packages, 6-2
of schemas, 6-2
of sequences, 6-2
of stored functions, 6-2
of stored procedures, 6-2
of synonyms, 6-2
of tables, 6-2
of types, 6-2
of views, 6-2
select-list, 4-12
describe functions, 15-66
describe handle
attributes, A-42
description, 2-11
describe operation
server round-trips, C-6
descriptor, 2-15
allocating, 2-25
complex object retrieval, 2-19
objects, 11-29
parameter, 2-18
ROWID, 2-18
snapshot, 2-16
descriptor functions, 15-48
descriptor objects, 11-29
detaching branches, 8-7
direct path
of date columns, 12-14
direct path function context, 12-5
direct path handles, 2-12
direct path loading, 12-2
column array handle attributes, A-69
column parameter attributes, A-71
context handle attributes, A-62
datatypes of columns, 12-3, A-74
direct path column array handle, 12-6
direct path context handle, 12-5
direct path stream handle, 12-7
example, 12-9
functions, 12-7, 16-115
handle attributes, A-62
handles, 12-4
in pieces, 12-32
limitations, 12-9
stream handle attributes, A-70
DML. See data manipulation language
DML with RETURNING clause
See RETURNING clause
documentation, other Oracle, xxxvi
duration
example, 13-15
of objects, 13-15

E

embedded objects
fetching, 10-16
embedded SQL, 1-11
mixing with OCI calls, 1-11
enhanced DML array, 4-9
enhanced DML array feature, 4-9
environment handle
attributes, A-4
description, 2-9
error codes
define calls, 2-33
navigational functions, 17-5
error handle
attributes, A-11
description, 2-9
errors
example of handling, 2-32
handling, 2-31
handling in object applications, 10-37
ERRTYPE OTT parameter, 14-31
example
demonstration programs, B-1
nonblocking mode, 2-43
using OCIThread, 9-11
executing SQL statements, 4-7
execution
against multiple servers, 4-5
modes, 4-8
execution snapshots, 4-7
extensions
OTT default file name, 14-41
external datatypes, 3-4, 3-7
CHAR, 3-17
CHARZ, 3-18
conversions, 3-25
DATE, 3-14
FLOAT, 3-12
INTEGER, 3-12
LOBs, 3-20
LONG, 3-14
LONG RAW, 3-16
LONG VARCHAR, 3-16
LONG VARRAW, 3-17
named data types, 3-19
NUMBER, 3-11
RAW, 3-15
REF, 3-19
ROWID, 3-20
SQLT_BLOB, 3-20
SQLT_CLOB, 3-20
SQLT_NCLOB, 3-20
SQLT_NTY, 3-19
SQLT_REF, 3-19
STRING, 3-12
UNSIGNED, 3-16
VARCHAR, 3-14
VARCHAR2, 3-9
VARNUM, 3-13
VARRAW, 3-16
external procedure functions
return codes, 19-3
with_context type, 19-3
external procedures
OCI callbacks, 9-42
Externally Initialized Context, 8-22

F

fetch
piecewise, 5-45, 5-51
fetch operation, 4-16
LOB data, 4-16
setting prefetch count, 4-17
FILE
associating with OS file, 7-3
datatype, 3-21
fine grained access control
partitioned, 8-17
FLOAT
external datatype, 3-12
flushing, 13-11
object changes, 10-15
objects, 13-11
freeing
objects, 10-33, 13-9
function names
coding guidelines, 2-41
functions
attributes, 6-7

G

global transactions, 8-3
globalization support, xli, 2-46
OCI functions, xl, 2-2
GTRID. See transaction identifier

H

handle attributes, 2-13
reading, 2-13
setting, 2-13
handle functions, 15-48
handles, 2-5
advantages of, 2-8
allocating, 2-6, 2-25
bind handle, 2-10
C datatypes, 2-5
child freed when parent freed, 2-7
define handle, 2-10
describe handle, 2-11
direct path, 2-12
environment handle, 2-9
error handle, 2-9
freeing, 2-6
process, 2-13
process attributes, A-77
server handle, 2-9
service context handle, 2-9
statement handle, 2-10
subscription, 2-12, 9-56
transaction handle, 2-10
types, 2-5
user session handle, 2-10
HFILE OTT parameter, 14-31

I

indicator variables, 2-36
arrays of structures, 5-29
for named datatypes, 2-35, 2-37
for REF, 2-35
for REFs, 2-37
named datatype defines, 11-39
PL/SQL OUT binds, 11-39
REF defines, 11-39
with named datatype bind, 11-37
with REF bind, 11-37
INITFILE OTT parameter, 14-30
INITFUNC OTT parameter, 14-31
initialize functions, 15-4
inserts
piecewise, 5-45, 5-48
INTEGER
external datatype, 3-12
internal codes for datatypes
datatype codes, 3-5
internal datatypes, 3-4
conversions, 3-25
INTERVAL DAY TO SECOND datatype, 3-24
INTERVAL YEAR TO MONTH datatype, 3-24
intype file
providing when running OTT, 14-9
structure of, 14-34
INTYPE OTT parameter, 14-29

K

key words, xlii, 2-40

L

LDAP registration of publish-subscribe notification, 9-58
lists
attributes, 6-18
LOB
external datatypes, 3-20
LOB functions, 16-23
server round-trips, C-3
LOB locator, 2-17
attributes, A-43
LOBs
amount and offset parameters, 16-24
attributes of transient objects, 7-4
binding, 5-11
buffering, 7-12
callbacks, 7-14
character sets, 16-24
creating, 7-2
creating temporary, 7-19
defining, 5-22
duration of temporary, 7-19
example of temporary, 7-20
fetching data, 4-16
fixed-width character sets, 16-24
freeing temporary, 7-19
locator, 2-17
modifying, 7-2
OCI functions, 7-5
temporary, 7-18
varying-width character sets, 16-24
locator, 2-15
for LOB datatype, 2-17
locking, 13-13
objects, 13-13
optimistic model, 13-14
LONG
external datatype, 3-14
LONG RAW
external datatype, 3-16
LONG VARCHAR
external datatype, 3-16
LONG VARRAW
external datatype, 3-17

M

Makefile (Unix), B-1
marking
objects, 13-10
MDO. See method descriptor object
meta-attributes
of objects, 10-17
of persistent objects, 10-18
of transient objects, 10-21
method descriptor object, 11-29
migration
7.x to 8.0, 1-21
session, 8-12, 15-32
miscellaneous functions, 16-179
multiple servers
executing statement against, 4-5
multithreaded development
basic concepts, 9-3

N

named datatypes
binding, 5-10, 11-36
binding and defining, 11-41
defining, 5-22, 11-38
definition, 3-19
external datatypes, 3-19
indicator variables, 2-37
indicator variables for, 2-35
navigation, 13-18
navigational functions
error codes, 17-5
return values, 17-5
terminology, 17-3
NCHAR
issues, 5-35
NCLOB
datatype, 3-22
nested table
element ordering, 11-25
functions for manipulating, 11-24
nested tables
direct path loading of, 12-16
NLS_LANG, 2-49
NLS_NCHAR, 2-49
nonblocking mode, 2-41
example, 2-43
non-final object tables
direct path loading of, 12-31
no-op
definition, 17-22
null indicator struct, 10-30
generated by OTT, 10-9
nullity
of objects, 10-30
NULLs
detecting, 2-37
inserting, 2-36
inserting into database, 2-35
inserting using indicator variables, 2-35
nulls
atomic, 10-30
NUMBER
external datatype, 3-11

O

object applications
commit, 13-15
database connection, 10-10
rollback, 13-15
object cache, 13-2
coherency, 13-4
consistency, 13-4
initializing, 10-10
loading objects, 13-7
memory parameters, 13-5
operations on, 13-6
removing objects, 13-7
setting the size of, 13-5
object functions
See navigational functions.
server round-trips, C-4
object identifier
for persistent objects, 10-5
object reference, 10-35
object reference. See REFs
object runtime environment
initializing, 10-10
object tables
direct path loading of, 12-30
object type
representing in C applications, 10-8
object type translator
sample output, 10-9
See OTT
use with OCI, 10-8
objects
accessing with OCI, 14-23
allocation duration, 13-15
array pin, 10-13
attributes, 10-17
manipulating, 10-13
client-side cache, 13-2
copying, 10-33
creating, 10-33
duration, 13-15
flushing, 13-11
flushing changes, 10-15
freeing, 10-33, 13-9
lifetime, 17-2
LOB attribute of, 7-4
LOB attributes of transient objects, 7-4
locking, 13-13
manipulating with OCI, 14-23
marking, 10-15, 13-10
memory layout of instance, 13-17
memory management, 13-2
meta-attributes, 10-17
navigation, 13-18
simple, 13-18
NCHAR and NVARCHAR2 attribute of, 11-3
nulls, 10-30
OCI object application structure, 10-3
persistent, 10-5
pin count, 10-30
pin duration, 13-15
pinning, 10-12, 13-7
refreshing, 13-11
secondary memory, 13-17
terminology, 17-2
top-level memory, 13-17
transient, 10-5, 10-6
types, 10-5, 17-2
unmarking, 13-10
unpinning, 10-30, 13-8
use with OCI, 10-2
OCI, 6-12, 6-19, 11-35, 12-15, 12-16, 12-25, 12-34, 12-35, 12-36, 13-5, A-25, A-26, A-27, A-60, A-63, A-64, A-68
aborting calls, 2-38
accessing and manipulating objects, 14-23
advantages, 1-3
object support, 1-6
overview, 1-2
parts of, 1-4
OCI application
compiling, 1-4
general structure, 2-2
initialization example, 2-27
linking, 1-4
steps, 2-20
structure, 2-2
structure using objects, 10-3
terminating, 2-30
using the OTT with, 14-22
with objects
initializing, 10-10
OCI documentation, other, xl
OCI environment
initializing for objects, 10-10
OCI functions
advanced queuing, xl
canceling calls, 2-38
data cartridges, xl, 2-2
globalization, 2-2
globalization support, xl
not supported, 1-20
obsolescent, 1-18
other guides, xl
return codes, 2-31, 2-34
OCI navigational functions, 13-20
flush functions, 13-21
mark functions, 13-21
meta-attribute accessor functions, 13-21
miscellaneous functions, 13-22
naming scheme, 13-20
pin/unpin/free functions, 13-20
OCI process
initializing for objects, 10-10
OCI program. See OCI application
OCI relational functions
advanced queuing and publish-subscribe, 16-89
connect, authorize, and initialize, 15-4
guide to reference entries, 19-2
OCI_ATTR_ALLOC_DURATION
environment handle attribute, A-8
OCI_ATTR_APPCTX_ATTR, 8-23, A-19
OCI_ATTR_APPCTX_LIST, 8-22, A-19
OCI_ATTR_APPCTX_NAME, 8-23
OCI_ATTR_APPCTX_SIZE, 8-22, A-19
OCI_ATTR_APPCTX_VALUE, 8-23, A-20
OCI_ATTR_AUTOCOMMIT_DDL
attribute, 6-20
OCI_ATTR_BIND_DN, A-4
OCI_ATTR_BUF_ADDR, A-70
OCI_ATTR_BUF_SIZE, A-62, A-70
OCI_ATTR_CACHE
attribute, 6-15
OCI_ATTR_CACHE_ARRAYFLUSH, 13-11
environment handle attribute, A-4
OCI_ATTR_CACHE_MAX_SIZE
environment handle attribute, A-4
OCI_ATTR_CACHE_OPT_SIZE
environment handle attribute, A-5
OCI_ATTR_CATALOG_LOCATION
attribute, 6-20
OCI_ATTR_CERTIFICATE, A-20
OCI_ATTR_CERTIFICATE_TYPE, A-20
OCI_ATTR_CHAR_COUNT
bind handle attribute, A-36
define handle attribute, A-39
OCI_ATTR_CHAR_SIZE, 6-15
attribute, 6-21
OCI_ATTR_CHAR_USED, 6-15
attribute, 6-21
OCI_ATTR_CHARSET_FORM, 5-35, 6-18
attribute, 6-11, 6-14, 6-16
bind handle attribute, A-36
define handle attribute, A-39
OCI_ATTR_CHARSET_ID, 5-35, A-62, A-73
attribute, 6-11, 6-14, 6-16, 6-18, 6-20
bind handle attribute, A-36
define handle attribute, A-39
OCI_ATTR_CLIENT_IDENTIFIER, 8-18, A-20
OCI_ATTR_CLUSTERED
attribute, 6-7
OCI_ATTR_COL_COUNT, A-69
OCI_ATTR_COLLECTION_ELEMENT
attribute, 6-9
OCI_ATTR_COLLECTION_TYPECODE
attribute, 6-9
OCI_ATTR_COMPLEXOBJECT_ COLL_OUTOFLINE
COR handle attribute, A-44
OCI_ATTR_COMPLEXOBJECT_LEVEL
COR handle attribute, A-44
OCI_ATTR_COMPLEXOBJECTCOMP _TYPE_LEVEL
COR descriptor attribute, A-45
OCI_ATTR_COMPLEXOBJECTCOMP_TYPE
COR descriptor attribute, A-44
OCI_ATTR_CONN_BUSY_COUNT, A-23
OCI_ATTR_CONN_INCR, A-24
OCI_ATTR_CONN_MAX, A-24
OCI_ATTR_CONN_MIN, A-24
OCI_ATTR_CONN_NOWAIT, A-23
OCI_ATTR_CONN_OPEN_COUNT, A-24
OCI_ATTR_CONN_TIMEOUT, A-23
OCI_ATTR_CURRENT_POSITION
attribute, 4-18, A-29
OCI_ATTR_CURSOR_COMMIT_ BEHAVIOR
attribute, 6-20
OCI_ATTR_DATA_SIZE, 6-15, 6-21, A-74
attribute, 6-10, 6-13, 6-15, 6-17
OCI_ATTR_DATA_TYPE, A-74
attribute, 6-10, 6-13, 6-15, 6-17
OCI_ATTR_DATE_FORMAT, A-62
OCI_ATTR_DATEFORMAT, A-75
OCI_ATTR_DBA
attribute, 6-7
OCI_ATTR_DESC_PUBLIC, 15-96
OCI_ATTR_DIRPATH_EXPR_TYPE direct path function attribute, A-67
OCI_ATTR_DIRPATH_EXPR_TYPE function context attribute, 12-36
OCI_ATTR_DIRPATH_NOLOG, A-64
OCI_ATTR_DIRPATH_OBJ_CONSTR, A-65
OCI_ATTR_DIRPATH_OBJ_CONSTR direct path context attribute, 12-34
OCI_ATTR_DIRPATH_OID, A-75
OCI_ATTR_DIRPATH_PARALLEL, A-65
OCI_ATTR_DIRPATH_SID column array attribute, 12-41
OCI_ATTR_DISTINGUISHED_NAME, 8-16, 8-17, A-21
OCI_ATTR_DML_ROW_OFFSET
error handle attribute, A-11
OCI_ATTR_DN_COUNT, A-55
OCI_ATTR_DURATION
attribute, 6-7
OCI_ATTR_ENCAPSULATION
attribute, 6-12
OCI_ATTR_ENV, A-29
server handle attribute, A-15
service context handle attribute, A-12
OCI_ATTR_ENV_CHARSET_ID, 2-50
environment handle attribute, A-5
OCI_ATTR_ENV_NCHARSET_ID, 2-50
environment handle attribute, A-5
OCI_ATTR_ENV_UTF16
environment handle attribute, A-6
OCI_ATTR_EXTERNAL_NAME, 8-8
server handle attribute, A-15
OCI_ATTR_FOCBK
server handle attribute, A-15
OCI_ATTR_FSPRECISION
attribute, 6-11
OCI_ATTR_HAS_DEFAULT
attribute, 6-17
OCI_ATTR_HAS_FILE
attribute, 6-9
OCI_ATTR_HAS_LOB
attribute, 6-9
OCI_ATTR_HAS_NESTED_TABLE
attribute, 6-9
OCI_ATTR_HEAPALLOC
environment handle attribute, A-8
OCI_ATTR_HW_MARK
attribute, 6-15
OCI_ATTR_IN_V8_MODE
server handle attribute, A-16
service context handle attribute, A-12
OCI_ATTR_INCR
attribute, 6-15
OCI_ATTR_INDEX_ONLY
attribute, 6-7
OCI_ATTR_INITIAL_CLIENT_ROLES, 8-17, A-21
OCI_ATTR_INTERNAL_NAME, 8-8
server handle attribute, A-16
OCI_ATTR_IOMODE
attribute, 6-17
OCI_ATTR_IS_CONSTRUCTOR
attribute, 6-12
OCI_ATTR_IS_DESTRUCTOR
attribute, 6-12
OCI_ATTR_IS_FINAL_METHOD
attribute, 6-12
OCI_ATTR_IS_FINAL_TYPE
attribute, 6-10
OCI_ATTR_IS_INCOMPLETE_TYPE
attribute, 6-9
OCI_ATTR_IS_INSTANTIABLE_METHOD
attribute, 6-12
OCI_ATTR_IS_INSTANTIABLE_TYPE
attribute, 6-10
OCI_ATTR_IS_INVOKER_RIGHTS
attribute, 6-8, 6-10
OCI_ATTR_IS_MAP
attribute, 6-12
OCI_ATTR_IS_NULL
attribute, 6-16, 6-18
OCI_ATTR_IS_OPERATOR
attribute, 6-12
OCI_ATTR_IS_ORDER
attribute, 6-12
OCI_ATTR_IS_OVERRIDING_METHOD
attribute, 6-12
OCI_ATTR_IS_PREDEFINED_TYPE
attribute, 6-9
OCI_ATTR_IS_RNDS
attribute, 6-12
OCI_ATTR_IS_RNPS
attribute, 6-12
OCI_ATTR_IS_SELFISH
attribute, 6-12
OCI_ATTR_IS_SUBTYPE
attribute, 6-10
OCI_ATTR_IS_SYSTEM_GENERATED_TYPE
attribute, 6-9
OCI_ATTR_IS_SYSTEM_TYPE
attribute, 6-9
OCI_ATTR_IS_TEMPORARY
attribute, 6-7
OCI_ATTR_IS_TRANSIENT_TYPE
attribute, 6-9
OCI_ATTR_IS_WNDS
attribute, 6-12
OCI_ATTR_IS_WNPS
attribute, 6-12
OCI_ATTR_LDAP_AUTH, A-6
OCI_ATTR_LDAP_CRED, A-6
OCI_ATTR_LDAP_CTX, A-7
OCI_ATTR_LDAP_HOST, A-7
OCI_ATTR_LDAP_PORT, A-7
OCI_ATTR_LEVEL
attribute, 6-17
OCI_ATTR_LFPRECISION
attribute, 6-11
OCI_ATTR_LINK
attribute, 6-14, 6-18
OCI_ATTR_LIST_ARGUMENTS
attribute, 6-8, 6-12
OCI_ATTR_LIST_COLUMNS, A-65
attribute, 6-7
OCI_ATTR_LIST_COLUMNS direct path function context attribute, A-68
OCI_ATTR_LIST_OBJECTS
attribute, 6-19
OCI_ATTR_LIST_SCHEMAS
attribute, 6-20
OCI_ATTR_LIST_SUBPROGRAMS
attribute, 6-8
OCI_ATTR_LIST_TYPE
attribute, 6-18
OCI_ATTR_LIST_TYPE_ATTRS
attribute, 6-9
OCI_ATTR_LIST_TYPE_METHODS
attribute, 6-10
OCI_ATTR_LOBEMPTY
LOB locator attribute, A-43
OCI_ATTR_LOCKING_MODE
attribute, 6-20
OCI_ATTR_MAP_METHOD
attribute, 6-10
OCI_ATTR_MAX
attribute, 6-14
OCI_ATTR_MAX_CATALOG_ NAMELEN
attribute, 6-20
OCI_ATTR_MAX_COLUMN_ NAMELEN
attribute, 6-20
OCI_ATTR_MAX_PROC_NAMELEN
attribute, 6-20
OCI_ATTR_MAXCHAR_SIZE, A-37, A-40
attribute, 5-39
OCI_ATTR_MAXCHAR_SIZE attribute, 5-38
OCI_ATTR_MAXDATA_SIZE
attribute, 5-39
bind handle attribute, A-37
use with binding, 5-37
OCI_ATTR_MEMPOOL_APPNAME, A-77
OCI_ATTR_MEMPOOL_HOMENAME, A-77
OCI_ATTR_MEMPOOL_INSTNAME, A-78
OCI_ATTR_MEMPOOL_SIZE, A-78
OCI_ATTR_MIGSESSION
user session handle attribute, A-21
OCI_ATTR_MIN
attribute, 6-14
OCI_ATTR_NAME, A-66, A-76
attribute, 6-8, 6-10, 6-12, 6-13, 6-14, 6-15, 6-17
OCI_ATTR_NAME column array attribute, 12-39
OCI_ATTR_NAME direct path function context attribute, A-68
OCI_ATTR_NAME function context attribute, 12-34
OCI_ATTR_NCHARSET_ID
attribute, 6-20
OCI_ATTR_NONBLOCKING_MODE
server handle attribute, 2-42, A-16
OCI_ATTR_NOWAIT_SUPORT
attribute, 6-20
OCI_ATTR_NUM_COLS, A-66, A-69
attribute, 6-7
OCI_ATTR_NUM_COLS direct path function context attribute, 12-37, A-68
OCI_ATTR_NUM_DML_ERRORS, A-29
OCI_ATTR_NUM_ELEMENTS
attribute, 6-13
OCI_ATTR_NUM_HANDLES
attribute, 6-19
OCI_ATTR_NUM_PARAMS
attribute, 6-5
OCI_ATTR_NUM_ROWS, A-69
OCI_ATTR_NUM_ROWS attribute, 12-42
OCI_ATTR_NUM_ROWS direct path context attribute, A-66
OCI_ATTR_NUM_ROWS direct path function context attribute, A-69
OCI_ATTR_NUM_ROWS function context attribute, 12-38
OCI_ATTR_NUM_TYPE_ATTRS
attribute, 6-9
OCI_ATTR_NUM_TYPE_METHODS
attribute, 6-9
OCI_ATTR_OBJ_ID
attribute, 6-5
OCI_ATTR_OBJ_NAME
attribute, 6-5
OCI_ATTR_OBJ_SCHEMA
attribute, 6-6
OCI_ATTR_OBJECT
environment handle attribute, A-7
OCI_ATTR_OBJECT_DETECTCHANGE, 13-14
environment handle attribute, 13-14, A-9
OCI_ATTR_OBJECT_NEWNOTNULL, 17-45
environment handle attribute, A-9
OCI_ATTR_OBJID
attribute, 6-7, 6-14
OCI_ATTR_ORDER
attribute, 6-15
OCI_ATTR_ORDER_METHOD
attribute, 6-10
OCI_ATTR_OVERLOAD
attribute, 6-8
OCI_ATTR_PARAM
describe handle attribute, A-42
use when an attribute is itself a descriptor, 15-50
OCI_ATTR_PARAM_COUNT
describe handle attribute, A-42
OCI_ATTR_PARAM_COUNT statement handle attribute, A-29
OCI_ATTR_PARSE_ERROR_OFFSET, A-36
OCI_ATTR_PARSE_ERROR_OFFSET statement handle attribute, A-30
OCI_ATTR_PARTITIONED
attribute, 6-7
OCI_ATTR_PASSWORD, 8-21
user session handle attribute, A-22
OCI_ATTR_PDPRC, A-37
OCI_ATTR_PDSCL
bind handle attribute, A-38, A-41
OCI_ATTR_PIN_DURATION
environment handle attribute, A-8
OCI_ATTR_PINOPTION
environment handle attribute, A-8
OCI_ATTR_POSITION
attribute, 6-17
OCI_ATTR_PRECISION, A-76
attribute, 6-5, 6-11, 6-13, 6-15, 6-17
OCI_ATTR_PREFETCH_MEMORY
statement handle attribute, A-31
OCI_ATTR_PREFETCH_MEMORY statement handle attribute, A-30
OCI_ATTR_PREFETCH_ROWS
statement handle attribute, A-31
OCI_ATTR_PROC_MODE, A-78
OCI_ATTR_PROXY_CREDENTIALS, 8-16, A-22
OCI_ATTR_PTYPE
attribute, 6-6
OCI_ATTR_RADIX
attribute, 6-17
OCI_ATTR_REF_TDO
attribute, 6-7, 6-9, 6-11, 6-14, 6-16, 6-18
OCI_ATTR_ROW_COUNT, 4-18, A-31, A-70
OCI_ATTR_ROWID
statement handle attribute, A-31
OCI_ATTR_ROWS_FETCHED, 4-19, A-32
OCI_ATTR_ROWS_RETURNED
bind handle attribute, A-38
use with callbacks, 5-34
OCI_ATTR_SAVEPOINT_SUPPORT
attribute, 6-20
OCI_ATTR_SCALE, A-76
attribute, 6-11, 6-13, 6-16, 6-17
OCI_ATTR_SCHEMA_NAME, A-66
attribute, 6-10, 6-11, 6-13, 6-14, 6-16, 6-18
OCI_ATTR_SEQ
attributes, 6-14
OCI_ATTR_SERVER
service context handle attribute, A-12
OCI_ATTR_SERVER_DN, A-56
OCI_ATTR_SERVER_DNS, A-57
OCI_ATTR_SERVER_GROUP
server handle attribute, A-17
OCI_ATTR_SERVER_STATUS
server handle attribute, A-17
OCI_ATTR_SESSION
service context handle attribute, A-13
OCI_ATTR_SHARED_HEAP_ALLOC
environment handle attribute, A-9
OCI_ATTR_SQLFNCODE
statement handle attribute, A-32
OCI_ATTR_STATEMENT statement handle attribute, A-34
OCI_ATTR_STMT_STATE, A-35
OCI_ATTR_STMT_TYPE
statement handle attribute, A-35
OCI_ATTR_STMTCACHESIZE, 9-31, 15-37, A-13
OCI_ATTR_STREAM_OFFSET, A-71
OCI_ATTR_SUB_NAME, A-67
attribute, 6-18
OCI_ATTR_SUBSCR_CALLBACK, A-57
OCI_ATTR_SUBSCR_CTX, A-57
OCI_ATTR_SUBSCR_NAME, A-58
OCI_ATTR_SUBSCR_NAMESPACE, A-58
OCI_ATTR_SUBSCR_PAYLOAD, A-58
OCI_ATTR_SUBSCR_RECPT, A-59
OCI_ATTR_SUBSCR_RECPTPRES, A-59
OCI_ATTR_SUBSCR_RECPTPROTO, A-60
OCI_ATTR_SUBSCR_SERVER_DN descriptor handle, 9-59
OCI_ATTR_SUPERTYPE_NAME
attribute, 6-10
OCI_ATTR_SUPERTYPE_SCHEMA_NAME
attribute, 6-10
OCI_ATTR_TABLESPACE
attribute, 6-7
OCI_ATTR_TIMESTAMP
attribute, 6-6
OCI_ATTR_TRANS
service context handle attribute, A-13
OCI_ATTR_TRANS_NAME, 8-4
transaction handle attribute, A-28
OCI_ATTR_TRANS_TIMEOUT
transaction handle attribute, A-28
OCI_ATTR_TYPE_NAME
attribute, 6-11, 6-13, 6-16, 6-18
OCI_ATTR_TYPECODE
attribute, 6-9, 6-10, 6-13, 6-17
OCI_ATTR_USERNAME
user session handle attribute, A-22
OCI_ATTR_VERSION
attribute, 6-20
OCI_ATTR_WALL_LOC, A-10
OCI_ATTR_XID, 8-4
transaction handle attribute, A-28
OCI_CONTINUE, 2-31
OCI_CPOOL_REINITIALIZE, 15-6
OCI_CRED_PROXY, 8-16
OCI_CRED_RDBMS, 8-16
OCI_DEFAULT, 9-3, 15-6
OCI_DIRPATH_DATASAVE_FINISH, 16-126
OCI_DIRPATH_DATASAVE_SAVEONLY, 16-126
OCI_DIRPATH_OID column array attribute, 12-41
OCI_DTYPE_AQAGENT, 2-16
OCI_DTYPE_AQDEQ_OPTIONS, 2-15
OCI_DTYPE_AQENQ_OPTIONS, 2-15
OCI_DTYPE_AQMSG_PROPERTIES, 2-15
OCI_DTYPE_AQNFY, 2-16
OCI_DTYPE_COMPLEXOBJECTCOMP, 2-15
OCI_DTYPE_DATE, 2-15
OCI_DTYPE_FILE, 2-15
OCI_DTYPE_INTERVAL_DS, 2-15
OCI_DTYPE_INTERVAL_YM, 2-15
OCI_DTYPE_LOB, 2-15
OCI_DTYPE_PARAM, 2-15, 15-49, 15-62
use in code samples, 4-13
when used, 15-50
OCI_DTYPE_ROWID, 2-15
OCI_DTYPE_SNAP, 2-15
OCI_DTYPE_SRVDN, 2-16
OCI_DTYPE_TIMESTAMP, 2-15
OCI_DTYPE_TIMESTAMP_LTZ, 2-15
OCI_DTYPE_TIMESTAMP_TZ, 2-15
OCI_DURATION_SESSION, 13-8, 16-26, 19-10, 20-7, 20-21, 20-27, 20-37
OCI_DURATION_STATEMENT, 16-26, 19-10, 20-7, 20-20, 20-27, 20-37
OCI_DURATION_TRANS, 13-8
OCI_ERROR, 2-31, 8-8
OCI_EVENTS
mode for receiving notifications, 9-56
OCI_EXT_CRED, 8-16
OCI_HTYPE_AUTHINFO, 2-6, 9-26
OCI_HTYPE_BIND, 2-6
OCI_HTYPE_COMPLEXOBJECT, 2-6
OCI_HTYPE_COR, 15-62
OCI_HTYPE_CPOOL, 2-6, 9-15
OCI_HTYPE_DEFINE, 2-6
OCI_HTYPE_DESCRIBE, 2-6
OCI_HTYPE_DIRPATH_COLUMN_ARRAY, 2-6
OCI_HTYPE_DIRPATH_CTX, 2-6
OCI_HTYPE_DIRPATH_FN_CTX, 2-6
OCI_HTYPE_DIRPATH_STREAM, 2-6
OCI_HTYPE_ENV, 2-6
OCI_HTYPE_ERROR, 2-6
OCI_HTYPE_PROC, 2-6
OCI_HTYPE_SERVER, 2-6
OCI_HTYPE_SESSION, 2-6
OCI_HTYPE_SPOOL, 2-6
OCI_HTYPE_STMT, 2-6, 15-49, 15-62
OCI_HTYPE_SUBSCRIPTION, 2-6
OCI_HTYPE_SVCCTX, 2-6
OCI_HTYPE_TRANS, 2-6
OCI_INVALID_HANDLE, 2-31
OCI_LOCK_NONE, 13-13
OCI_LOCK_X, 13-13
OCI_LOCK_X_NOWAIT, 13-13, 13-14
parameter usage, 13-13
OCI_LTYPE_ARG_FUNC list attribute, 6-19
OCI_LTYPE_ARG_PROC list attribute, 6-19
OCI_LTYPE_DB_SCH list attribute, 6-19
OCI_LTYPE_SCH_OBJ list attribute, 6-19
OCI_LTYPE_SUBPRG list attribute, 6-19
OCI_LTYPE_TYPE_ARG_FUNC list attribute, 6-19
OCI_LTYPE_TYPE_ARG_PROC list attribute, 6-19
OCI_LTYPE_TYPE_ATTR list attribute, 6-19
OCI_LTYPE_TYPE_METHOD list attribute, 6-19
OCI_MIGRATE, 8-12
OCI_NEED_DATA, 2-31
OCI_NEW_LENGTH_SEMANTICS, 15-10, 15-16
OCI_NLS_MAXBUFSZ, 16-185
OCI_NO_DATA, 2-31
OCI_NO_MUTEX, 9-4
OCI_NUM_SHARED_PROCS, 2-25
OCI_PIN_ANY, 13-7
OCI_PIN_LATEST, 13-7
OCI_PIN_RECENT, 13-7
OCI_PTYPE_ARG
attributes, 6-16
OCI_PTYPE_COL
attributes, 6-15
OCI_PTYPE_COLL
attributes, 6-12
OCI_PTYPE_DATABASE
attributes, 6-19
OCI_PTYPE_FUNC
attributes, 6-7
OCI_PTYPE_LIST
attributes, 6-18
OCI_PTYPE_PKG
attributes, 6-8
OCI_PTYPE_PROC
attributes, 6-7
OCI_PTYPE_SCHEMA
attributes, 6-19
OCI_PTYPE_SYN
attributes, 6-14
OCI_PTYPE_TABLE
attributes, 6-7
OCI_PTYPE_TYPE
attributes, 6-8
OCI_PTYPE_TYPE_ATTR
attributes, 6-10
OCI_PTYPE_TYPE_FUNC
attributes, 6-11
OCI_PTYPE_TYPE_PROC
attributes, 6-11
OCI_PTYPE_VIEW
attributes, 6-7
OCI_SESSRLS_RETAG, 15-45, 15-46
OCI_SHARED_MODE, 2-24
OCI_STILL_EXECUTING, 2-31, 2-41
OCI_STMT_SCROLLABLE_READONLY
attribute, 4-18
OCI_SUCCESS, 2-31, 8-8
OCI_SUCCESS_WITH_INFO, 2-31
OCI_THREADED, 9-3
OCI_TRANS_LOOSE, 8-5
OCI_TRANS_READONLY, 8-3, 8-11
OCI_TRANS_RESUME, 8-10
OCI_TRANS_SERIALIZABLE, 8-3
OCI_TRANS_TIGHT, 8-5
OCI_TRANS_TWOPHASE, 8-10
OCI_TYPECODE
values, 3-30, 3-32
OCI_UTF16ID, 2-49
OCIAnyDataAccess(), 20-12
OCIAnyDataAttrGet(), 20-14
OCIAnyDataAttrSet(), 20-17
OCIAnyDataBeginCreate(), 20-20
OCIAnyDataCollAddElem(), 20-22
OCIAnyDataCollGetElem(), 20-24
OCIAnyDataConvert(), 20-26
OCIAnyDataDestroy(), 20-28
OCIAnyDataEndCreate(), 20-29
OCIAnyDataGetCurrAttrNum(), 20-30
OCIAnyDataGetType(), 20-31
OCIAnyDataIsNull(), 20-32
OCIAnyDataSetAddInstance(), 20-35
OCIAnyDataSetBeginCreate(), 20-37
OCIAnyDataSetDestroy(), 20-39
OCIAnyDataSetEndCreate(), 20-40
OCIAnyDataSetGetCount(), 20-41
OCIAnyDataSetGetInstance(), 20-42
OCIAnyDataSetGetType(), 20-43
OCIAnyDataTypeCodeToSqlt, 11-35
OCIAnyDataTypeCodeToSqlt(), 20-33
OCIAQAgent
descriptor attributes, A-54
OCIAQDeq(), 16-90
OCIAQDeqOptions
descriptor attributes, A-47
OCIAQEnq(), 16-92
OCIAQEnqOptions
descriptor attributes, A-46
OCIAQListen(), 16-104
OCIAQMsgProperties
descriptor attributes, A-50
OCIArray, 11-21
binding and defining, 11-21, 11-41
OCIArray manipulation
code example, 11-23
OCIAttrGet(), 15-49
used for describing, 4-13
OCIAttrSet(), 15-51
OCIAuthInfo definition, 9-26
OCIAuthInfo handle attributes, A-19
OCIBindArrayOfStruct(), 15-67
OCIBindByName(), 15-68
OCIBindByPos(), 15-73
OCIBindDynamic(), 15-78
OCIBindObject(), 15-82
OCIBreak(), 16-180
use of, 2-38, 2-42
OCICacheFlush(), 17-9
OCICacheFree(), 17-50
OCICacheRefresh(), 17-11
OCICacheUnmark(), 17-17
OCICacheUnpin(), 17-51
OCICharSetConversionIsReplacementUsed(), 2-54
OCICharsetToUnicode(), 2-54
OCIColl, 11-21
binding and defining, 11-21
OCICollAppend(), 18-6
OCICollAssign(), 18-8
OCICollAssignElem(), 18-10
OCICollGetElem(), 18-12
OCICollIsLocator(), 18-15
OCICollMax(), 18-16
OCICollSize(), 18-17
OCICollTrim(), 18-19
OCIComplexObject
use of, 10-24
OCIComplexObjectComp
use of, 10-24
OCIConnectionPoolCreate(), 15-5
OCIConnectionPoolDestroy(), 15-8
OCIContextClearValue(), 19-20
OCIContextGenerateKey(), 19-21
OCIContextGetValue(), 19-19
OCIContextSetValue(), 19-17
OCIDate, 11-6
binding and defining, 11-6, 11-41
OCIDate manipulation
code example, 11-8
OCIDateAddDays(), 18-31
OCIDateAddMonths(), 18-32
OCIDateAssign(), 18-33
OCIDateCheck(), 18-34
OCIDateCompare(), 18-36
OCIDateDaysBetween(), 18-37
OCIDateFromText(), 18-38
OCIDateGetDate(), 18-40
OCIDateGetTime(), 18-41
OCIDateLastDay(), 18-42
OCIDateNextDay(), 18-43
OCIDateSetDate(), 18-44
OCIDateSetTime(), 18-45
OCIDateSysDate(), 18-46
OCIDateTimeAssign(), 18-49
OCIDateTimeCheck(), 18-50
OCIDateTimeCompare(), 18-52
OCIDateTimeConstruct(), 18-53
OCIDateTimeConvert(), 18-55
OCIDateTimeFromArray(), 18-56
OCIDateTimeFromText(), 18-58
OCIDateTimeGetDate(), 18-60
OCIDateTimeGetTime, 18-61
OCIDateTimeGetTime(), 18-61
OCIDateTimeGetTimeZoneName(), 18-63
OCIDateTimeGetTimeZoneOffset(), 18-64
OCIDateTimeIntervalAdd(), 18-65
OCIDateTimeIntervalSub(), 18-66
OCIDateTimeSubtract(), 18-67
OCIDateTimeSysTimeStamp(), 18-68
OCIDateTimeToArray(), 18-69
OCIDateToText(), 18-47
OCIDateZoneToZone(), 18-73
OCIDefineArrayOfStruct(), 15-84
OCIDefineByPos(), 15-85
OCIDefineDynamic(), 15-89
OCIDefineObject(), 15-92
OCIDescribeAny(), 15-94
usage examples, 6-23
using, 6-2
OCIDescriptorAlloc(), 15-53
OCIDescriptorFree(), 15-55
OCIDirPathAbort(), 16-116
OCIDirPathColArray context, 12-5
OCIDirPathColArrayEntryGet(), 16-117
OCIDirPathColArrayEntrySet(), 16-119
OCIDirPathColArrayReset(), 16-123
OCIDirPathColArrayRowGet(), 16-121
OCIDirPathColArrayToStream(), 16-124
OCIDirPathCtx context, 12-5
OCIDirPathDataSave(), 16-126
OCIDirPathFinish(), 16-127
OCIDirPathFlushRow(), 16-128
OCIDirPathFuncCtx, 12-5
OCIDirPathPrepare(), 16-131
OCIDirPathStream context, 12-5
OCIDirPathStreamLoad(), 16-129
OCIDirPathStreamReset(), 16-132
OCIDuration
use of, 13-8, 13-15
OCIDurationBegin(), 16-26, 19-10
OCIDurationEnd(), 16-28, 19-11
OCIEnvCreate(), 15-9
OCIEnvInit(), 15-12
OCIEnvNlsCreate(), 2-49, 15-14
OCIErrorGet(), 16-181
OCIExtProcAllocCallMemory(), 19-5
OCIExtProcGetEnv(), 19-8
OCIExtProcRaiseExcp(), 19-6
OCIExtProcRaiseExcpWithMsg(), 19-7
OCIExtractFromFile(), 19-29
OCIExtractFromList(), 19-37
OCIExtractFromStr(), 19-30
OCIExtractInit(), 19-23
OCIExtractReset(), 19-25
OCIExtractSetKey(), 19-27
OCIExtractSetNumKeys(), 19-26
OCIExtractTerm(), 19-24
OCIExtractToBool(), 19-32
OCIExtractToInt(), 19-31
OCIExtractToList(), 19-36
OCIExtractToOCINum(), 19-35
OCIFileClose(), 19-44
OCIFileExists(), 19-50
OCIFileInit(), 19-40
OCIFileRead(), 19-45
OCIFileSeek(), 19-48
OCIFileTerm(), 19-41
OCIFileWrite(), 19-47
OCIFormatInit(), 19-54
OCIFormatString(), 19-56
OCIFormatTerm(), 19-55
OCIHandleAlloc(), 15-57
OCIHandleFree(), 15-60
OCIInd
use of, 10-31
OCIInitialize(), 15-18
shared mode, 2-23
OCIIntervalAssign(), 18-76
OCIIntervalCheck(), 18-77
OCIIntervalCompare(), 18-79
OCIIntervalDivide(), 18-81
OCIIntervalFromNumber(), 18-82
OCIIntervalFromText(), 18-83
OCIIntervalFromTZ(), 18-85
OCIIntervalGetDaySecond(), 18-86
OCIIntervalGetYearMonth(), 18-88
OCIIntervalMultiply(), 18-89
OCIIntervalSetDaySecond(), 18-90
OCIIntervalSetYearMonth(), 18-92
OCIIntervalToText(), 18-95
OCIIter, 11-21
binding and defining, 11-21
usage example, 11-23
OCIIterCreate(), 18-20
OCIIterDelete(), 18-21
OCIIterGetCurrent(), 18-22
OCIIterInit(), 18-23
OCIIterNext(), 18-24
OCIIterPrev(), 18-26
OCILdaToSvcCtx(), 16-183
OCILobAppend(), 16-29
OCILobAssign(), 16-31
OCILobCharSet(), 16-33, 16-34
OCILobClose(), 16-35
OCILobCopy(), 16-37
OCILobCreateTemporary(), 16-39
OCILobDisableBuffering(), 16-41
OCILobEnableBuffering(), 16-42
OCILobErase(), 16-43
OCILobFileClose(), 16-45
OCILobFileCloseAll(), 16-46
OCILobFileExists(), 16-47
OCILobFileGetName(), 16-48
OCILobFileIsOpen(), 16-50
OCILobFileOpen(), 16-51
OCILobFileSetName(), 16-52
OCILobFlushBuffer(), 16-54
OCILobFreeTemporary(), 16-56
OCILobGetChunkSize(), 16-57
OCILobGetLength(), 16-59
OCILobIsEqual(), 16-61
OCILobIsOpen(), 16-62
OCILobIsTemporary(), 16-64
OCILobLoadFromFile(), 16-65
OCILobLocatorAssign(), 16-67
OCILobLocatorIsInit(), 16-69
OCILobOpen(), 16-71
OCILobRead(), 16-73
OCILobTrim(), 16-78
OCILobWrite(), 16-80
OCILobWriteAppend(), 16-85
OCILockOpt
possible values, 17-28, 17-56
OCILogoff(), 15-21
OCILogon(), 15-22
using, 2-26
OCILogon2(), 15-24
OCIMemoryAlloc(, 19-12
OCIMemoryFree(), 19-15
OCIMemoryResize(), 19-14
OCIMessageClose(), 2-54
OCIMessageGet(), 2-54
OCIMessageOpen(), 2-54
OCIMultiByteInSizeToWideChar(), 2-52
OCIMultiByteStrCaseConversion(), 2-53
OCIMultiByteStrcat(), 2-53
OCIMultiByteStrcmp(), 2-53
OCIMultiByteStrcpy(), 2-53
OCIMultiByteStrlen(), 2-53
OCIMultiByteStrncat(), 2-53
OCIMultiByteStrncmp(), 2-53
OCIMultiByteStrncpy(), 2-53
OCIMultiByteStrnDisplayLength(), 2-53
OCIMultiByteToWideChar(), 2-52
OCIMultiTransPrepare(), 16-168
OCINlsCharSetConvert(), 2-51
OCINlsCharSetIdToName(), 2-51
OCINlsCharSetNameToId(), 2-51
OCINlsEnvironmentVariableGet(), 16-185
OCINlsGetInfo(), 2-50, 2-51
OCINlsNameMap(), 2-51
OCINlsNumericInfoGet(), 2-51
OCINumber, 11-14
bind example, 11-43
binding and defining, 11-14, 11-41
define example, 11-43
OCINumber manipulation
code example, 11-17
OCINumberAbs(), 18-99
OCINumberAdd(), 18-100
OCINumberArcCos(), 18-101
OCINumberArcSin(), 18-102
OCINumberArcTan(), 18-103
OCINumberArcTan2(), 18-104
OCINumberAssign(), 18-105
OCINumberCeil(), 18-106
OCINumberCompare(), 18-107
OCINumberCos(), 18-108
OCINumberDec(), 18-109
OCINumberDiv(), 18-110
OCINumberExp(), 18-111
OCINumberFloor(), 18-112
OCINumberFromInt(), 18-113
OCINumberFromReal(), 18-114
OCINumberFromText(), 18-115
OCINumberHypCos(), 18-117
OCINumberHypSin(), 18-118
OCINumberHypTan(), 18-119
OCINumberInc(), 18-120
OCINumberIntPower(), 18-121
OCINumberIsInt(), 18-122
OCINumberIsZero(), 18-123
OCINumberLn(), 18-124
OCINumberLog(), 18-125
OCINumberMod(), 18-126
OCINumberMul(), 18-127
OCINumberNeg(), 18-128
OCINumberPower(), 18-129
OCINumberPrec(), 18-130
OCINumberRound(), 18-131
OCINumberSetPi(), 18-132
OCINumberSetZero(), 18-133
OCINumberShift(), 18-134
OCINumberSign(), 18-135
OCINumberSin(), 18-136
OCINumberSqrt(), 18-137
OCINumberSub(), 18-138
OCINumberTan(), 18-139
OCINumberToInt(), 18-140
OCINumberToReal(), 18-141
OCINumberToText(), 18-142
OCINumberTrunc(), 18-144
OCIObjectArrayPin(), 17-52
OCIObjectCopy(), 17-33
OCIObjectExists(), 17-25
OCIObjectFlush(), 17-13
OCIObjectFree(), 17-54
OCIObjectGetAttr(), 17-35
OCIObjectGetInd(), 17-37
OCIObjectGetObjectRef(), 17-38
OCIObjectGetTypeRef(), 17-39
OCIObjectIsDirty(), 17-30
OCIObjectIsLocked(), 17-31
OCIObjectLifetime
possible values, 17-27
OCIObjectLock(), 17-40
OCIObjectLockNoWait(), 17-41
OCIObjectMarkDelete(), 17-18
OCIObjectMarkDeleteByRef(), 17-19
OCIObjectMarkStatus
possible values, 17-28
OCIObjectMarkUpdate(), 17-20
OCIObjectNew(), 17-43
OCIObjectPin(), 17-56
OCIObjectPinCountReset(), 17-59
OCIObjectPinTable(), 17-61
OCIObjectRefresh(), 17-14
OCIObjectSetAttr(), 17-47
OCIObjectUnmark(), 17-22
OCIObjectUnmarkByRef(), 17-23
OCIObjectUnpin(), 17-63
OCIParamGet(), 15-62
used for describing, 4-13
OCIParamSet(), 15-64
OCIPasswordChange(), 16-187
OCIPinOpt
use of, 13-7
OCIRaw, 11-20
binding and defining, 11-20, 11-41
OCIRaw manipulation
code example, 11-21
OCIRawAllocSize(), 18-146
OCIRawAssignBytes(), 18-147
OCIRawAssignRaw(), 18-148
OCIRawPtr(), 18-149
OCIRawResize(), 18-150
OCIRawSize(), 18-151
OCIRef, 11-27
binding and defining, 11-27
usage example, 11-28
OCIRefAssign(), 18-153
OCIRefClear(), 18-154
OCIRefFromHex(), 18-155
OCIRefHexSize(), 18-157
OCIRefIsEqual(), 18-158
OCIRefIsNull(), 18-159
OCIRefToHex(), 18-160
OCIReset(), 16-189
use of, 2-42
OCIRowid ROWID descriptor, 2-18
OCIRowidToChar(), 16-190
OCIServerAttach(), 15-27
shadow processes, 15-28
OCIServerDetach(), 15-30
OCIServerDNs descriptor attributes, A-55
OCIServerVersion(), 16-191
OCISessionBegin(), 15-31
OCISessionEnd(), 15-35
OCISessionGet(), 15-36
OCISessionPoolCreate(), 15-40
OCISessionPoolDestroy(), 15-44
OCISessionRelease(), 15-45
OCIStmtExecute(), 16-5
prefetch during, 4-7
use of iters parameter, 4-7
OCIStmtFetch(), 16-9
OCIStmtFetch2(), 4-19, 16-11
OCIStmtGetBindInfo(), 15-97
OCIStmtGetPieceInfo(), 16-14
OCIStmtPrepare()
preparing SQL statements, 4-4
shared mode, 2-24
OCIStmtPrepare2(), 16-18
OCIStmtRelease(), 16-20
OCIStmtSetPieceInfo(), 16-21
OCIString, 11-19
binding and defining, 11-19, 11-41
OCIString manipulation
code example, 11-19
OCIStringAllocSize(), 18-162
OCIStringAssign(), 18-163
OCIStringAssignText(), 18-164
OCIStringGetEncoding(), 18-165
OCIStringPtr(), 18-165
OCIStringResize(), 18-166
OCIStringSize(), 18-167
OCISubscriptionDisable(), 16-106
OCISubscriptionEnable(), 16-107
OCISubscriptionPost(), 16-108
OCISubscriptionRegister(), 16-110
OCISubscriptionUnRegister(), 16-113
OCISvcCtxToLda(), 16-192
OCITable, 11-21
binding and defining, 11-21, 11-41
OCITableDelete(), 18-169
OCITableExists(), 18-170
OCITableFirst(), 18-171
OCITableLast(), 18-172
OCITableNext(), 18-173
OCITablePrev(), 18-175
OCITableSize(), 18-177
OCITerminate(), 15-47
OCIThread package, 9-5
OCIThreadClose(), 16-135
OCIThreadCreate(), 16-136
OCIThreadHandleGet(), 16-138
OCIThreadHndDestroy(), 16-139
OCIThreadHndInit(), 16-140
OCIThreadIdDestroy(), 16-141
OCIThreadIdGet(), 16-142
OCIThreadIdInit(), 16-143
OCIThreadIdNull(), 16-144
OCIThreadIdSame(), 16-145
OCIThreadIdSet(), 16-146
OCIThreadIdSetNull(), 16-147
OCIThreadInit(), 16-148
OCIThreadIsMulti(), 16-149
OCIThreadJoin(), 16-150
OCIThreadKeyDestroy(), 16-151
OCIThreadKeyGet(), 16-152
OCIThreadKeyInit(), 16-153
OCIThreadKeySet(), 16-154
OCIThreadMutexAcquire(), 16-155
OCIThreadMutexDestroy(), 16-156
OCIThreadMutexInit(), 16-157
OCIThreadMutexRelease(), 16-158
OCIThreadProcessInit(), 16-159
OCIThreadTerm(), 16-160
OCITransCommit(), 16-162
OCITransDetach(), 16-165
OCITransForget(), 16-167
OCITransMultiPrepare(), 8-9
OCITransPrepare(), 16-169
OCITransRollback(), 16-170
OCITransStart(), 16-171
OCIType
description, 11-29
OCITypeAddAttr(), 20-5
OCITypeArrayByName(), 17-66
OCITypeArrayByRef(), 17-69
OCITypeBeginCreate(), 20-6
OCITypeByName(), 17-71
OCITypeByRef(), 17-74
OCITypeElem
description, 11-29
OCITypeEndCreate(), 20-8
OCITypeMethod
description, 11-29
OCITypeSetBuiltin(), 20-9
OCITypeSetCollection(), 20-10
OCIUnicodeToCharset(), 2-54
OCIUserCallbackGet(), 16-193
OCIUserCallbackRegister(), 16-195
OCIWideCharDisplayLength(), 2-53
OCIWideCharInSizeToMultiByte(), 2-52
OCIWideCharIsAlnum(), 2-53
OCIWideCharIsAlpha(), 2-53
OCIWideCharIsCntrl(), 2-53
OCIWideCharIsDigit(), 2-53
OCIWideCharIsGraph(), 2-54
OCIWideCharIsLower(), 2-54
OCIWideCharIsPrint(), 2-54
OCIWideCharIsPunct(), 2-54
OCIWideCharIsSingleByte(), 2-54
OCIWideCharIsSpace(), 2-54
OCIWideCharIsUpper(), 2-54
OCIWideCharIsXdigit(), 2-54
OCIWideCharMultibyteLength(), 2-53
OCIWideCharStrCaseConversion(), 2-53
OCIWideCharStrcat(), 2-52
OCIWideCharStrchr(), 2-52
OCIWideCharStrcmp(), 2-52
OCIWideCharStrcpy(), 2-52
OCIWideCharStrlen(), 2-52
OCIWideCharStrncat(), 2-52
OCIWideCharStrncmp(), 2-52
OCIWideCharStrncpy(), 2-52
OCIWideCharStrrchr(), 2-52
OCIWideCharToLower(), 2-52
OCIWideCharToMultiByte(), 2-52
OCIWideCharToUpper(), 2-52
OID. See object identifier
opaque, definition of, 1-2
optimistic locking
implementing, 13-14
Oracle Call Interface. See OCI
Oracle datatypes, 3-2
mapping to C, 11-2
oratypes.h
contents, 3-34
only supported means of supplying parameters to the OCI, 3-34
ORE. See object runtime environment
OTT
command line, 14-6
command line syntax, 14-27
creating types in the database, 14-5
datatypes mapping, 14-10
intype file, 14-34
outtype file, 14-21
overview, 14-2
parameters, 14-28
providing an intype file, 14-9
reference, 14-26
restriction, 14-42
using, 14-1
OTT initialization function
calling, 14-24
tasks of, 14-26
OTT parameter TRANSITIVE, 14-33
OTT parameter URL, 14-33
OTT parameters
CASE, 14-32
CODE, 14-30
CONFIG, 14-31
ERRTYPE, 14-31
HFILE, 14-31
INITFILE, 14-30
INITFUNC, 14-31
INTYPE, 14-29
OUTTYPE, 14-29
SCHEMA_NAMES, 14-33
USERID, 14-29
where they appear, 14-33
OTT. See object type translator
outtype file, 14-34
when running OTT, 14-21
OUTTYPE OTT parameter, 14-29

P

packages
attributes, 6-8
describing, 6-2
parameter descriptor, 2-18
attributes, 6-5, A-42
parameter descriptor object, 11-29
parameters
attributes, 6-5
buffer lengths, 15-3, 16-3
modes, 15-2, 16-2, 19-2
passing strings, 2-35
string length, 15-3, 16-3
partitioned fine grained access control, 8-17
password management, 8-11, 8-13
PDO. See parameter descriptor object
persistent objects, 10-5
meta-attributes, 10-18
piecewise fetch, 5-51
piecewise operations, 5-48
fetch, 5-45, 5-52
in PL/SQL, 5-51
insert, 5-45
update, 5-45
valid datatypes, 5-45
pin count, 10-30
pin duration
example, 13-15
of objects, 13-15
pinning, 13-7
pinning objects, 13-7
PL/SQL, 1-10
binding and defining nested tables, 5-44
binding and defining REF cursors, 5-44
binding placeholders, 2-44
defining output variables, 5-25
piecewise operations, 5-51
uses in OCI applications, 2-44
using in OCI applications, 2-44
using in OCI programs, 5-8
positioned, 2-39
deletes, 2-39
prefetching
during OCIStmtExecute(), 4-7
setting prefetch memory size, 4-17
setting row count, 4-17
prepare multiple branches in a single message, 8-9
procedures
attributes, 6-7
process
handle attributes, A-77
process handle, 2-13
proxy authentication, 8-21
publish-subscribe
_SYSTEM_TRIG_ENABLED parameter, 9-62
COMPATIBLE parameter, 9-55
example, 9-61
functions, 9-55
handle attributes, 9-56, A-57
LDAP registration, 9-58
notification callback, 9-60
notification feature, 9-53
subscription handle, 9-56
publish-subscribe functions, 16-89

Q

query
explicit describe, 4-14
query. See SQL query

R

RAW
external datatype, 3-15
REF
external datatype, 3-19
REF columns
direct path loading of, 12-24
REF cursors variables
binding and defining, 5-44
reference. See REFs
refreshing, 13-11
objects, 13-11
REFs
binding, 5-10, 11-37
cursor variables, binding, 5-17
defining, 5-22, 11-39
indicator variables for, 2-35, 2-37
retrieving from server, 10-11
registering
user callbacks, 9-32
relational functions, C-7
server round-trips, C-2
reserved namespaces, 2-40
reserved words, xlii, 2-40
result set, 4-17
resuming branches, 8-7
return values
navigational functions, 17-5
RETURNING clause
binding with, 5-31
error handling, 5-32
initializing variables, 5-32
using with OCI
with REFs, 5-32
rollback, 2-29
in object applications, 13-15
round-trips
See server round-trips
ROWID
external datatype, 3-20
logical, 3-6
Universal ROWID, 3-6
used for positioned updates and deletes, 2-39
ROWID descriptor, 2-18

S

sample programs, B-1
sb1
definition, 3-34
sb2
definition, 3-34
sb4
definition, 3-34
SCHEMA_NAMES OTT parameter, 14-33
usage, 14-38
schemas
attributes, 6-19
describing, 6-2
scrollable cursor
example, 4-19
scrollable cursors, 4-17
secondary memory
of object, 13-17
select-list
describing, 4-12
sequences
attributes, 6-14
describing, 6-2
server handle
attributes, A-15
description, 2-9
setting in service context, 2-10
server round-trips
cache functions, C-4
datatype mapping and manipulation functions, C-6
describe operation, C-6
LOB functions, C-3
object functions, C-4
relational functions, C-7
service context handle
attributes, A-12
description, 2-9
elements of, 2-9
session
migration, 8-12, 15-32
session management, 8-11, 8-14
session pool handle
attributes, A-25
session pooling, 9-24
tagging, 9-24
session pooling example, 9-29
session pooling, functionality, 9-24
shared data structures mode, 2-22
shared mode, 2-22
OCIInitialize(), 2-23
OCIStmtPrepare(), 2-24
using environmental variables, 2-24
skip parameters
for arrays of structures, 5-27
for standard arrays, 5-28
snapshot descriptor, 2-16
snapshots
executing against, 4-7
SQL query
binding placeholders. See bind operation
defining output variables, 4-15, 5-19, 11-38
defining output variables. See define operation
fetching results, 4-16
statement type, 1-9
SQL statements, 1-7
binding placeholders in, 4-6, 5-2, 11-36
determining type prepared, 4-4
executing, 4-7
preparing for execution, 4-4
processing, 4-2
types
control statements, 1-8
data definition language, 1-7
data manipulation language, 1-8
embedded SQL, 1-11
PL/SQL, 1-10
queries, 1-9
SQLCS_IMPLICIT, 5-35, 16-33, 16-76, 16-82, 16-87
SQLCS_NCHAR, 5-35, 16-33, 16-76, 16-83, 16-87
SQLT typecodes, 3-32
SQLT_NTY
bind example, 11-48
define example, 11-49
description, 3-19
pre-allocating object memory, 11-40
SQLT_REF
definition, 3-19
description, 3-19
statement caching, 9-29
code example, 9-31
statement handle
attributes, A-29
description, 2-10
stored functions
describing, 6-2
stored procedures
describing, 6-2
STRING
external datatype, 3-12
strings
passing as parameters, 2-35
structures
arrays of, 5-26
subscription handle, 2-12
attributes, A-57
Supporting UTF-16 Unicode in the OCI, 2-46, 2-50
supporting UTF-16 Unicode in the OCI, 2-51
sword
definition, 3-34
synonyms
attributes, 6-14
describing, 6-2

T

tables
attributes, 6-7
describing, 6-2
tagging
session pooling, 9-24, 15-39, 15-45
TDO
definition, 11-36
description, 11-29
obtaining, 11-29
type descriptor object. See TDO.
TDO. See type descriptor object
terminology
navigational functions, 17-3
used in this manual, 1-11
thread management functions, 16-133
thread safety, 9-2
advantages of, 9-2
and three-tier architectures, 9-2
basic concepts, 9-3
implementing with OCI, 9-3
mixing 7.x and 8.0 calls, 9-4
required OCI calls, 9-3
threads package, 9-5
three-tier architectures
and thread safety, 9-2
TIMESTAMP datatype, 3-23
TIMESTAMP WITH LOCAL TIME ZONEdatatype, 3-24
TIMESTAMP WITH TIME ZONEdatatype, 3-23
top-level memory
of object, 13-17
transaction handle
attributes, A-28
description, 2-10
transaction identifier, 8-4
transactional complexity
levels in OCI, 8-2
transactions
committing, 2-29
functions, 16-161
global, 8-3
branch states, 8-7
branches, 8-4
one-phase commit, 8-8
transactions identifier, 8-4
two-phase commit, 8-8
global examples, 8-9
initialization parameters, 8-11
local, 8-3
OCI functions for
transactions, 8-2
read-only, 8-3
rolling back, 2-29
serializable, 8-3
transient objects, 10-6
LOBs
attributes, 7-4
meta-attributes, 10-21
TRANSITIVE OTT parameter, 14-10, 14-16, 14-33
type attributes
attributes, 6-10
type descriptor object, 10-8, 11-29
type evolution, 10-42
object cache, 13-22
type functions
attributes, 6-11
type inheritance
OTT support, 14-17
type procedures
attributes, 6-11
type reference, 10-35
typecodes, 3-30
types
attributes, 6-8
describing, 6-2

U

ub1
definition, 3-34
ub2
definition, 3-34
ub4
definition, 3-34
Unicode
character set ID, A-39
character set Id, A-36
OCILobRead(), 16-77
OCILobWrite(), 16-84
Universal ROWID, 3-6
unmarking, 13-10
objects, 13-10
unpinning, 10-30, 13-8
objects, 13-8
UNSIGNED
external datatype, 3-16
updates, 2-39
piecewise, 5-45, 5-48
positioned, 2-39
upgrading
7.x to 8.0, 1-21
7.x to 8.0 OCI, 1-22
URL OTT parameter, 14-33
UROWID
Universal ROWID, 3-6
user memory
allocating, 2-19
user session handle
attributes, A-19
description, 2-10
setting in service context, 2-10
user-defined callback functions, 9-32
registering, 9-32
USERID OTT parameter, 14-29
utext
Unicode datatype, 5-43
UTF-16 data, sample code, 5-42

V

values, 10-5
in object applications, 10-7
VARCHAR
external datatype, 3-14
VARCHAR2
external datatype, 3-9
VARNUM
external datatype, 3-13
VARRAW
external datatype, 3-16
views
attributes, 6-7
describing, 6-2

W

with_context
argument to external procedure functions, 19-3

X

XA specification, 8-4
XID. See transaction identifier
xtramem_sz parameter
using, 2-19
Go to previous page
Oracle
Copyright © 1996, 2002 Oracle Corporation.
All Rights Reserved.
Go To Documentation Library
Home		 Go To Product List
Book List		 Go To Table Of Contents
Contents
Master Index
Feedback