OCILIB (C and C++ Driver for Oracle)  4.1.0
ocilib Namespace Reference

OCILIB ++ Namespace. More...

Classes

class  Agent
 AQ identified agent for messages delivery. More...
 
class  BindInfo
 Provides SQL bind informations. More...
 
class  Collection
 Object identifying the SQL data types VARRAY and NESTED TABLE. More...
 
class  Column
 Encapsulate a Resultset column or object member properties. More...
 
class  Connection
 A connection or session with a specific database. More...
 
class  Date
 Object identifying the SQL data type DATE. More...
 
class  Dequeue
 Dequeue object for dequeuing messages into an Oracle Queue. More...
 
class  DirectPath
 Oracle Direct path loading encapsulation. More...
 
class  Enqueue
 Enqueue object for queuing messages into an Oracle Queue. More...
 
class  Enum
 Template Enum template class providing some type safety to some extends for manipulating enum variables. More...
 
class  Environment
 Static class in charge of library initialization / cleanup. More...
 
class  Event
 Subscription Event. More...
 
class  Exception
 Exception class handling all OCILIB errors. More...
 
class  File
 Object identifying the SQL data type BFILE. More...
 
class  Flags
 Template Flags template class providing some type safety to some extends for manipulating flags set variables. More...
 
class  HandleHolder
 Template class providing OCILIB handles auto memory, life cycle and scope management. More...
 
class  Interval
 Object identifying the SQL data type INTERVAL. More...
 
class  Lob
 Object identifying the SQL data type LOB (CLOB, NCLOB and BLOB) More...
 
class  Long
 Object identifying the SQL data type LONG. More...
 
class  Message
 AQ message. More...
 
class  Mutex
 Static class allowing managing mutexes. More...
 
class  Object
 Object identifying the SQL data type OBJECT. More...
 
class  Pool
 A connection or session Pool. More...
 
class  Queue
 Class allowing the administration of Oracle Queues. More...
 
class  QueueTable
 Class allowing the administration of Oracle Queue tables. More...
 
class  Reference
 Object identifying the SQL data type REF. More...
 
class  Resultset
 Database resultset. More...
 
class  Statement
 Object used for executing SQL or PL/SQL statement and returning the produced results. More...
 
class  Streamable
 Abstract class allowing derived classes to be compatible with any type supporting the operator << ocilib::ostring. More...
 
class  Subscription
 Subscription to database or objects changes. More...
 
class  Thread
 static class allowing to manipulate threads More...
 
class  ThreadKey
 Static class allowing to set/get thread local storage (TLS) values for a given unique key. More...
 
class  Timestamp
 Object identifying the SQL data type TIMESTAMP. More...
 
class  Transaction
 Oracle Transaction object. More...
 
class  TypeInfo
 Provides type information on Oracle Database objects. More...
 

Typedefs

typedef std::basic_string
< otext, std::char_traits
< otext >, std::allocator
< otext > > 
ostring
 string class wrapping the OCILIB otext * type and OTEXT() macros ( see Character sets ) More...
 
typedef void * AnyPointer
 Alias for the generic void pointer.
 
typedef std::vector< unsigned
char > 
Raw
 C++ counterpart of SQL RAW data type.
 
typedef OCI_MutexMutexHandle
 Alias for an OCI_Mutex pointer.
 
typedef OCI_ThreadThreadHandle
 Alias for an OCI_Thread pointer.
 
typedef const void * ThreadId
 Thread Unique ID.
 
typedef void * CallbackPointer
 Alias used for storing user callback method pointers.
 
typedef Enum< OracleVersionValuesOracleVersion
 Oracle Version. More...
 
typedef Enum< DataTypeValuesDataType
 Column data type. More...
 
typedef Enum< NumericTypeValuesNumericType
 Numeric data type. More...
 
typedef Enum< CharsetFormValuesCharsetForm
 Type of charsetForm. More...
 
typedef Enum< SeekModeValuesSeekMode
 Seek Modes. More...
 
typedef Enum< OpenModeValuesOpenMode
 Open Modes. More...
 
typedef Enum< LobTypeValuesLobType
 Type of Lob. More...
 
