OCILIB ++ Namespace. More...

Namespaces
namespace	core
	OCILIB internal core classes.

namespace	support
	OCILIB internal support classes.

Classes
class	Agent
	AQ identified agent for messages delivery. More...

class	BindInfo
	Provides SQL bind information. More...

class	Collection
	Object identifying the SQL data types VARRAY and NESTED TABLE. More...

class	CollectionElement
	Class used for handling transient collection value. it is used internally by the Collection<T> class: More...

class	CollectionIterator
	STL compliant Collection Random iterator class. 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	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	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	Number
	Object identifying the SQL data type NUMBER. 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	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...

class	Vector
	Object identifying the SQL data type VECTOR. More...

class	XmlType
	Object identifying the SQL data type XMLTYPE. 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 )

typedef void *	AnyPointer
	Alias for the generic void pointer.

typedef std::vector< unsigned char >	Raw
	C++ counterpart of SQL RAW data type.

typedef OCI_Mutex *	MutexHandle
	Alias for an OCI_Mutex pointer.

typedef OCI_Thread *	ThreadHandle
	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 core::Enum< OracleVersionValues >	OracleVersion
	Oracle Version.

typedef core::Enum< DataTypeValues >	DataType
	Column data type.

typedef core::Enum< NumericTypeValues >	NumericType
	Numeric data type.

typedef core::Enum< CharsetFormValues >	CharsetForm
	Type of charsetForm.

typedef core::Enum< CollationIDValues >	CollationID
	Type of Collation ID.

typedef core::Enum< SeekModeValues >	SeekMode
	Seek Modes.

typedef core::Enum< OpenModeValues >	OpenMode
	Open Modes.

typedef core::Enum< LobTypeValues >	LobType
	Type of Lob.

typedef core::Enum< LongTypeValues >	LongType
	Type of Long.

typedef core::Enum< FormatTypeValues >	FormatType
	Format type.

typedef Lob< ostring, LobCharacter >	Clob
	Class handling CLOB oracle type.

typedef Lob< ostring, LobNationalCharacter >	NClob
	Class handling NCLOB oracle type.

typedef Lob< Raw, LobBinary >	Blob
	Class handling BLOB oracle type.

typedef Long< ostring, LongCharacter >	Clong
	Class handling LONG oracle type.

typedef Long< Raw, LongBinary >	Blong
	Class handling LONG RAW oracle type.

Enumerations
enum	OracleVersionValues
	Oracle Version enumerated values. More...

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 , TypeBoolean = OCI_CDT_BOOLEAN , TypeXmlType = OCI_CDT_XMLTYPE , TypeVector = OCI_CDT_VECTOR }
	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 , NumericNumber = OCI_NUM_NUMBER }
	Numeric type enumerated values. More...

enum	CharsetFormValues { CharsetFormDefault = OCI_CSF_DEFAULT , CharsetFormNational = OCI_CSF_NATIONAL }
	Charset form enumerated values. More...

enum	CollationIDValues { CollationIDNone = OCI_CCI_NONE , CollationIDNlsComp = OCI_CCI_NLS_COMP , CollationIDNlsSort = OCI_CCI_NLS_SORT , CollationIDNlsSortCI = OCI_CCI_NLS_SORT_CI , CollationIDNlsSortAI = OCI_CCI_NLS_SORT_AI , CollationIDNlsSortCS = OCI_CCI_NLS_SORT_CS , CollationIDNlsSortVar1 = OCI_CCI_NLS_SORT_VAR1 , CollationIDNlsSortVar1CI = OCI_CCI_NLS_SORT_VAR1_CI , CollationIDNlsSortVar1AI = OCI_CCI_NLS_SORT_VAR1_AI , CollationIDNlsSortVar1CS = OCI_CCI_NLS_SORT_VAR1_CS , CollationIDBinary = OCI_CCI_BINARY , CollationIDBinaryCI = OCI_CCI_BINARY_CI , CollationIDBinaryAI = OCI_CCI_BINARY_AI }
	Collation ID 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 { LobBinary = OCI_BLOB , LobCharacter = OCI_CLOB , LobNationalCharacter = OCI_NCLOB }
	Lob types enumerated values. More...

enum	LongTypeValues { LongBinary = OCI_BLONG , LongCharacter = OCI_CLONG }
	Long types enumerated values. More...

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...

Detailed Description

OCILIB ++ Namespace.

Typedef Documentation

◆ ostring

ocilib::ostring

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

Note

for ANSI builds, ocilib::ostring is equivalent to std::string
for UNICODE builds, ocilib::ostring is equivalent to std::wstring

Definition at line 120 of file config.hpp.

◆ AnyPointer

ocilib::AnyPointer

Alias for the generic void pointer.

Definition at line 129 of file config.hpp.

◆ Raw

ocilib::Raw

C++ counterpart of SQL RAW data type.

Definition at line 138 of file config.hpp.

◆ MutexHandle

ocilib::MutexHandle

Alias for an OCI_Mutex pointer.

Definition at line 147 of file config.hpp.

◆ ThreadHandle

ocilib::ThreadHandle

Alias for an OCI_Thread pointer.

Definition at line 156 of file config.hpp.

