Skip Headers
Oracle® C++ Call Interface Programmer's Guide,
11g Release 1 (11.1)

B28390-07
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Index
Index
Go to Master Index
Master Index
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

OCCI Classes and Methods

Table 13-1 provides a brief description of all the OCCI classes. This section is followed by detailed descriptions of each class and its methods.

Table 13-1 Summary of OCCI Classes

Class Description

Agent Class

Represents an agent in the Advanced Queuing context.

AnyData Class

Provides methods for the Object Type Translator (OTT) utility, read and write SQL methods for linearization of objects, and conversions to and from other data types.

BatchSQLException Class

Provides methods for handling batch processing errors; extends the SQLException Class.

Bfile Class

Provides access to a SQL BFILE value.

Blob Class

Provides access to a SQL BLOB value.

 

Bytes Class

Examines individual bytes of a sequence for comparing bytes, searching bytes, and extracting bytes.

Clob Class

Provides access to a SQL CLOB value.

 

Connection Class

Represents a connection with a specific database.

ConnectionPool Class

Represents a connection pool with a specific database.

Consumer Class

Supports dequeuing of Messages and controls the dequeuing options.

Date Class

Specifies abstraction for SQL DATE data items. Also provides formatting and parsing operations to support the OCCI escape syntax for date values.

Environment Class

Provides an OCCI environment to manager memory and other resources of OCCI objects. An OCCI driver manager maps to an OCCI environment handle.

IntervalDS Class

Represents a period of time in terms of days, hours, minutes, and seconds.

IntervalYM Class

Represents a period of time in terms of year and months.

Listener Class

Listens on behalf of one or more agents on one or more queues.

Map Class

Used to store the mapping of the SQL structured type to C++ classes.

Message Class

A unit that is enqueued or dequeued.

MetaData Class

Used to determine types and properties of columns in a ResultSet, that of existing schema objects in the database, or the database as a whole.

NotifyResult Class

Used to hold notification information from the Streams AQ callback function.

Number Class

Models the numerical data type.

PObject Class

When defining types, enables specification of persistent or transient instances. Class instances derived from PObject can be either persistent or transient. If persistent, a class instance derived from PObject inherits from the PObject class; if transient, there is no inheritance.

Producer Class

Supports enqueuing options and enqueues Messages.

Ref Class

The mapping in C++ for the SQL REF value, which is a reference to a SQL structured type value in the database.

RefAny Class

The mapping in C++ for the SQL REF value, which is a reference to a SQL structured type value in the database.

ResultSet Class

Provides access to a table of data generated by executing an OCCI Statement.

SQLException Class

Provides information on database access errors.

StatelessConnectionPool Class

Represents a pool of stateless, authenticated connections to the database.

Statement Class

Used for executing SQL statements, including both query statements and insert / update / delete statements.

Stream Class

Used to provide streamed data (usually of the LONG data type) to a prepared DML statement or stored procedure call.

Subscription Class

Encapsulates the information and operations necessary for registering a subscriber for notification.

Timestamp Class

Specifies abstraction for SQL TIMESTAMP data items. Also provides formatting and parsing operations to support the OCCI escape syntax for time stamp values.



Using OCCI Classes

OCCI classes are defined in the oracle::occi namespace. An OCCI class name within the oracle::occi namespace can be referred to in one of three ways:

Using Scope Resolution Operator for OCCI

The scope resolution operator (::) is used to explicitly specify the oracle::occi namespace and the OCCI class name. To declare myConnection, a Connection object, using the scope resolution operator, you would use the following syntax:

oracle::occi::Connection myConnection;

Using Declaration in OCCI

The using declaration is used when the OCCI class name can be used in a compilation unit without conflict. To declare the OCCI class name in the oracle::occi namespace, you would use the following syntax:

using oracle::occi::Connection;

Connection now refers to oracle::occi::Connection, and myConnection can be declared as Connection myConnection;.

Using Directive in OCCI

The using directive is used when all OCCI class names can be used in a compilation unit without conflict. To declare all OCCI class names in the oracle::occi namespace, you would use the following syntax:

using oracle::occi;

Then, just as with the using declaration, the following declaration would now refer to the OCCI class Connection as Connection myConnection;.

Using Advanced Queuing in OCCI

The Advanced Queuing classes Producer, Consumer, Message, Agent, Listener, Subscription and NotifyResult are defined in oracle::occi::aq namespace.


OCCI Support for Windows NT and z/OS

When building OCCI application on Windows, a preprocessor definition for WIN32COMMON has to be added.

The following global methods are designed for accessing collections of Refs in ResultSet Class and Statement Class on Windows NT and z/OS. While method names changed, the number of parameters and their types remain the same.

Applications on Windows NT and z/OS should be calling these new methods only for retrieving and inserting collections of references. Applications not running on Windows NT or z/OS can use either set of accessors. However, Oracle recommends the use of the new methods for any vector operations with Refs.

Working with Collections of Refs

Collections of Refs can be fetched and inserted using methods of the following classes:

ResultSet Class

Fetching Collection of Refs Use the following version of getVectorOfRefs() to return a column of references:

void getVectorOfRefs(
   ResultSet  *rs,
   unsigned int index, 
   vector<Ref<T> > &vect);

Statement Class

Fetching Collection of Refs Use getVectorOfRefs() to return a collection of references from a column:

void getVectorOfRefs(
   Statement  *stmt,
   unsigned int index, 
   vector<Ref<T> > &vect);

Inserting a Collection of Refs Use setVectorOfRefs() to insert a collection of references into a column:

template  <class T>
void setVectorOfRefs(
   Statement *stmt, 
   unsigned int paramIndex,
   const vector<Ref<T> > &vect,
   const string &sqltype);

Inserting a Collection of Refs: Multibyte Support The following method should be used for multibyte support:

void setVectorOfRefs(
   Statement *stmt,
   unsigned int paramIndex,
   const vector<Ref<T> > &vect,
   const string &schemaName,
   const string &typeName);

Inserting a Collection of Refs: UString (UTF16) Support The following method should be used for UString support:

template <class T>
void setVectorOfRefs(
   Statement *stmt,
   unsigned int paramIndex,
   const vector<Ref<T> > &vect,
   const UString &schemaName,
   const UString &typeName);