List of Examples
List of Figures
List of Tables
Title and Copyright Information
Preface
- Audience
- Documentation Accessibility
- Related Documents
- Conventions
Changes in This Release for Oracle C++ Call Interface Programmer's Guide
- Changes in Oracle Database Release 18c Version 18.1
  - New Features
- Changes in Oracle Database 12c Release 2 (12.2.0.1)
  - New Features
1 Introduction to OCCI
- Overview of OCCI
- About Processing SQL Statements
- Overview of PL/SQL
- About Special OCCI/SQL Terms
- About Object Support
- About Additional Support
  - Building OCCI Demos
  - About OCCI on the Oracle Technology Network
2 Installation and Upgrading
- About Installing Oracle C++ Call Interface
- About Upgrading Considerations
- About Determining the Oracle Database Versions
  - Determining the Oracle Client Version During Compilation
  - About Determining the Oracle Client and Server Versions at Run Time
- About the Instant Client
- About Instant Client Light (English)
- About Using OCCI with Microsoft Visual C++
3 Accessing Oracle Database Using C++
- About Connecting to a Database
- About Pooling Connections
- About Executing SQL DDL and DML Statements
- About Types of SQL Statements in the OCCI Environment
- About Executing SQL Queries
- About Executing Statements Dynamically
  - About Statement Status Definitions
- About Using Larger Row Count and Error Code Range Data Types
  - Using Larger Row Count in SELECT Operations
  - Using Larger Row Count in INSERT, UPDATE, and DELETE Operations
- About Committing a Transaction
- Caching Statements
- About Handling Exceptions
  - About Handling Null and Truncated Data
4 Object Programming
- Overview of Object Programming
- About Working with Objects in C++ with OCCI
- About Representing Objects in C++ Applications
  - Creating Persistent and Transient Objects
  - Creating Object Representations using the OTT Utility
- About Developing a C++ Application using OCCI
  - Developing Basic Object Program Structure
  - About Basic Object Operational Flow
- Migrating C++ Applications to Oracle Using OCCI
- Overview of Associative Access
  - Using SQL to Access Objects
  - Inserting and Modifying Values
- Overview of Navigational Access
- Overview of Complex Object Retrieval
  - Retrieving Complex Objects
  - About Prefetching Complex Objects
- Working with Collections
  - Fetching Embedded Objects
  - About Nullness
- About Using Object References
- About Deleting Objects from the Database
- About Type Inheritance
- A Sample OCCI Application
5 Data Types
- Overview of Oracle Data Types
  - About OCCI Type and Data Conversion
- Internal Data Types
  - Character Strings and Byte Arrays
  - Universal Rowid (UROWID)
- External Data Types
  - Description of External Data Types
    - BFILE
    - BDOUBLE
    - BFLOAT
    - BLOB
    - CHAR
    - CHARZ
    - CLOB
    - DATE
      - Example 1, 01-JUN-2000, 3:17PM:
      - Example 2, 01-JAN-4712 BCE:
    - FLOAT
    - INTEGER
    - INTERVAL DAY TO SECOND
    - INTERVAL YEAR TO MONTH
    - LONG
    - LONG RAW
    - LONG VARCHAR
    - LONG VARRAW
    - NCLOB
    - NUMBER
    - OCCI BFILE
    - OCCI BLOB
    - OCCI BYTES
    - OCCI CLOB
    - OCCI DATE
    - OCCI INTERVALDS
    - OCCI INTERVALYM
    - OCCI NUMBER
    - OCCI POBJECT
    - OCCI REF
    - OCCI REFANY
    - OCCI STRING
    - OCCI TIMESTAMP
    - OCCI VECTOR
    - RAW
    - REF
    - ROWID
    - STRING
    - TIMESTAMP
    - TIMESTAMP WITH LOCAL TIME ZONE
    - TIMESTAMP WITH TIME ZONE
    - UNSIGNED INT
    - VARCHAR
    - VARCHAR2
    - VARNUM
    - VARRAW
    - NATIVE DOUBLE
    - NATIVE FLOAT
