OCILIB (C Driver for Oracle) 3.9.2
Data Structures | Typedefs
Library objects and datatypes

Detailed Description

OCILIB implements:

Supported Oracle datatypes

Here is a summary of the supported datatypes:

OCILIB library objects

The public OCILIB library interface implements encapsulation for representing database objects (such as connections, statements ...) through opaque structures (pointers to structures whose definition is kept private)

Instead of directly manipulating the structures and their members, the library has functions to access the underlying members.

It's designed to make the user code as more independent as possible of the library details.

Data Structures

struct  OCI_XID
 Global transaction identifier. More...
union  OCI_Variant
 Internal Variant type based on union C type. More...
struct  OCI_HashValue
 Hash table entry value. More...
struct  OCI_HashEntry
 Hash table entry. More...
struct  OCI_Pool
 Pool object (session or connection) More...
struct  OCI_Connection
 Oracle physical connection. More...
struct  OCI_Statement
 Oracle SQL or PL/SQL statement. More...
struct  OCI_Bind
 Internal bind representation. More...
struct  OCI_Resultset
 Collection of output columns from a select statement. More...
struct  OCI_Column
 Oracle SQL Column and Type member representation. More...
struct  OCI_Lob
 Oracle Internal Large objects: More...
struct  OCI_File
 Oracle External Large objects: More...
struct  OCI_Transaction
 Oracle Transaction. More...
struct  OCI_Long
 Oracle Long datatype. More...
struct  OCI_Date
 Oracle internal date representation. More...
struct  OCI_Timestamp
 Oracle internal timestamp representation. More...
struct  OCI_Interval
 Oracle internal interval representation. More...
struct  OCI_Object
 Oracle Named types representation. More...
struct  OCI_Coll
 Oracle Collections (VARRAYs and Nested Tables) representation. More...
struct  OCI_Elem
 Oracle Collection item representation. More...
struct  OCI_Iter
 Oracle Collection iterator representation. More...
struct  OCI_TypeInfo
 Type info metadata handle. More...
struct  OCI_Ref
 Oracle REF type representation. More...
struct  OCI_HashTable
 OCILIB implementation of hash tables. More...
struct  OCI_Error
 Encapsulates an Oracle or OCILIB exception. More...
struct  OCI_Mutex
 OCILIB encapsulation of OCI mutexes. More...
struct  OCI_Thread
 OCILIB encapsulation of OCI Threads. More...
struct  OCI_DirPath
 OCILIB encapsulation of OCI Direct Path handle. More...
struct  OCI_Subscription
 OCILIB encapsulation of Oracle DCN notification. More...
struct  OCI_Event
 OCILIB encapsulation of Oracle DCN event. More...
struct  OCI_Msg
 OCILIB encapsulation of A/Q message. More...
struct  OCI_Agent
 OCILIB encapsulation of A/Q Agent. More...
struct  OCI_Dequeue
 OCILIB encapsulation of A/Q dequeuing operations. More...
struct  OCI_Enqueue
 OCILIB encapsulation of A/Q enqueuing operations. More...

Typedefs

typedef void(* POCI_ERROR )(OCI_Error *err)
 Error procedure prototype.
typedef void(* POCI_THREAD )(OCI_Thread *thread, void *arg)
 Thread procedure prototype.
typedef void(* POCI_THREADKEYDEST )(void *data)
 Thread key destructor prototype.
typedef void(* POCI_NOTIFY )(OCI_Event *event)
 Database Change Notification User callback prototype.
typedef unsigned int(* POCI_TAF_HANDLER )(OCI_Connection *con, unsigned int type, unsigned int event)
 Failover Notification User callback prototype.
typedef void(* POCI_HA_HANDLER )(OCI_Connection *con, unsigned int source, unsigned int event, OCI_Timestamp *time)
 HA (High Availabality) events Notification User callback prototype.
typedef long long big_int
 big_int is a C scalar integer (32 or 64 bits) depending on compiler support for 64bits integers. big_uint is an usigned big_int

Typedef Documentation

Error procedure prototype.

Parameters:
err- Error handle

Definition at line 1133 of file ocilib.h.

Thread procedure prototype.

Parameters:
thread- Thread handle
arg- Pointer passed to OCI_ThreadRun()

Definition at line 1149 of file ocilib.h.

Thread key destructor prototype.

Parameters:
data- Thread Key current pointer value

Definition at line 1165 of file ocilib.h.

Database Change Notification User callback prototype.

Parameters:
event- Event handle

Definition at line 1180 of file ocilib.h.

Failover Notification User callback prototype.

Parameters:
con- Connection handle related to the event
type- Event type
event- Event code
Note:
Possible values for parameter 'type' :
  • OCI_FOT_NONE
  • OCI_FOT_SESSION
  • OCI_FOT_SELECT
Possible values for parameter 'event' :
  • OCI_FOE_END
  • OCI_FOE_ABORT
  • OCI_FOE_REAUTH
  • OCI_FOE_BEGIN
  • OCI_FOE_ERROR
Returns:
User callback should return one iof the following value :
  • OCI_FOC_OK
  • OCI_FOC_RETRY

Definition at line 1216 of file ocilib.h.

HA (High Availabality) events Notification User callback prototype.

Parameters:
con- Connection handle related to the event
source- Connection handle related to the event
status- Timestamp of the event
time- Timestamp of the event
Note:
Currently, Oracle only send HA down events
Possible values for parameter 'status' :
  • OCI_HET_DOWN : HA event type down
  • OCI_HET_UP : HA event type up
Possible values for parameter 'event' :
  • OCI_HES_INSTANCE
  • OCI_HES_DATABASE
  • OCI_HES_NODE
  • OCI_HES_SERVICE
  • OCI_HES_SERVICE_MEMBER
  • OCI_HES_ASM_INSTANCE
  • OCI_HES_PRECONNECT

Definition at line 1254 of file ocilib.h.