Oracle C++ Call Interface Programmer's Guide -- Index

application-provided serialization, 2-26

associative access

overview, 3-13

atomic null, 3-24

attributes, 1-9

automatic serialization, 2-25

Bfile class, 8-5

methods, 8-5

BFILEs

datatype, 5-3

external datatype, 4-8

bind operations

in bind operations, 1-9

out bind operations, 1-9

Blob class, 8-12

methods, 8-12

BLOBs

datatype, 5-2

external datatype, 4-8

Bytes class, 8-23

methods, 8-23

callable statements, 2-10

with arrays as parameters, 2-11

CASE OTT parameter, 7-119

CHAR

external datatype, 4-8

classes

Bfile class, 8-5

Blob class, 8-12

Bytes class, 8-23

Clob class, 8-26

Connection class, 8-38

ConnectionPool class, 8-43

Date class, 8-49

Environment class, 8-62

IntervalDS class, 8-69

IntervalYM class, 8-81

Map class, 8-92

Metadata class, 8-94

Number class, 8-101

PObject class, 8-126

Ref class, 8-132

RefAny class, 8-139

ResultSet class, 2-14, 8-142

SQLException class, 8-165

Statement class, 8-167

Stream class, 8-211

Timestamp class, 8-214

Clob class, 8-26

methods, 8-26

CLOBs

datatype, 5-2

external datatype, 4-9

code

example programs, A-1

list of demonstration programs, A-1

CODE OTT parameter, 7-120

collections

working with, 3-22

committing a transaction, 2-20

complex object retrieval

complex object, 3-19

depth level, 3-19

implementing, 3-20

overview, 3-19

prefetch limit, 3-19

root object, 3-19

complex objects, 3-19

prefetching, 3-22

retrieving, 3-20

CONFIG OTT parameter, 7-121

configuration files

and the OTT utility, 7-10

connecting to a database, 2-2

Connection class, 8-38

methods, 8-38

connection pool

createConnectionPool method, 2-4

creating, 2-3, 2-4, 2-5

ConnectionPool class, 8-43

methods, 8-43

control statements, 1-6

copy semantics

internal LOBs, 5-2

data conversions

DATE datatype, 4-23

internal datatypes, 4-20, 4-21

INTERVAL datatypes, 4-23

LOB datatype, 4-22

TIMESTAMP datatypes, 4-23

data definition language (DDL) statements, 1-5

data manipulation language (DML) statements, 1-6

database

connecting to, 2-2

datatypes, 4-1

LOBs

external LOBs, 5-3

internal LOBs, 5-2

OTT mappings, 7-16

overview, 4-2

types

external datatypes, 4-2, 4-5

internal datatypes, 4-2, 4-3

DATE

external datatype, 4-9

data conversion, 4-23

Date class, 8-49

methods, 8-50

DDL statements

executing, 2-6

depth level, 3-19

DML statements, 1-6

executing, 2-6

embedded objects, 3-3

creating, 3-4

fetching, 3-23

prefetching, 3-23

Environment class, 8-62

methods, 8-62

error handling, 2-20

ERRTYPE OTT parameter, 7-121

executing SQL queries, 2-13

executing statements dynamically, 2-16

external datatypes, 4-5, 4-8

BFILE, 4-8

BLOB, 4-8

CHAR, 4-8

CHARZ, 4-9

CLOB, 4-9

DATE, 4-9

FLOAT, 4-11

INTEGER, 4-11

INTERVAL DAY TO SECOND, 4-11

INTERVAL YEAR TO MONTH, 4-12

LONG, 4-13

LONG RAW, 4-13

LONG VARCHAR, 4-13

LONG VARRAW, 4-13

NCLOB, 4-13

NUMBER, 4-13

OCCI BFILE, 4-14

OCCI BLOB, 4-14

OCCI BYTES, 4-15

OCCI CLOB, 4-15

OCCI DATE, 4-15

OCCI INTERVALDS, 4-15

OCCI INTERVALYM, 4-15

OCCI NUMBER, 4-15

OCCI POBJECT, 4-16

OCCI REF, 4-16

OCCI REFANY, 4-16

OCCI STRING, 4-16

OCCI TIMESTAMP, 4-16

OCCI VECTOR, 4-16

RAW, 4-16

REF, 4-17

ROWID, 4-17

STRING, 4-17

TIMESTAMP, 4-17

TIMESTAMP WITH LOCAL TIME ZONE, 4-18

TIMESTAMP WITH TIME ZONE, 4-18

UNSIGNED INT, 4-18

VARCHAR, 4-19

VARCHAR2, 4-19

VARNUM, 4-19

VARRAW, 4-20

external LOBs

BFILE, 5-3

FLOAT

external datatype, 4-11

freeing objects, 3-25

HFILE OTT parameter, 7-122

INITFILE OTT parameter, 7-122

INITFUNC OTT parameter, 7-122

INTEGER

external datatype, 4-11

internal datatypes, 4-3

CHAR, 4-4

LONG, 4-4

LONG RAW, 4-4

RAW, 4-4