- Data Conversions
  - Data Conversions for LOB Data Types
  - Data Conversions for Date, Timestamp, and Interval Data Types
6 Metadata
- Overview of Metadata
- Using Identity Column Metadata
- About Describing Database Metadata
  - Using Metadata (Code Examples)
- Attribute Reference Information
7 Programming with LOBs
- Overview of LOBs
- Creating LOBs in OCCI Applications
- Restricting the Opening and Closing of LOBs
- About Reading and Writing LOBs
- Using Objects with LOB Attributes
- About Using SecureFiles
8 Object Type Translator Utility
- Overview of the Object Type Translator Utility
- Using the OTT Utility
- Creating Types in the Database
- About Invoking the OTT Utility
- About Using the INTYPE File
- Using OTT Utility Data Type Mappings
  - Default Name Mapping
- Overview of the OUTTYPE File
- Using the OTT Utility and OCCI Applications
- Generating C++ Classes Generated by the OTT Utility
9 Globalization and Unicode Support
- Overview of Globalization and Unicode Support
- Specifying Charactersets
- Data Types for Globalization and Unicode Support
- About Using Objects and OTT Support
10 Oracle Streams Advanced Queuing
- Overview of Oracle Streams Advanced Queuing
- About AQ Implementation in OCCI
  - Message
  - Agent
  - Producer
  - Consumer
  - Listener
  - Subscription
- About Creating Messages
  - About Message Payloads
  - Message Properties
- Enqueuing Messages
- Dequeuing Messages
  - About Dequeuing Options
- Listening for Messages
- About Registering for Notification
  - Publish-Subscribe Notifications
    - How to Use Direct Registration
    - Using Open Registration
  - About Notification Callback
- About Message Format Transformation
11 Oracle XA Library
- Developing Applications with XA and OCCI
- APIs for XA Support
12 Optimizing Performance of C++ Applications
- About Transparent Application Failover
- About Connection Sharing
- About Application-Managed Data Buffering
  - Using the setDataBuffer() Method
  - Using the executeArrayUpdate() Method
- Using the Array Fetch Using next() Method
- Modifying Rows Iteratively
- About Using Oracle Connection Manager in Traffic Director Mode
- About Run-time Load Balancing of the Stateless Connection Pool
  - API Support
- About Fault Diagnosability
- Using Client Result Cache
- About Client-Side Deployment Parameters and Auto Tuning
13 OCCI Application Programming Interface
- OCCI Classes and Methods
  - Using OCCI Classes
  - OCCI Support for Windows NT and z/OS
    - Working with Collections of Refs
      - ResultSet Class
      - Statement Class
- Common OCCI Constants
- Agent Class
  - Agent()
  - getAddress()
  - getName()
  - getProtocol()
  - isNull()
  - operator=()
  - setAddress()
  - setName()
  - setNull()
  - setProtocol()
- AnyData Class
  - AnyData()
  - getAsBDouble()
  - getAsBfile()
  - getAsBFloat()
  - getAsBytes()
  - getAsDate()
  - getAsIntervalDS()
  - getAsIntervalYM()
  - getAsNumber()
  - getAsObject()
  - getAsRef()
  - getAsString()
  - getAsTimestamp()
  - getType()
  - isNull()
  - setFromBDouble()
  - setFromBfile()
  - setFromBFloat()
  - setFromBytes()
  - setFromDate()
  - setFromIntervalDS()
  - setFromIntervalYM()
  - setFromNumber()
  - setFromObject()
  - setFromRef()
  - setFromString()
  - setFromTimestamp()
  - setNull()
- BatchSQLException Class
  - getException()
  - getFailedRowCount()
  - getRowNum()
