Statements control


Detailed Description

Those functions give extra information about OCILIB statements and can modify their behaviour.


Functions

OCI_EXPORT unsigned int OCI_API OCI_GetStatementType (OCI_Statement *stmt)
 Return the type of a SQL statement.
OCI_EXPORT boolean OCI_API OCI_SetFetchMode (OCI_Statement *stmt, unsigned int mode)
 Set the fetch mode of a SQL statement.
OCI_EXPORT unsigned int OCI_API OCI_GetFetchMode (OCI_Statement *stmt)
 Return the fetch mode of a SQL statement.
OCI_EXPORT boolean OCI_API OCI_SetBindMode (OCI_Statement *stmt, unsigned int mode)
 Set the binding mode of a SQL statement.
OCI_EXPORT unsigned int OCI_API OCI_GetBindMode (OCI_Statement *stmt)
 Return the binding mode of a SQL statement.
OCI_EXPORT boolean OCI_API OCI_SetFetchSize (OCI_Statement *stmt, unsigned int size)
 Set the number of rows fetched per internal server fetch call.
OCI_EXPORT unsigned int OCI_API OCI_GetFetchSize (OCI_Statement *stmt)
 Return the number of rows fetched per internal server fetch call.
OCI_EXPORT boolean OCI_API OCI_SetPrefetchSize (OCI_Statement *stmt, unsigned int size)
 Set the number of rows pre-fetched by OCI Client.
OCI_EXPORT unsigned int OCI_API OCI_GetPrefetchSize (OCI_Statement *stmt)
 Return the number of rows pre-fetched by OCI Client.
OCI_EXPORT boolean OCI_API OCI_SetPrefetchMemory (OCI_Statement *stmt, unsigned int size)
 Set the number of rows pre-fetched by OCI Client.
OCI_EXPORT unsigned int OCI_API OCI_GetPrefetchMemory (OCI_Statement *stmt)
 Return the amount of memory used to retrieve rows pre-fetched by OCI Client.
OCI_EXPORT boolean OCI_API OCI_SetLongMaxSize (OCI_Statement *stmt, unsigned int size)
 Set the LONG datatype piece buffer size.
OCI_EXPORT unsigned int OCI_API OCI_GetLongMaxSize (OCI_Statement *stmt)
 Return the LONG datatype piece buffer size.
OCI_EXPORT boolean OCI_API OCI_SetLongMode (OCI_Statement *stmt, unsigned int mode)
 Set the long datatype handling mode of a SQL statement.
OCI_EXPORT unsigned int OCI_API OCI_GetLongMode (OCI_Statement *stmt)
 Return the long datatype handling mode of a SQL statement.
OCI_EXPORT OCI_Connection *OCI_API OCI_StatementGetConnection (OCI_Statement *stmt)
 Return the connection handle associated with a statement handle.


Function Documentation

OCI_EXPORT unsigned int OCI_API OCI_GetBindMode ( OCI_Statement stmt  ) 

Return the binding mode of a SQL statement.

Parameters:
stmt - Statement handle
Note:
See OCI_SetBindMode() for possible values Default value is OCI_BIND_BY_NAME

if stmt is NULL, the return value is OCI_UNKNOWN

Definition at line 2865 of file statement.c.

References OCI_Statement::bind_mode.

OCI_EXPORT unsigned int OCI_API OCI_GetFetchMode ( OCI_Statement stmt  ) 

Return the fetch mode of a SQL statement.

Parameters:
stmt - Statement handle
Note:
See OCI_SetFetchMode() for possible values Default value is OCI_FETCH_FORWARD_ONLY

Definition at line 2835 of file statement.c.

References OCI_Statement::con, and OCI_Statement::exec_mode.

OCI_EXPORT unsigned int OCI_API OCI_GetFetchSize ( OCI_Statement stmt  ) 

Return the number of rows fetched per internal server fetch call.

Note:
Default value is set to constant OCI_FETCH_SIZE
Parameters:
stmt - Statement handle

Definition at line 2895 of file statement.c.

References OCI_Statement::fetch_size.

OCI_EXPORT unsigned int OCI_API OCI_GetLongMaxSize ( OCI_Statement stmt  ) 

Return the LONG datatype piece buffer size.

Note:
Default value is set to constant OCI_SIZE_LONG
Parameters:
stmt - Statement handle

Definition at line 3007 of file statement.c.

References OCI_Statement::long_size.

OCI_EXPORT unsigned int OCI_API OCI_GetLongMode ( OCI_Statement stmt  ) 

Return the long datatype handling mode of a SQL statement.

Parameters:
stmt - Statement handle
Note:
See OCI_SetLongMode() for possible values

Definition at line 3035 of file statement.c.

References OCI_Statement::long_mode.

OCI_EXPORT unsigned int OCI_API OCI_GetPrefetchMemory ( OCI_Statement stmt  ) 

Return the amount of memory used to retrieve rows pre-fetched by OCI Client.