VARCHAR2, 4-4

internal LOBs

BLOB, 5-2

CLOB, 5-2

NCLOB, 5-2

INTERVAL DAY TO SECOND

external datatype, 4-11

INTERVAL YEAR TO MONTH

external datatype, 4-12

IntervalDS class, 8-69

methods, 8-71

IntervalYM class, 8-81

methods, 8-82

INTYPE file

structure of, 7-127

INTYPE OTT parameter, 7-123

LOB locators

external LOBs, 5-4

internal LOBs, 5-4

LOBs

classes, 5-4, 5-5

closing, 5-8

copy semantics

internal LOBs, 5-2

creating, 5-7

datatypes

BFILE, 5-3

BLOB, 5-2

CLOB, 5-2

NCLOB, 5-2

external datatype

data conversion, 4-22

improving read and write performance, 5-14

using getChunckSize method, 5-15

using writeChunk method, 5-15

LOB locators, 5-3, 5-4

LOB value, 5-3

inline storage, 5-4

methods, 5-4, 5-5

nonstreamed read, 5-10

nonstreamed write, 5-12

opening, 5-8

overview, 5-2

reading, 5-10

reference semantics

external LOBs, 5-3

restrictions, 5-9

streamed read, 5-13

streamed write, 5-14

types

external LOBs, 5-3

internal LOBs, 5-2

updating, 5-15

writing, 5-10

LONG

external datatype, 4-13

LONG RAW

external datatype, 4-13

LONG VARCHAR

external datatype, 4-13

manipulating object attributes, 3-16

Map class, 8-92

methods, 8-92

metadata

argument and result attributes, 6-21

attribute groupings, 6-4

argument and result attributes, 6-4

collection attributes, 6-4

column attributes, 6-4

database attributes, 6-5

list attributes, 6-4

package attributes, 6-4

parameter attributes, 6-4

procedure, function, and subprogram attributes, 6-4

schema attributes, 6-4

sequence attributes, 6-4

synonym attributes, 6-4

table and view attributes, 6-4

type attribute attributes, 6-4

type attributes, 6-4

type method attributes, 6-4

attributes, 6-9

code example, 6-5

collection attributes, 6-17

column attributes, 6-20

database attributes, 6-24

describing database objects, 6-3

list attributes, 6-23

overview, 6-2

package attributes, 6-13

parameter attributes, 6-10

procedure, function, and subprogram attributes, 6-12

schema attributes, 6-24

sequence attributes, 6-19

synonym attributes, 6-19

table and view attributes, 6-11

type attribute attributes, 6-15

type attributes, 6-13

type methods attributes, 6-16

MetaData class, 8-94

methods, 8-96

methods, 1-9

Bfile methods, 8-5

Blob methods, 8-12

Bytes methods, 8-23

Clob methods, 8-26

Connection methods, 8-38

ConnectionPool methods, 8-43

createConnection method, 2-3

createConnectionPool method, 2-4

createEnvironment method, 2-3

createProxyConnection method, 2-5, 2-6

createStatement method, 2-6

Date methods, 8-50

Environment methods, 8-62

execute method, 2-6

executeArrayUpdate method, 2-7, 2-29

executeQuery method, 2-6

executeUpdate method, 2-6

IntervalDS methods, 8-71

IntervalYM methods, 8-82

Map methods, 8-92

MetaData methods, 8-96

Number methods, 8-104

PObject methods, 8-126

Ref methods, 8-132

RefAny methods, 8-139, 8-143

setDataBuffer method, 2-27

SQLException methods, 8-165

Statement methods, 8-167

Stream methods, 8-211

terminateConnection method, 2-3

terminateEnvironment method, 2-3

terminateStatement method, 2-8

Timestamp methods, 8-216

navigational access

overview, 3-14

NCLOBs

datatype, 5-2

external datatype, 4-13

NEEDS_STREAM_DATA status, 2-17, 2-19

nonreferenceable objects, 3-3

nonstreamed reads

LOBs, 5-10

nonstreamed writes

LOBs, 5-12

nullness, 3-24

NUMBER

external datatype, 4-13

Number class, 8-101

methods, 8-104

object cache, 3-10, 3-11

flushing, 3-11

object mode, 3-9

object programming

overview, 3-2

using OCCI, 3-1

object references

using, 3-24

see also REF

Object Type Translator utility

see OTT utility

object types, 1-9

objects

access using SQL, 3-13

attributes, 1-9

dirty, 3-17

flushing, 3-17

freeing, 3-24

in OCCI, 3-2

inserting, 3-14

manipulating attributes, 3-16

marking, 3-17

methods, 1-9

modifying, 3-14

object types, 1-9

pinned, 3-15

pinning, 3-11, 3-15

recording database changes, 3-17

with LOB attributes, 5-16

OCCI

advantages, 1-2

benefits, 1-2

functionality, 1-4

object mode, 3-9

overview, 1-2

special SQL terms, 1-8

OCCI classes

Bfile class, 8-5

Blob class, 8-12

Bytes class, 8-23

Clob class, 8-26

Connection class, 8-38