◆ ThreadId

ocilib::ThreadId

Thread Unique ID.

Definition at line 165 of file config.hpp.

◆ CallbackPointer

ocilib::CallbackPointer

Alias used for storing user callback method pointers.

Definition at line 174 of file config.hpp.

◆ OracleVersion

typedef core::Enum<OracleVersionValues> ocilib::OracleVersion

Oracle Version.

Possible values are DataTypeValues

Definition at line 78 of file types.hpp.

◆ DataType

typedef core::Enum<DataTypeValues> ocilib::DataType

Column data type.

Possible values are DataTypeValues

Definition at line 128 of file types.hpp.

◆ NumericType

typedef core::Enum<NumericTypeValues> ocilib::NumericType

Numeric data type.

Possible values are NumericTypeValues

Definition at line 164 of file types.hpp.

◆ CharsetForm

typedef core::Enum<CharsetFormValues> ocilib::CharsetForm

Type of charsetForm.

Possible values are CharsetFormValues

Definition at line 186 of file types.hpp.

◆ CollationID

typedef core::Enum<CollationIDValues> ocilib::CollationID

Type of Collation ID.

Possible values are CollationIDValues

Definition at line 230 of file types.hpp.

◆ SeekMode

typedef core::Enum<SeekModeValues> ocilib::SeekMode

Seek Modes.

Possible values are SeekModeValues

Definition at line 255 of file types.hpp.

◆ OpenMode

typedef core::Enum<OpenModeValues> ocilib::OpenMode

Open Modes.

Possible values are OpenModeValues

Definition at line 277 of file types.hpp.

◆ LobType

typedef core::Enum<LobTypeValues> ocilib::LobType

Type of Lob.

Possible values are LobTypeValues

Definition at line 301 of file types.hpp.

◆ LongType

typedef core::Enum<LongTypeValues> ocilib::LongType

Type of Long.

Possible values are LongTypeValues

Definition at line 323 of file types.hpp.

◆ FormatType

typedef core::Enum<FormatTypeValues> ocilib::FormatType

Format type.

Possible values are FormatTypeValues

Definition at line 351 of file types.hpp.

◆ Clob

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 4524 of file types.hpp.

◆ NClob

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 4535 of file types.hpp.

◆ Blob

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 4546 of file types.hpp.

◆ Clong

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 5756 of file types.hpp.

◆ Blong

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 5767 of file types.hpp.

Enumeration Type Documentation

◆ OracleVersionValues

enum ocilib::OracleVersionValues

Oracle Version enumerated values.

Note: This list is NOT exhaustive and contains only a list of well known released versions

Definition at line 49 of file types.hpp.

◆ DataTypeValues

enum ocilib::DataTypeValues

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
TypeBoolean	PL/SQL boolean
TypeXmlType	XMLTYPE
TypeVector	VECTOR

Definition at line 85 of file types.hpp.

◆ NumericTypeValues

enum ocilib::NumericTypeValues

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
NumericNumber	Number

Definition at line 135 of file types.hpp.

◆ CharsetFormValues

enum ocilib::CharsetFormValues

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 171 of file types.hpp.

◆ CollationIDValues

enum ocilib::CollationIDValues

Collation ID enumerated values.

Enumerator
CollationIDNone	None
CollationIDNlsComp	Compare
CollationIDNlsSort	Sort
CollationIDNlsSortCI	Sort CI
CollationIDNlsSortAI	Sort AI
CollationIDNlsSortCS	Sort CS
CollationIDNlsSortVar1	Sort VAR 1
CollationIDNlsSortVar1CI	Sort VAR 1 CI
CollationIDNlsSortVar1AI	Sort VAR 1 AI
CollationIDNlsSortVar1CS	Sort VAR 1 CS
CollationIDBinary	Binary
CollationIDBinaryCI	Binary CI
CollationIDBinaryAI	Binary AI

Definition at line 193 of file types.hpp.

◆ SeekModeValues

enum ocilib::SeekModeValues

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 238 of file types.hpp.

◆ OpenModeValues

enum ocilib::OpenModeValues

Open Modes enumerated values.

Enumerator
ReadOnly	Stream is opened for read access
ReadWrite	Stream is opened for read / write access

Definition at line 262 of file types.hpp.

◆ LobTypeValues

enum ocilib::LobTypeValues

Lob types enumerated values.

Enumerator
LobBinary	Binary Large Object (BLOB)
LobCharacter	Character Large Object (CLOB)
LobNationalCharacter	National Character Large Object (NCLOB)

Definition at line 284 of file types.hpp.

◆ LongTypeValues

enum ocilib::LongTypeValues

Long types enumerated values.

Enumerator
LongBinary	Binary LONG RAW
LongCharacter	Character LONG

Definition at line 308 of file types.hpp.

◆ FormatTypeValues

enum ocilib::FormatTypeValues

Format type enumerated values.

Enumerator
FormatDate	Date
FormatTimestamp	Timestamp
FormatNumeric	All numeric types
FormatBinaryDouble	BinaryDouble
FormatBinaryFloat	Binary Float

Definition at line 330 of file types.hpp.

Namespaces

Classes

Typedefs

Enumerations