- Bfile Class
  - Bfile()
  - close()
  - closeStream()
  - fileExists()
  - getDirAlias()
  - getFileName()
  - getStream()
  - getUStringDirAlias()
  - getUStringFileName()
  - isInitialized()
  - isNull()
  - isOpen()
  - length()
  - open()
  - operator=()
  - operator==()
  - operator!=()
  - read()
  - setName()
  - setNull()
- Blob Class
  - Blob()
  - append()
  - close()
  - closeStream()
  - copy()
  - getChunkSize()
  - getContentType()
  - getOptions()
  - getStream()
  - isInitialized()
  - isNull()
  - isOpen()
  - length()
  - open()
  - operator=()
  - operator==()
  - operator!= ()
  - read()
  - setContentType()
  - setEmpty()
  - setNull()
  - setOptions()
  - trim()
  - write()
  - writeChunk()
- Bytes Class
  - Bytes()
  - byteAt()
  - getBytes()
  - isNull()
  - length()
  - operator=()
  - setNull()
- Clob Class
  - Clob()
  - append()
  - close()
  - closeStream()
  - copy()
  - getCharSetForm()
  - getCharSetId()
  - getCharSetIdUString()
  - getChunkSize()
  - getContentType()
  - getOptions()
  - getStream()
  - isInitialized()
  - isNull()
  - isOpen()
  - length()
  - open()
  - operator=()
  - operator==()
  - operator!=()
  - read()
  - setCharSetId()
  - setCharSetIdUString()
  - setCharSetForm()
  - setContentType()
  - setEmpty()
  - setNull()
  - setOptions()
  - trim()
  - write()
  - writeChunk()
- Connection Class
  - changePassword()
  - commit()
  - createStatement()
  - flushCache()
  - getClientCharSet()
  - getClientCharSetUString()
  - getClientNCHARCharSet()
  - getClientNCHARCharSetUString()
  - getClientVersion()
  - getLTXID()
  - getMetaData()
  - getOCIServer()
  - getOCIServiceContext()
  - getOCISession()
  - getServerVersion()
  - getServerVersionUString()
  - getStmtCacheSize()
  - getTag()
  - isCached()
  - pinVectorOfRefs()
  - postToSubscriptions()
  - readVectorOfBfiles()
  - readVectorOfBlobs()
  - readVectorOfClobs()
  - registerSubscriptions()
  - rollback()
  - setStmtCacheSize()
  - setTAFNotify()
  - terminateStatement()
  - unregisterSubscription()
  - writeVectorOfBlobs()
  - writeVectorOfClobs()
- ConnectionPool Class
  - createConnection()
  - createProxyConnection()
  - getBusyConnections()
  - getIncrConnections()
  - getMaxConnections()
  - getMinConnections()
  - getOpenConnections()
  - getPoolName()
  - getStmtCacheSize()
  - getTimeOut()
  - setErrorOnBusy()
  - setPoolSize()
  - setStmtCacheSize()
  - setTimeOut()
  - terminateConnection()
- Consumer Class
  - Consumer()
  - getConsumerName()
  - getCorrelationId()
  - getDequeueMode()
  - getMessageIdToDequeue()
  - getPositionOfMessage()
  - getQueueName()
  - getTransformation()
  - getVisibility()
  - getWaitTime()
  - isNull()
  - operator=()
  - receive()
  - setAgent()
  - setConsumerName()
  - setCorrelationId()
  - setDequeueMode()
  - setMessageIdToDequeue()
  - setNull()
  - setPositionOfMessage()
  - setQueueName()
  - setTransformation()
  - setVisibility()
  - setWaitTime()
- Date Class
  - Date()
  - addDays()
  - addMonths()
  - daysBetween()
  - fromBytes()
  - fromText()
  - getDate()
  - getSystemDate()
  - isNull()
  - lastDay()
  - nextDay()
  - operator=()
  - operator==()
  - operator!=()
  - operator>()
  - operator>=()
  - operator<()
  - operator<=()
  - setDate()
  - setNull()
  - toBytes()
  - toText()
  - toZone()