typedef Enum< LongTypeValuesLongType
 Type of Long. More...
 
typedef Enum< FormatTypeValuesFormatType
 Format type. More...
 
typedef Lob< ostring,
LobCharacter > 
Clob
 Class handling CLOB oracle type. More...
 
typedef Lob< ostring,
LobNationalCharacter > 
NClob
 Class handling NCLOB oracle type. More...
 
typedef Lob< Raw, LobBinary > Blob
 Class handling BLOB oracle type. More...
 
typedef Long< ostring,
LongCharacter > 
Clong
 Class handling LONG oracle type. More...
 
typedef Long< Raw, LongBinary > Blong
 Class handling LONG RAW oracle type. More...
 

Enumerations

enum  OracleVersionValues
 Oracle Version enumerated values.
 
enum  DataTypeValues {
  TypeNumeric = OCI_CDT_NUMERIC, TypeDate = OCI_CDT_DATETIME, TypeString = OCI_CDT_TEXT, TypeLong = OCI_CDT_LONG,
  TypeStatement = OCI_CDT_CURSOR, TypeLob = OCI_CDT_LOB, TypeFile = OCI_CDT_FILE, TypeTimestamp = OCI_CDT_TIMESTAMP,
  TypeInterval = OCI_CDT_INTERVAL, TypeRaw = OCI_CDT_RAW, TypeObject = OCI_CDT_OBJECT, TypeCollection = OCI_CDT_COLLECTION,
  TypeReference = OCI_CDT_REF
}
 Data type enumerated values. More...
 
enum  NumericTypeValues {
  NumericShort = OCI_NUM_SHORT, NumericInt = OCI_NUM_INT, NumericBigInt = OCI_NUM_BIGINT, NumericUnsignedShort = OCI_NUM_USHORT,
  NumericUnsignedInt = OCI_NUM_UINT, NumericUnsignedBigInt = OCI_NUM_BIGUINT, NumericDouble = OCI_NUM_DOUBLE, NumericFloat = OCI_NUM_FLOAT
}
 Numeric type enumerated values. More...
 
enum  CharsetFormValues { CharsetFormDefault = OCI_CSF_DEFAULT, CharsetFormNational = OCI_CSF_NATIONAL }
 Charset form enumerated values. More...
 
enum  SeekModeValues { SeekSet = OCI_SEEK_SET, SeekEnd = OCI_SEEK_END, SeekOffset = OCI_SEEK_CUR }
 Seek Modes enumerated values. More...
 
enum  OpenModeValues { ReadOnly = OCI_LOB_READONLY, ReadWrite = OCI_LOB_READWRITE }
 Open Modes enumerated values. More...
 
enum  LobTypeValues
 Lob types enumerated values.
 
enum  LongTypeValues
 Long types enumerated values.
 
enum  FormatTypeValues {
  FormatDate = OCI_FMT_DATE, FormatTimestamp = OCI_FMT_TIMESTAMP, FormatNumeric = OCI_FMT_NUMERIC, FormatBinaryDouble = OCI_FMT_BINARY_DOUBLE,
  FormatBinaryFloat = OCI_FMT_BINARY_FLOAT
}
 Format type enumerated values. More...
 

Functions

template<class TResultType >
static TResultType Check (TResultType result)
 Internal usage. Checks if the last OCILIB function call has raised an error. If so, it raises a C++ exception using the retrieved error handle.
 
ostring MakeString (const otext *result)
 Internal usage. Constructs a C++ string object from the given OCILIB string pointer.
 
Raw MakeRaw (void *result, unsigned int size)
 Internal usage. Constructs a C++ Raw object from the given OCILIB raw buffer.
 
template<class TResultType >
TResultType Check (TResultType result)
 Internal usage. Checks if the last OCILIB function call has raised an error. If so, it raises a C++ exception using the retrieved error handle.
 

Detailed Description

OCILIB ++ Namespace.

Typedef Documentation

string class wrapping the OCILIB otext * type and OTEXT() macros ( see Character sets )

Note

Definition at line 173 of file ocilib.hpp.