ConnectionPool class, 8-43

Data class, 8-49

Environment class, 8-62

IntervalDS class, 8-69

IntervalYM class, 8-81

Map class, 8-92

MetaData class, 8-94

Number class, 8-101

PObject class, 8-126

Ref class, 8-132

RefAny class, 8-139

ResultSet class, 8-142

SQLException class, 8-165

Statement class, 8-167

Stream class, 8-211

Timestamp class, 8-214

OCCI environment

connection pool, 2-3

creating, 2-2

opening a connection, 2-3

scope, 2-2

terminating, 2-2

OCCI program

example of, 3-29

OCCI program development, 3-7

operational flow, 3-8

program structure, 3-7

OCCI types

data conversion, 4-2

optimizing performance, 2-15, 2-27

setting prefetch count, 2-15

OTT parameter TRANSITIVE, 7-125

OTT parameters

CASE, 7-119

CODE, 7-120

CONFIG, 7-121

ERRTYPE, 7-121

HFILE, 7-122

INITFILE, 7-122

INITFUNC, 7-122

INTYPE, 7-123

OUTTYPE, 7-124

SCHEMA_NAMES, 7-124

USERID, 7-125

where they appear, 7-126

OTT utility

command line, 7-12

command line syntax, 7-117

creating types in the database, 7-10

default name mapping, 7-134

description, 1-11

parameters, 7-118 to 7-124

restriction, 7-135

using, 7-2

out bind variables, 1-7

OUTTYPE OTT parameter, 7-124

parameterized statements, 2-9

performance

optimizing, 2-27

array fetch using next method, 2-30

executeArrayUpdate method, 2-29

setDataBuffer method, 2-27

persistent objects, 3-2, 3-3

standalone objects, 3-3

types

embedded objects, 3-3

nonreferenceable objects, 3-3

referenceable objects, 3-3

standalone objects, 3-3

with LOB attributes, 5-16

pinning objects, 3-11, 3-15

PL/SQL

out bind variables, 1-7

overview, 1-7

PObject class, 8-126

methods, 8-126

prefetch count

set, 2-15

prefetch limit, 3-19

PREPARED status, 2-17

proxy connections, 2-5

using createProxyConnection method, 2-5

queries, 1-6

how to specify, 2-15

RAW

external datatype, 4-16

REF

external datatype, 4-17

retrieving a reference to an object, 3-15

Ref class, 8-132

methods, 8-132

RefAny class, 8-139

methods, 8-139, 8-143

reference semantics

external LOBs, 5-3

referenceable objects, 3-3

relational programming

using OCCI, 2-1

RESULT_SET_AVAILABLE status, 2-17, 2-18

ResultSet class, 2-14, 8-142

root object, 3-19

ROWID

external datatype, 4-17

SCHEMA_NAMES OTT parameter, 7-124

usage, 7-131

shared server environments

application-provided serialization, 2-26

automatic serialization, 2-25

concurrency, 2-26

thread safety, 2-23, 2-24

implementing, 2-24

using, 2-23

SQL statements

control statements, 1-6

DDL statements, 1-5

DML statements, 1-6

processing of, 1-5

queries, 1-6

types

callable statements, 2-8, 2-10

parameterized statements, 2-8, 2-9

standard statements, 2-8, 2-9

SQLException class, 8-165

methods, 8-165

standalone objects, 3-3

creating, 3-3

standard statements, 2-9

Statement class, 8-167

methods, 8-167

statement handles

creating, 2-6

reusing, 2-7

terminating, 2-8

status

NEEDS_STREAM_DATA, 2-17, 2-19

PREPARED, 2-17

RESULT_SET_AVAILABLE, 2-17, 2-18

STREAM_DATA_AVAILABLE, 2-17, 2-19

UNPREPARED, 2-17

UPDATE_COUNT_AVAILABLE, 2-17, 2-18

Stream class, 8-211

methods, 8-211

STREAM_DATA_AVAILABLE status, 2-17, 2-19

streamed reads, 2-12

LOBs, 5-13

streamed writes, 2-12

LOBs, 5-14

STRING

external datatype, 4-17

substitutability, 3-26

thread safety, 2-23, 2-24

implementing, 2-24

TIMESTAMP

external datatype, 4-17

Timestamp class

methods, 8-216

TIMESTAMP WITH LOCAL TIME ZONE

external datatype, 4-18

TIMESTAMP WITH TIME ZONE

external datatype, 4-18

transient objects, 3-2, 3-4

creating, 3-4

with LOB attributes, 5-17

TRANSITIVE OTT parameter, 7-22, 7-125

type inheritance, 3-25, 3-28

UNPREPARED status, 2-17

UNSIGNED INT

external datatype, 4-18

UPDATE_COUNT_AVAILABLE status, 2-17, 2-18

USERID OTT parameter, 7-125

values

in context of this document, 3-5

in object applications, 3-5

VARCHAR

external datatype, 4-19

VARCHAR2

external datatype, 4-19

VARNUM

external datatype, 4-19

VARRAW

external datatype, 4-13, 4-20