- Environment Class
  - createConnection()
  - createConnectionPool()
  - createEnvironment()
  - createStatelessConnectionPool()
  - enableSubscription()
  - disableSubscription()
  - getCacheMaxSize()
  - getCacheOptSize()
  - getCacheSortedFlush()
  - getCurrentHeapSize()
  - getLDAPAdminContext()
  - getLDAPAuthentication()
  - getLDAPHost()
  - getLDAPPort()
  - getMap()
  - getNLSLanguage()
  - getNLSTerritory()
  - getOCIEnvironment()
  - getXAConnection()
  - getXAEnvironment()
  - releaseXAConnection()
  - releaseXAEnvironment()
  - setCacheMaxSize()
  - setCacheOptSize()
  - setCacheSortedFlush()
  - setLDAPAdminContext()
  - setLDAPAuthentication()
  - setLDAPHostAndPort()
  - setLDAPLoginNameAndPassword()
  - setNLSLanguage()
  - setNLSTerritory()
  - terminateConnection()
  - terminateConnectionPool()
  - terminateEnvironment()
  - terminateStatelessConnectionPool()
- IntervalDS Class
  - IntervalDS()
  - fromText()
  - fromUText()
  - getDay()
  - getFracSec()
  - getHour()
  - getMinute()
  - getSecond()
  - isNull()
  - operator*()
  - operator*=()
  - operator=()
  - operator==()
  - operator!=()
  - operator/()
  - operator/=()
  - operator>()
  - operator>=()
  - operator<()
  - operator<=()
  - operator-()
  - operator-=()
  - operator+()
  - operator+=()
  - set()
  - setNull()
  - toText()
  - toUText()
- IntervalYM Class
  - IntervalYM()
  - fromText()
  - fromUText()
  - getMonth()
  - getYear()
  - isNull()
  - operator*()
  - operator*=()
  - operator=()
  - operator==()
  - operator!=()
  - operator/()
  - operator/=()
  - operator>()
  - operator>=()
  - operator<()
  - operator<=()
  - operator-()
  - operator-=()
  - operator+()
  - operator+=()
  - set()
  - setNull()
  - toText()
  - toUText()
- Listener Class
  - Listener()
  - getAgentList()
  - getTimeOutForListen()
  - listen()
  - setAgentList()
  - setTimeOutForListen()
- Map Class
  - put()
- Message Class
  - Message()
  - getAnyData()
  - getAttemptsToDequeue()
  - getBytes()
  - getCorrelationId()
  - getDelay()
  - getExceptionQueueName()
  - getExpiration()
  - getMessageEnqueuedTime()
  - getMessageState()
  - getObject()
  - getOriginalMessageId()
  - getPayloadType()
  - getPriority()
  - getSenderId()
  - isNull()
  - operator=()
  - setAnyData()
  - setBytes()
  - setCorrelationId()
  - setDelay()
  - setExceptionQueueName()
  - setExpiration()
  - setNull()
  - setObject()
  - setOriginalMessageId()
  - setPriority()
  - setRecipientList()
  - setSenderId()
- MetaData Class
  - MetaData()
  - getAttributeCount()
  - getAttributeId()
  - getAttributeType()
  - getBoolean()
  - getInt()
  - getMetaData()
  - getNumber()
  - getRef()
  - getString()
  - getTimeStamp()
  - getUInt()
  - getUString()
  - getVector()
  - operator=()
- NotifyResult Class
  - getConsumerName()
  - getMessage()
  - getMessageId()
  - getPayload()
  - getQueueName()