Oracle Version.

Possible values are DataTypeValues

Definition at line 265 of file ocilib.hpp.

Column data type.

Possible values are DataTypeValues

Definition at line 309 of file ocilib.hpp.

Numeric data type.

Possible values are NumericTypeValues

Definition at line 343 of file ocilib.hpp.

Type of charsetForm.

Possible values are CharsetFormValues

Definition at line 364 of file ocilib.hpp.

Seek Modes.

Possible values are SeekModeValues

Definition at line 389 of file ocilib.hpp.

Open Modes.

Possible values are OpenModeValues

Definition at line 411 of file ocilib.hpp.

Type of Lob.

Possible values are LobTypeValues

Definition at line 435 of file ocilib.hpp.

Type of Long.

Possible values are LongTypeValues

Definition at line 458 of file ocilib.hpp.

Format type.

Possible values are FormatTypeValues

Definition at line 487 of file ocilib.hpp.

typedef Lob<ostring, LobCharacter> ocilib::Clob

Class handling CLOB oracle type.

Note
Length and size arguments / returned values are expressed in number of characters

Definition at line 4070 of file ocilib.hpp.

typedef Lob<ostring, LobNationalCharacter> ocilib::NClob

Class handling NCLOB oracle type.

Note
Length and size arguments / returned values are expressed in number of characters

Definition at line 4081 of file ocilib.hpp.

typedef Lob<Raw, LobBinary> ocilib::Blob

Class handling BLOB oracle type.

Note
Length and size arguments / returned values are expressed in number of bytes

Definition at line 4092 of file ocilib.hpp.

typedef Long<ostring, LongCharacter> ocilib::Clong

Class handling LONG oracle type.

Note
Length and size arguments / returned values are expressed in number of characters

Definition at line 3964 of file ocilib_impl.hpp.

typedef Long<Raw, LongBinary> ocilib::Blong

Class handling LONG RAW oracle type.

Note
Length and size arguments / returned values are expressed in number of bytes

Definition at line 3975 of file ocilib_impl.hpp.

Enumeration Type Documentation

Data type enumerated values.

Enumerator
TypeNumeric 

NUMERIC

TypeDate 

DATE

TypeString 

TEXT

TypeLong 

LONG / LONG RAW

TypeStatement 

SQL CURSOR

TypeLob 

CLOB or BLOB

TypeFile 

FILE

TypeTimestamp 

TIMESTAMP

TypeInterval 

INTERVAL

TypeRaw 

RAW

TypeObject 

Object type

TypeCollection 

Collection

TypeReference 

Object REF

Definition at line 272 of file ocilib.hpp.

Numeric type enumerated values.

Enumerator
NumericShort 

Signed short

NumericInt 

Signed Integer

NumericBigInt 

Signed Big Integer (Integer or Long Integer depending on the compiler )

NumericUnsignedShort 

Unsigned short

NumericUnsignedInt 

Unsigned Integer

NumericUnsignedBigInt 

Unsigned Big Integer (Integer or Long Integer depending on the compiler )

NumericDouble 

Double

NumericFloat 

Float

Definition at line 316 of file ocilib.hpp.

Charset form enumerated values.

Enumerator
CharsetFormDefault 

Database character set will be converted to the server national character set

CharsetFormNational 

Client national character set will be converted to the server national character set

Definition at line 350 of file ocilib.hpp.

Seek Modes enumerated values.

Enumerator
SeekSet 

Set the current position within the stream to the given position

SeekEnd 

Set the current position within the stream begin position

SeekOffset 

Set the current position within the stream to the given value offset from the current position

Definition at line 372 of file ocilib.hpp.

Open Modes enumerated values.

Enumerator
ReadOnly 

Stream is opened for read access

ReadWrite 

Stream is opened for read / write access

Definition at line 396 of file ocilib.hpp.

Format type enumerated values.

Enumerator
FormatDate 

Date

FormatTimestamp 

Timestamp

FormatNumeric 

All numeric types

FormatBinaryDouble 

BinaryDouble

FormatBinaryFloat 

Binary Float

Definition at line 466 of file ocilib.hpp.