Parameters:
stmt - Statement handle
Note:
Default value is 0

Definition at line 2977 of file statement.c.

References OCI_Statement::prefetch_mem.

OCI_EXPORT unsigned int OCI_API OCI_GetPrefetchSize ( OCI_Statement stmt  ) 

Return the number of rows pre-fetched by OCI Client.

Note:
Default value is set to constant OCI_PREFETCH_SIZE
Parameters:
stmt - Statement handle

Definition at line 2936 of file statement.c.

References OCI_Statement::prefetch_size.

OCI_EXPORT unsigned int OCI_API OCI_GetStatementType ( OCI_Statement stmt  ) 

Return the type of a SQL statement.

Parameters:
stmt - Statement handle
Note:
Possible values are :

Returns:
The statement type on success or OCI_UNKOWN on error

Definition at line 2805 of file statement.c.

References OCI_Statement::type.

Referenced by OCI_Immediate(), and OCI_ImmediateFmt().

OCI_EXPORT boolean OCI_API OCI_SetBindMode ( OCI_Statement stmt,
unsigned int  mode 
)

Set the binding mode of a SQL statement.

Parameters:
stmt - Statement handle
mode - binding mode value
Note:
Possible values are :

Definition at line 2850 of file statement.c.

References OCI_Statement::bind_mode.

OCI_EXPORT boolean OCI_API OCI_SetFetchMode ( OCI_Statement stmt,
unsigned int  mode 
)

Set the fetch mode of a SQL statement.

Parameters:
stmt - Statement handle
mode - fetch mode value
Warning:
OCI_SetFetchMode() MUST be called before anyOCI_ExecuteXXX() call
Note:
Possible values are :

Definition at line 2818 of file statement.c.

References OCI_Statement::con, and OCI_Statement::exec_mode.

OCI_EXPORT boolean OCI_API OCI_SetFetchSize ( OCI_Statement stmt,
unsigned int  size 
)

Set the number of rows fetched per internal server fetch call.

Parameters:
stmt - Statement handle
size - number of rows to fetch
Returns:
TRUE on success otherwise FALSE

Definition at line 2878 of file statement.c.

References OCI_Statement::con, and OCI_Statement::fetch_size.

OCI_EXPORT boolean OCI_API OCI_SetLongMaxSize ( OCI_Statement stmt,
unsigned int  size 
)

Set the LONG datatype piece buffer size.

Parameters:
stmt - Statement handle
size - maximum size for long buffer
Returns:
TRUE on success otherwise FALSE

Definition at line 2990 of file statement.c.

References OCI_Statement::con, and OCI_Statement::long_size.

OCI_EXPORT boolean OCI_API OCI_SetLongMode ( OCI_Statement stmt,
unsigned int  mode 
)

Set the long datatype handling mode of a SQL statement.

Parameters:
stmt - Statement handle
mode - binding mode value
Note:
Possible values are :

LONG RAWs can't be handled with OCI_LONG_IMPLICIT

Definition at line 3020 of file statement.c.

References OCI_Statement::long_mode.

OCI_EXPORT boolean OCI_API OCI_SetPrefetchMemory ( OCI_Statement stmt,
unsigned int  size 
)

Set the number of rows pre-fetched by OCI Client.

Parameters:
stmt - Statement handle
size - amount of memory to fetch
Note:
Default value is 0 and the pre-fetch size attribute is used instead. When both attributes are set (pre-fetch size and memory) and pre-fetch memory value can hold more rows than specified by pre-fetch size, OCI uses pre-fetch size instead.

OCILIB set pre-fetch attribute to OCI_PREFETCH_SIZE when a statement is created. To setup a big value for OCI_SetPrefetchMemory(), you must call OCI_SetPrefetchSize() to 0 to make OCI consider this attribute.

Returns:
TRUE on success otherwise FALSE

Definition at line 2949 of file statement.c.

References OCI_Statement::con, OCI_Connection::err, OCI_Statement::prefetch_mem, and OCI_Statement::stmt.

OCI_EXPORT boolean OCI_API OCI_SetPrefetchSize ( OCI_Statement stmt,
unsigned int  size 
)

Set the number of rows pre-fetched by OCI Client.

Parameters:
stmt - Statement handle
size - number of rows to pre-fetch
Note:
To turn off pre-fetching, set both attributes (size and memory) to 0.
Returns:
TRUE on success otherwise FALSE

Definition at line 2908 of file statement.c.

References OCI_Statement::con, OCI_Connection::err, OCI_Statement::prefetch_size, and OCI_Statement::stmt.

OCI_EXPORT OCI_Connection* OCI_API OCI_StatementGetConnection ( OCI_Statement stmt  ) 

Return the connection handle associated with a statement handle.

Parameters:
stmt - Statement handle

Definition at line 3048 of file statement.c.

References OCI_Statement::con.


Generated on Thu Jul 30 17:41:54 2009 for OCILIB (C Driver for Oracle) by  doxygen 1.5.4