- Number Class
  - Number()
  - abs()
  - arcCos()
  - arcSin()
  - arcTan()
  - arcTan2()
  - ceil()
  - cos()
  - exp()
  - floor()
  - fromBytes()
  - fromText()
  - hypCos()
  - hypSin()
  - hypTan()
  - intPower()
  - isNull()
  - ln()
  - log()
  - operator++()
  - operator--()
  - operator*()
  - operator/()
  - operator%()
  - operator+()
  - operator-()
  - operator-()
  - operator<()
  - operator<=()
  - operator>()
  - operator>=()
  - operator==()
  - operator!=()
  - operator=()
  - operator*=()
  - operator/=()
  - operator%=()
  - operator+=()
  - operator-=()
  - operator char()
  - operator signed char()
  - operator double()
  - operator float()
  - operator int()
  - operator long()
  - operator long double()
  - operator short()
  - operator unsigned char()
  - operator unsigned int()
  - operator unsigned long()
  - operator unsigned short()
  - power()
  - prec()
  - round()
  - setNull()
  - shift()
  - sign()
  - sin()
  - squareroot()
  - tan()
  - toBytes()
  - toText()
  - trunc()
- PObject Class
  - PObject()
  - flush()
  - getConnection()
  - getRef()
  - getSQLTypeName()
  - isLocked()
  - isNull()
  - lock()
  - markDelete()
  - markModified()
  - operator=()
  - operator delete()
  - operator new()
  - pin()
  - setNull()
  - unmark()
  - unpin()
- Producer Class
  - Producer()
  - getQueueName()
  - getRelativeMessageId()
  - getSequenceDeviation()
  - getTransformation()
  - getVisibility()
  - isNull()
  - operator=()
  - send()
  - setNull()
  - setQueueName()
  - setRelativeMessageId()
  - setSequenceDeviation()
  - setTransformation()
  - setVisibility()
- Ref Class
  - Ref()
  - clear()
  - getConnection()
  - isClear()
  - isNull()
  - markDelete()
  - operator->()
  - operator*()
  - operator==()
  - operator!=()
  - operator=()
  - ptr()
  - setLock()
  - setNull()
  - setPrefetch()
  - unmarkDelete()
- RefAny Class
  - RefAny()
  - clear()
  - getConnection()
  - isNull()
  - markDelete()
  - operator=()
  - operator==()
  - operator!=()
  - unmarkDelete()
- ResultSet Class
  - cancel()
  - closeStream()
  - getBDouble()
  - getBfile()
  - getBFloat()
  - getBlob()
  - getBytes()
  - getCharSet()
  - getCharSetUString()
  - getClob()
  - getColumnListMetaData()
  - getCurrentStreamColumn()
  - getCurrentStreamRow()
  - getCursor()
  - getDatabaseNCHARParam()
  - getDate()
  - getDouble()
  - getFloat()
  - getInt()
  - getIntervalDS()
  - getIntervalYM()
  - getMaxColumnSize()
  - getNumArrayRows()
  - getNumber()
  - getObject()
  - getRef()
  - getRowid()
  - getRowPosition()
  - getStatement()
  - getStream()
  - getString()
  - getTimestamp()
  - getUInt()
  - getUString()
  - getVector()
  - getVectorOfRefs()
  - isNull()
  - isTruncated()
  - next()
  - preTruncationLength()
  - setBinaryStreamMode()
  - setCharacterStreamMode()
  - setCharSet()
  - setCharSetUString()
  - setDatabaseNCHARParam()
  - setDataBuffer()
  - setErrorOnNull()
  - setErrorOnTruncate()
  - setPrefetchMemorySize()
  - setPrefetchRowCount()
  - setMaxColumnSize()
  - status()
- SQLException Class
  - SQLException()
  - getErrorCode()
  - getMessage()
  - getNLSMessage()
  - getNLSUStringMessage()
  - getUStringMessage()
  - getXAErrorCode()
  - isRecoverable()
  - setErrorCtx()
  - what()
- StatelessConnectionPool Class
  - getAnyTaggedConnection()
  - getAnyTaggedProxyConnection()
  - getBusyConnections()
  - getBusyOption()
  - getConnection()
  - getIncrConnections()
  - getMaxConnections()
  - getMinConnections()
  - getOpenConnections()
  - getPoolName()
  - getProxyConnection()
  - getStmtCacheSize()
  - getTimeOut()
  - releaseConnection()
  - setBusyOption()
  - setPoolSize()
  - setTimeOut()
  - setStmtCacheSize()
  - terminateConnection()
- Statement Class
  - addIteration()
  - closeResultSet()
  - closeStream()
  - disableCaching()
  - execute()
  - executeArrayUpdate()
  - executeQuery()
  - executeUpdate()
  - getAutoCommit()
  - getBatchErrorMode()
  - getBDouble()
  - getBfile()
  - getBFloat()
  - getBlob()
  - getBytes()
  - getCharSet()
  - getCharSetUString()
  - getClob()
  - getConnection()
  - getCurrentIteration()
  - getCurrentStreamIteration()
  - getCurrentStreamParam()
  - getCursor()
  - getDatabaseNCHARParam()
  - getDate()
  - getDMLRowCounts()
  - getDouble()
  - getFloat()
  - getInt()
  - getIntervalDS()
  - getIntervalYM()
  - getMaxIterations()
  - getMaxParamSize()
  - getNumber()
  - getObject()
  - getOCIStatement()
  - getRef()
  - getResultSet()
  - getRowCountsOption()
  - getRowid()
  - getSQL()
  - getSQLUString()
  - getStream()
  - getString()
  - getTimestamp()
  - getUb8RowCount()
  - getUInt()
  - getUpdateCount()
  - getUString()
  - getVector()
  - getVectorOfRefs()
  - isNull()
  - isTruncated()
  - preTruncationLength()
  - registerOutParam()
  - setAutoCommit()
  - setBatchErrorMode()
  - setBDouble()
  - setBfile()
  - setBFloat()
  - setBinaryStreamMode()
  - setBlob()
  - setBytes()
  - setCharacterStreamMode()
  - setCharSet()
  - setCharSetUString()
  - setClob()
  - setDate()
  - setDatabaseNCHARParam()
  - setDataBuffer()
  - setDataBufferArray()
  - setDouble()
  - setErrorOnNull()
  - setErrorOnTruncate()
  - setFloat()
  - setInt()
  - setIntervalDS()
  - setIntervalYM()
  - setMaxIterations()
  - setMaxParamSize()
  - setNull()
  - setNumber()
  - setObject()
  - setPrefetchMemorySize()
  - setPrefetchRowCount()
  - setRef()
  - setRowCountsOption()
  - setRowid()
  - setSQL()
  - setSQLUString()
  - setString()
  - setTimestamp()
  - setUInt()
  - setUString()
  - setVector()
  - setVectorOfRefs()
  - status()
- Stream Class
  - readBuffer()
  - readLastBuffer()
  - writeBuffer()
  - writeLastBuffer()
  - status()
- Subscription Class
  - Subscription()
  - getCallbackContext()
  - getDatabaseServersCount()
  - getDatabaseServerNames()
  - getNotifyCallback()
  - getPayload()
  - getSubscriptionName()
  - getSubscriptionNamespace()
  - getRecipientName()
  - getPresentation()
  - getProtocol()
  - isNull()
  - operator=()
  - setCallbackContext()
  - setDatabaseServerNames()
  - setNotifyCallback()
  - setNull()
  - setPayload()
  - setPresentation()
  - setProtocol()
  - setSubscriptionName()
  - setSubscriptionNamespace()
  - setRecipientName()
- Timestamp Class
  - Timestamp()
  - fromText()
  - getDate()
  - getTime()
  - getTimeZoneOffset()
  - intervalAdd()
  - intervalSub()
  - isNull()
  - operator=()
  - operator==()
  - operator!=()
  - operator>()
  - operator>=()
  - operator<()
  - operator<=()
  - setDate()
  - setNull()
  - setTime()
  - setTimeZoneOffset()
  - subDS()
  - subYM()
  - toText()
Index