Statement Class

A Statement object is used for executing SQL statements. The statement may be a query returning result set, or a non-query statement returning an update count. Non-query SQL can be insert, update, or delete statements. Non-query SQL statements can also be DML statements (such as create, grant, and so on) or stored procedure calls.

A query, insert / update / delete, or stored procedure call statements may have IN bind parameters, while a stored procedure call statement may have either OUT bind parameters or bind parameters that are both IN and OUT, referred to as IN/OUT parameters.

The Statement class methods are divided into three categories:

• Statement methods applicable to all statements

• Methods applicable to prepared statements with IN bind parameters

• Methods applicable to callable statements with OUT or IN/OUT bind parameters.

Status

addIteration()

After specifying set parameters, an iteration is added for execution.

Syntax

void addIteration();

closeResultSet()

Immediately releases the specified resultSet's database and OCCI resources when the result set is not needed.

Syntax

void closeResultSet(
   ResultSet *resultSet);

resultSet

closeStream()

Closes the stream specified by the parameter stream.

Syntax

void closeStream(
   Stream *stream); 

stream

disableCaching()

Disables statement caching. Used if a user wants to destroy a statement instead of caching it. Effective only if statement caching is enabled.

Syntax

void disableCaching();

execute()

Executes an SQL statement that may return either a result set or an update count. The statement may have read-able streams which may have to be written, in which case the results of the execution may not be readily available. The returned value Status is defined in Table 13-42.

If output streams are used for OUT bind variables, they must be completely read in order. The getCurrentStreamParam() method would indicate which stream must be read. Similarly, getCurrentIteration() would indicate the iteration for which data is available.

Status execute(
   const string &sql="");

Status execute(
   const UString &sql);

sql

executeArrayUpdate()

Executes insert/update/delete statements which use only the setDataBuffer() or stream interface for bind parameters. The bind parameters must be arrays of size arrayLength parameter. The statement may have writeable streams which may have to be written. The returned value Status is defined in Table 13-42.

If output streams are used for OUT bind variables, they must be completely read in order. The getCurrentStreamParam() method would indicate which stream must be read. Similarly, getCurrentIteration() would indicate the iteration for which data is available.

Note that you cannot perform array executes for queries or callable statements.

Syntax

Status executeArrayUpdate(
   unsigned int arrayLength);

arrayLength

executeQuery()

Runs a SQL statement that returns a ResultSet. Should not be called for a statement which is not a query, has streamed parameters. Returns a ResultSet that contains the data produced by the query.

ResultSet* executeQuery(
   const string &sql="");

ResultSet* executeQuery(
   const UString &sql);

sql

executeUpdate()

Executes a non-query statement such as a SQL INSERT, UPDATE, DELETE statement, a DDL statement such as CREATE/ALTER and so on, or a stored procedure call. Returns either the row count for INSERT, UPDATE or DELETE or 0 for SQL statements that return nothing.

unsigned int executeUpdate(
   const string &sql="");

unsigned int executeUpdate(
   const UString &sql);

sql

getAutoCommit()

Returns the current auto-commit state.

Syntax

bool getAutoCommit() const;

getBatchErrorMode()

Returns the state of the batch error mode; TRUE if the batch error mode is enabled, FALSE otherwise.

Syntax

bool getBatchErrorMode() const;

getBDouble()

Returns the value of an IEEE754 DOUBLE column, which has been defined as an OUT bind. If the value is SQL NULL, the result is 0.

Syntax

BDouble getBDouble(
   unsigned int paramIndex) = 0;

paramIndex

getBfile()

Returns the value of a BFILE parameter as a Bfile object.

Syntax

Bfile getBfile(
   unsigned int paramIndex);

paramIndex

getBFloat()

Gets the value of an IEEE754 FLOAT column, which has been defined as an OUT bind. If the value is SQL NULL, the result is 0.

Syntax

BFloat getBFloat(
   unsigned int paramIndex) = 0;

paramIndex

getBlob()

Returns the value of a BLOB parameter as a Blob.

Syntax

Blob getBlob(
   unsigned int paramIndex);

paramIndex

getBytes()

Returns the value of n SQL BINARY or VARBINARY parameter as Bytes; if the value is SQL NULL, the result is NULL.

Syntax

Bytes getBytes(
   unsigned int paramIndex);

paramIndex

getCharSet()

Returns the characterset that is in effect for the specified parameter, as a string.

Syntax

string getCharSet(
   unsigned int paramIndex) const;

paramIndex

getCharSetUString()

Returns the character set that is in effect for the specified parameter, as a UString.

Syntax

UString getCharSetUString(
   unsigned int paramIndex) const;

paramIndex

getClob()

Get the value of a CLOB parameter as a Clob. Returns the parameter value.

Syntax

Clob getClob(
   unsigned int paramIndex);

paramIndex

getConnection()

Returns the connection from which the Statement object was instantiated.

Syntax

Connection* getConnection() const;

getCurrentIteration()

If the prepared statement has any output Streams, this method returns the current iteration of the statement that is being processed by OCCI. If this method is called after all the invocations in the set of iterations has been processed, it returns 0. Returns the iteration number of the current iteration that is being processed. The first iteration is numbered 1 and so on. If the statement has finished execution, a 0 is returned.

Syntax

unsigned int getCurrentIteration() const;

getCurrentStreamIteration()

Returns the current parameter stream for which data is available.

Syntax

unsigned int getCurrentStreamIteration() const;

getCurrentStreamParam()

Returns the parameter index of the current output Stream parameter that must be written. If the prepared statement has any output Stream parameters, this method returns the parameter index of the current output Stream that must be written. If no output Stream must be written, or there are no output Stream parameters in the prepared statement, this method returns 0.

Syntax

unsigned int getCurrentStreamParam() const;

getCursor()

Gets the REF CURSOR value of an OUT parameter as a ResultSet. Data can be fetched from this result set. The OUT parameter must be registered as CURSOR with the registerOutParam() method. Returns a ResultSet for the OUT parameter value.

Note that if there are multiple REF CURSORs being returned due to a batched call, data from each cursor must be completely fetched before retrieving the next REF CURSOR and starting fetch on it.

Syntax

ResultSet * getCursor(
   unsigned int paramIndex);

paramIndex

getDatabaseNCHARParam()

Returns whether data is in NCHAR character set or not.

Syntax

bool getDatabaseNCHARParam(
   unsigned int paramIndex) const;

paramIndex

getDate()

Get the value of a SQL DATE parameter as a Date object. Returns the parameter value; if the value is SQL NULL, the result is NULL.

Syntax

Date getDate(
   unsigned int paramIndex) const;

paramIndex

getDouble()

Get the value of a DOUBLE parameter as a C++ double. Returns the parameter value; if the value is SQL NULL, the result is 0.

Syntax

double getDouble(
   unsigned int paramIndex);

paramIndex

getFloat()

Get the value of a FLOAT parameter as a C++ float. Returns the parameter value; if the value is SQL NULL, the result is 0.

Syntax

float getFloat(
   unsigned int paramIndex);

paramIndex

getInt()

Get the value of an INTEGER parameter as a C++ int. Returns the parameter value; if the value is SQL NULL, the result is 0.

Syntax

unsigned int getInt(
   unsigned int paramIndex);

paramIndex

getIntervalDS()

Get the value of a parameter as a IntervalDS object.

Syntax

IntervalDS getIntervalDS(
   unsigned int paramIndex);

paramIndex

getIntervalYM()

Get the value of a parameter as a IntervalYM object.

Syntax

IntervalYM getIntervalYM(
   unsigned int paramIndex);

paramIndex

getMaxIterations()

Gets the current limit on maximum number of iterations. Default is 1. Returns the current maximum number of iterations.

Syntax

unsigned int getMaxIterations() const;

getMaxParamSize()

The maxParamSize limit (in bytes) is the maximum amount of data sent or returned for any parameter value; it only applies to character and binary types. If the limit is exceeded, the excess data is silently discarded. Returns the current max parameter size limit.

Syntax

unsigned int getMaxParamSize(
   unsigned int paramIndex) const;

paramIndex

getNumber()

Gets the value of a NUMERIC parameter as a Number object. Returns the parameter value; if the value is SQL NULL, the result is NULL.

Syntax

Number getNumber(
   unsigned int paramIndex);

paramIndex

getObject()

Gets the value of a parameter as a PObject. This method returns an PObject whose type corresponds to the SQL type that was registered for this parameter using registerOutParam(). Returns A PObject holding the OUT parameter value.

This method may be used to read database-specific, abstract data types.

Syntax

PObject * getObject(
   unsigned int paramIndex);

paramIndex

getOCIStatement()

Get the OCI statement handle associated with the Statement.

Syntax

OCIStmt * getOCIStatement() const;

getRef()

Get the value of a REF parameter as RefAny. Returns the parameter value.

Syntax

RefAny getRef(
   unsigned int paramIndex);

paramIndex

getResultSet()

Returns the current result as a ResultSet.

Syntax

ResultSet * getResultSet();

getRowid()

Get the rowid parameter value as a Bytes.

Syntax

Bytes getRowid(
   unsigned int paramIndex);

paramIndex

getSQL()

Returns the current SQL string associated with the Statement object.

Syntax

string getSQL() const;

getSQLUString()

Returns the current SQL UString associated with the Statement object; globalization enabled.

Syntax

UString getSQLUString() const;

getStream()

Returns the value of the parameter as a stream.

Syntax

Stream * getStream(
   unsigned int paramIndex);

paramIndex

getString()

Get the value of a CHAR, VARCHAR, or LONGVARCHAR parameter as an string. Returns the parameter value; if the value is SQL NULL, the result is empty string.

Syntax

string getString(
   unsigned int paramIndex);

paramIndex

getTimestamp()

Get the value of a SQL TIMESTAMP parameter as a Timestamp object. Returns the parameter value; if the value is SQL NULL, the result is NULL

Syntax

Timestamp getTimestamp(
   unsigned int paramIndex);

paramIndex

getUInt()

Get the value of a BIGINT parameter as a C++ unsigned int. Returns the parameter value; if the value is SQL NULL, the result is 0.

Syntax

unsigned int getUInt(
   unsigned int paramIndex);

paramIndex

getUpdateCount()

Returns the current result as an update count.

Syntax

unsigned int getUpdateCount() const;

getUString()

Returns the value as a UString.

This method should be called only if the environment's character set is UTF16, or if setCharset() method has been called to explicitly retrieve UTF16 data.

Syntax

UString getUString(
   unsigned int paramIndex);

paramIndex

getVector()

Returns the column in the current position as a vector. The column at the position, specified by index, should be a collection type (varray or nested table). The SQL type of the elements in the collection should be compatible with the type of the vector.

void getVector(
   Statement *stmt,
   unsigned int paramIndex,
   std::vector<UString> &vect);

void getVector(
   Statement *stmt,
   unsigned int paramIndex,
   vector<BDouble> &vect);

void getVector(
   Statement *stmt,
   unsigned int paramIndex,
   vector<BFile> &vect);

void getVector(
   Statement *stmt,
   unsigned int paramIndex,
   vector<BFloat> &vect);

void getVector(
   Statement *stmt,
   unsigned int paramIndex,
   vector<Blob> &vect);

void getVector(
   Statement *stmt,
   unsigned int paramIndex,
   vector<Clob> &vect);

void getVector(
   Statement *stmt,
   unsigned int paramIndex,
   vector<Date> &vect);

void getVector(
   Statement *stmt,
   unsigned int paramIndex,
   vector<double> &vect);

void getVector(
   Statement *stmt,
   unsigned int paramIndex,
   vector<float> &vect);

void getVector(
   Statement *stmt,
   unsigned int paramIndex,
   vector<int> &vect);

void getVector(
   Statement *stmt,
   unsigned int paramIndex,
   vector<IntervalDS> &vect);

void getVector(
   Statement *stmt,
   unsigned int paramIndex,
   vector<IntervalYM> &vect);

void getVector(
   Statement *stmt,
   unsigned int paramIndex,
   vector<Number> &vect);

void getVector(
   Statement *stmt,
   unsigned int paramIndex,
   vector<RefAny> &vect);

void getVector(
   Statement *stmt,
   unsigned int paramIndex,
   vector<string> &vect);

void getVector(
   Statement *stmt,
   unsigned int paramIndex,
   vector<T *> &vect);

void getVector(
   Statement *stmt,
   unsigned int paramIndex,
   vector<T> &vect);

void getVector(
   Statement *stmt,
   unsigned int paramIndex,
   vector<Timestamp> &vect);

void getVector(
   Statement *stmt,
   unsigned int paramIndex,
   vector<u <Ref<T> > &vect);

void getVector(
   Statement *stmt,
   unsigned int paramIndex,
   vector<unsigned int> &vect);

stmt

paramIndex

vect

getVectorOfRefs()

This method returns the column in the current position as a vector of REFs. The column should be a collection type (varray or nested table) of REFs. Used with OUT binds.

Syntax

void getVectorOfRefs(
   Statement *stmt,
   unsigned int colIndex,
   vector< Ref<T> > &vect);

stmt

colIndex

vect

isNull()

An OUT parameter may have the value of SQL NULL; isNull() reports whether the last value read has this special value. Note that you must first call getxxx() on a parameter to read its value and then call isNull() to see if the value was SQL NULL. Returns TRUE if the last parameter read was SQL NULL.

Syntax

bool isNull(
   unsigned int paramIndex ) const;

paramIndex

isTruncated()

This method checks whether the value of the parameter is truncated. If the value of the parameter is truncated, then TRUE is returned; otherwise, FALSE is returned.

Syntax

bool isTruncated(
   unsigned int paramIndex) const;

paramIndex

preTruncationLength()

Returns the actual length of the parameter before truncation.

Syntax

int preTruncationLength(
   unsigned int paramIndex) const;

paramIndex

registerOutParam()

This method registers the type of each out parameter of a PL/SQL stored procedure. Before executing a PL/SQL stored procedure, you must explicitly call this method to register the type of each out parameter. This method should be called for out parameters only. Use the setxxx() method for in/out parameters.

• When reading the value of an out parameter, you must use the getxxx() method that corresponds to the parameter's registered SQL type. For example, use getInt or getNumber when OCCIINT or OCCINumber is the type specified.

• If a PL/SQL stored procedure has an out parameter of type ROWID, the type specified in this method should be OCCISTRING. The value of the out parameter can then be retrieved by calling the getString() method.

• If a PL/SQL stored procedure has an in/out parameter of type ROWID, call the methods setString() and getString() to set the type and retrieve the value of the IN/OUT parameter.

void registerOutParam(
   unsigned int paramIndex,
   Type type,
   unsigned int maxSize=0,
   const string &sqltype="");

void registerOutParam(
   unsigned int paramIndex,
   Type type,
   unsigned int maxSize,
   const string typName,
   const string &schName);

void registerOutParam(
   unsigned int paramIndex,
   Type type,
   unsigned int maxSize,
   const UString &typName,
   const UString &schName);

paramIndex

type

maxSize

sqltype

typName

schName

setAutoCommit()

A Statement can be in auto-commit mode. In this case any statement executed is also automatically committed. By default, the auto-commit mode is turned-off.

Syntax

void setAutoCommit(
   bool autoCommit);

autoCommit

setBatchErrorMode()

Enables or disables the batch error processing mode.

Syntax

virtual void setBatchErrorMode(
   bool batchErrorMode);

batchErrorMode

setBDouble()

Sets an IEEE754 double as a bind value to a Statement object at the position specified by paramIndex attribute.

Syntax

void setBDouble(
   unsigned int paramIndex,
   const BDouble &dval);

paramIndex

dval

setBfile()

Sets a parameter to a Bfile value.

Syntax

void setBfile(
   unsigned int paramIndex,
   const Bfile &val);

paramIndex

val

setBFloat()

Sets an IEEE754 float as a bind value to a Statement object at the position specified by the paramIndex attribute.

Syntax

void setBFloat(
   unsigned int paramIndex,
   const BFloat &fval);

paramIndex

fval

setBinaryStreamMode()

Defines that a column is to be returned as a binary stream.

void setBinaryStreamMode(
   unsigned int colIndex,
   unsigned int size);

void setBinaryStreamMode(
   unsigned int colIndex,
   unsigned int size
   bool inArg);

colIndex

size

inArg

setBlob()

Sets a parameter to a Blob value.

Syntax

void setBlob(
   unsigned int paramIndex,
   const Blob &val);

paramIndex

val

setBytes()

Sets a parameter to a Bytes array.

Syntax

void setBytes(
   unsigned int paramIndex,
   const Bytes &val);

paramIndex

val

setCharacterStreamMode()

Defines that a column is to be returned as a character stream.

void setCharacterStreamMode(
   unsigned int colIndex,
   unsigned int size);

void setCharacterStreamMode(
   unsigned int colIndex,
   unsigned int size,
   bool inArg);

colIndex

size

inArg

setCharSet()

Overrides the default character set for the specified parameter. Data is assumed to be in the specified character set and is converted to database character set. For OUT binds, this specifies the character set to which database characters are converted to.

Syntax

void setCharSet(
   unsigned int paramIndex,
   string &charSet);

paramIndex

charSet

setCharSetUString()

Overrides the default character set for the specified parameter. Data is assumed to be in the specified character set and is converted to database character set. For OUT binds, this specifies the character set to which database characters are converted to.

Syntax

void setCharSetUString(
   unsigned int paramIndex,
   const UString& charSet); 

paramIndex

charSet

setClob()

Sets a parameter to a Clob value.

Syntax

void setClob(
   unsigned int paramIndex,
   const Clob &val);

paramIndex

val

setDate()

Sets a parameter to a Date value.

Syntax

void setDate(
   unsigned int paramIndex,
   const Date &val);

paramIndex

val

setDatabaseNCHARParam()

If the parameter is going to be inserted in a column that contains data in the database's NCHAR character set, then OCCI must be informed by passing a TRUE value. A FALSE can be passed to restore the dafault.Returns returns the character set that is in effect for the specified parameter.

Syntax

void setDatabaseNCHARParam(
   unsigned int paramIndex,
   bool isNCHAR);

paramIndex

isNCHAR

setDataBuffer()

Specifies a data buffer where data would be available. Also used for OUT bind parameters of callable statements.

The buffer parameter is a pointer to a user allocated data buffer. The current length of data must be specified in the length parameter. The amount of data should not exceed the size parameter. Finally, type is the data type of the data.

Note that not all types can be supplied in the buffer. For example, all OCCI allocated types (such as Bytes, Date and so on) cannot be provided by the setDataBuffer() interface. Similarly, C++ Standard Library strings cannot be provided with the setDataBuffer() interface either. The type can be any of OCI data types such VARCHAR2, CSTRING, CHARZ and so on.

If setDataBuffer() is used to specify data for iterative or array executes, it should be called only once in the first iteration only. For subsequent iterations, OCCI would assume that data is at buffer +(i*size) location where i is the iteration number. Similarly the length of the data would be assumed to be at (length+i).

Syntax

void setDataBuffer(
   unsigned int paramIndex,
   void *buffer,
   Type type,
   sb4 size,
   ub2 *length,
   sb2 *ind = NULL,
   ub2 *rc= NULL);

paramIndex

buffer

type

size

length

ind

rc

setDataBufferArray()

Specifies an array of data buffers where data would be available for reading or writing. Used for IN, OUT, and IN/OUT bind parameters for stored procedures which read/write array parameters.

• A stored procedure can have an array of values for IN, IN/OUT, or OUT parameters. In this case, the parameter must be specified using the setDataBufferArray() method. The array is specified just as for the setDataBuffer() method for iterative or array executes, but the number of elements in the array is determined by *arrayLength parameter.

• For OUT and IN/OUT parameters, the maximum number of elements in the array is specified (and returned) by the arraySize parameter. The client must ensure that it has allocated size *arraySize bytes for the buffer. For iterative prepared statements, the number of elements in the array is determined by the number of iterations, and for array executes the number of elements in the array is determined by the arrayLength parameter of the executeArrayUpdate() method. However, for array parameters of stored procedures, the number of elements in the array must be specified in the arrayLength parameter of the setDataBufferArray() method because each parameter may have a different size array.

• This is different from prepared statements where for iterative and array executes, the number of elements in the array for each parameter is the same and is determined by the number of iterations of the statement, but a callable statement is executed only once, and each of its parameter can be a varying length array with possibly a different length.

Syntax

void setDataBufferArray(
   unsigned int paramIndex,
   void *buffer,
   Type type,
   ub4 arraySize,
   ub4 *arrayLength,
   sb4 elementSize,
   ub2 *elementLength,
   sb2 *ind = NULL,
   ub2 *rc = NULL);

paramIndex

buffer

type

arraySize

arrayLength

elementSize

elementLemgth

ind

rcs

setDouble()

Sets a parameter to a C++ double value.

Syntax

void setDouble(
   unsigned int paramIndex,
   double val);

paramIndex

val

setErrorOnNull()

Enables/disables exceptions for reading of NULL values on paramIndex parameter of the statement. If exceptions are enabled, calling a getxxx() on paramIndex parameter would result in an SQLException if the parameter value is NULL. This call can also be used to disable exceptions.

Syntax

void setErrorOnNull(
   unsigned int paramIndex,
   bool causeException);

paramIndex

causeException

setErrorOnTruncate()

This method enables/disables exceptions when truncation occurs.

Syntax

void setErrorOnTruncate(
   unsigned int paramIndex,
   bool causeException);

paramIndex

causeException

setFloat()

Sets a parameter to a C++ float value.

Syntax

void setFloat(
   unsigned int paramIndex,
   float val);

paramIndex

val

setInt()

Sets a parameter to a C++ int value.

Syntax

void setInt(
   unsigned int paramIndex,
   int val);

paramIndex

val

setIntervalDS()

Sets a parameter to a IntervalDS value.

Syntax

void setIntervalDS(
   unsigned int paramIndex,
   const IntervalDS &val);

paramIndex

val

setIntervalYM()

Sets a parameter to a Interval value.

Syntax

void setIntervalYM(
   unsigned int paramIndex,
   const IntervalYM &val);

paramIndex

val

setMaxIterations()

Sets the maximum number of invocations that are made for the DML statement. This must be called before any parameters are set on the prepared statement. The larger the iterations, the larger the numbers of parameters sent to the server in one round trip. However, a large number causes more memory to be reserved for all the parameters. Note that this is just the maximum limit. Actual number of iterations depends on the number of calls to addIteration().

Syntax

void setMaxIterations(
   unsigned int maxIterations);

maxIterations

setMaxParamSize()

This method sets the maximum amount of data to be sent or received for the specified parameter. It only applies to character and binary data. If the maximum amount is exceeded, the excess data is discarded. This method can be very useful when working with a LONG column. It can be used to truncate the LONG column by reading or writing it into a string or Bytes data type.

If the getSQL() or setBytes() method has been called to bind a value to an IN/OUT parameter of a PL/SQL procedure, and the size of the OUT value is expected to be greater than the size of the IN value, then setMaxParamSize() should be called.

Syntax

void setMaxParamSize(
   unsigned int paramIndex,
   unsigned int maxSize);

paramIndex

maxSize

setNull()

Sets a parameter to SQL NULL. Note that you must specify the parameter's SQL type.

void setNull(
   unsigned int paramIndex,
   Type type);

void setNull(
   unsigned int paramIndex,
   Type type,
   const string &typeName,
   const string &schemaName = "")

void setNull(
   unsigned int paramIndex, 
   Type type, 
   UString &typeName, 
   UString &schemaName);

paramIndex

type

typeName

schemaName

setNumber()

Sets a parameter to a Number value.

Syntax

void setNumber(
   unsigned int paramIndex,
   const Number &val);

paramIndex

val

setObject()

Sets the value of a parameter using an object; use the C++.lang equivalent objects for integral values. The OCCI specification specifies a standard mapping from C++ Object types to SQL types. The given parameter C++ object is converted to the corresponding SQL type before being sent to the database.

Syntax

void setObject(
   unsigned int paramIndex,
   PObject* val);

paramIndex

val

sqltyp

setPrefetchMemorySize()

Sets the amount of memory that is used internally by OCCI to store data fetched during each round trip to the server. A value of 0 means that the amount of data fetched during the round trip is constrained by the FetchRowCount parameter. If both parameters are nonzero, the smaller of the two is used.

Syntax

void setPrefetchMemorySize(
   unsigned int bytes);

bytes

setPrefetchRowCount()

Sets the number of rows that are fetched internally by OCCI during each round trip to the server. A value of 0 means that the amount of data fetched during the round trip is constrained by the FetchMemorySize parameter. If both parameters are nonzero, the smaller of the two is used. If both of these parameters are zero, row count internally defaults to 1 row and that is the value returned from the getFetchRowCount() method.

Syntax

void setPrefetchRowCount(
   unsigned int rowCount);

rowCount

setRef()

Sets the value of a parameter to a reference. A Ref<T> instance is implicitly converted to a RefAny object during this call.

void setRef(
   unsigned int paramIndex,
   const RefAny &refAny); 

void setRef(
   unsigned int paramIndex,
   const RefAny &refAny,
   const string &typName,
   const string &schName = "");

void setRef(
   unsigned int paramIndex,
   const RefAny &refAny,
   const UString &typName,
   const UString &schName);

paramIndex

refAny

typName

schName

setRowid()

Sets a Rowid bytes array for a bind position.

Syntax

void setRowid(
   unsigned int paramIndex,
   const Bytes &val);

paramIndex

val

setSQL()

A new SQL string can be associated with a Statement object using this call. Resources associated with the previous SQL statement are freed. In particular, a previously obtained result set is invalidated. If an empty SQL string, "", is used when the Statement is created, a setSQL method with the proper SQL string must be performed first.

Syntax

void setSQL(
   const string &sql);

sql

setSQLUString()

Associate an SQL statement with this object. Unicode support: the client Environment should be initialized in OCCIUTIF16 mode.

Syntax

void setSQLUString(
   const UString &sql);

sql

setString()

Sets a parameter for a specified index.

Syntax

void setString(
   unsigned int paramIndex,
   const string &val);

paramIndex

val

setTimestamp()

Sets a parameter to a Timestamp value.

Syntax

void setTimestamp(
   unsigned int paramIndex,
   const Timestamp &val);

paramIndex

val

setUInt()

Sets a parameter to a C++ unsigned int value.

Syntax

void setUInt(
   unsigned int paramIndex,
   unsigned int val);

paramIndex

val

setUString()

Sets a parameter for a specified index; globalization enabled.

Syntax

void setUString(
   unsigned int paramIndex,
   const UString &val);

paramIndex

val

setVector()

Sets a parameter to a vector. This method is necessary when the type is a collection type, varrays or nested tables. The SQL Type of the elements in the collection should be compatible with the type of the vector. For example, if the collection is a varray of VARCHAR2, use vector<string>.

void setVector(
   Statement *stmt,
   unsigned int paramIndex,
   const vector< T > &vect,
   const string &schemaName,
   const string &typeName);

void setVector(
   Statement *stmt,
   unsigned int paramIndex,
   const vector<T* > &vect,
   const string &schemaName,
   const string &typeName);

void setVector(
   Statement *stmt,
   unsigned int paramIndex,
   const vector<BDouble> &vect
   const string &sqltype);

void setVector(
   Statement *stmt,
   unsigned int paramIndex,
   const vector<Bfile> &vect,
   const string &schemaName,
   const string &typeName);

void setVector(
   Statement *stmt,
   unsigned int paramIndex,
   const vector<Bfile> &vect,
   const UString &schemaName,
   const UString &typeName);

void setVector(
   Statement *stmt,
   unsigned int paramIndex,
   const vector<BFloat> &vect
   const string &sqltype);

void setVector(
   Statement *stmt,
   unsigned int paramIndex,
   const vector<Blob> &vect,
   const string &schemaName,
   const string &typeName);

void setVector(
   Statement *stmt,
   unsigned int paramIndex,
   const vector<Blob> &vect,
   const UString &schemaName,
   const UString &typeName);

void setVector(
   Statement *stmt,
   unsigned int paramIndex,
   const vector<Clob> &vect,
   const string &schemaName,
   const string &typeName);

void setVector(
   Statement *stmt,
   unsigned int paramIndex,
   const vector<Clob> &vect,
   const UString &schemaName,
   const UString &typeName);

void setVector(
   Statement *stmt,
   unsigned int paramIndex,
   const vector<Date> &vect,
   const string &schemaName,
   const string &typeName);

void setVector(
   Statement *stmt,
   unsigned int paramIndex,
   const vector<Date> &vect,
   const UString &schemaName,
   const UString &typeName);

void setVector(
   Statement *stmt,
   unsigned int paramIndex,
   const vector<double> &vect,
   const string &schemaName,
   const string &typeName);

void setVector(
   Statement *stmt,
   unsigned int paramIndex,
   const vector<double> &vect,
   const UString &schemaName,
   const UString &typeName);

void setVector(
   Statement *stmt,
   unsigned int paramIndex,
   const vector<float> &vect,
   const string &schemaName,
   const string &typeName);

void setVector(
   Statement *stmt,
   unsigned int paramIndex,
   const vector<float> &vect,
   const UString &schemaName,
   const UString &typeName);

void setVector(
   Statement *stmt,
   unsigned int paramIndex,
   const vector<int> &vect,
   const string &schemaName,
   const string &typeName);

void setVector(
   Statement *stmt,
   unsigned int paramIndex,
   const vector<int> &vect,
   const UString &schemaName,
   const UString &typeName);

void setVector(
   Statement *stmt,
   unsigned int paramIndex,
   const vector<IntervalDS> &vect,
   const string &schemaName,
   const string &typeName);

void setVector(
   Statement *stmt,
   unsigned int paramIndex,
   const vector<IntervalDS> &vect,
   const UString &schemaName,
   const UString &typeName);

void setVector(
   Statement *stmt,
   unsigned int paramIndex,
   const vector<IntervalYM> &vect,
   const string &schemaName,
   const string &typeName);

void setVector(
   Statement *stmt,
   unsigned int paramIndex,
   const vector<IntervalYM> &vect,
   const UString &schemaName,
   const UString &typeName);

void setVector(
   Statement *stmt,
   unsigned int paramIndex,
   const vector<Number> &vect,
   const string &schemaName,
   const string &typeName);

void setVector(
   Statement *stmt,
   unsigned int paramIndex,
   const vector<Number> &vect,
   const UString &schemaName,
   const UString &typeName);

void setVector(
   Statement *stmt,
   unsigned int paramIndex,
   const vector<RefAny> &vect,
   const string &schemaName,
   const string &typeName);

void setVector(
   Statement *stmt,
   unsigned int paramIndex,
   const vector<RefAny> &vect,
   const UString &schemaName,
   const UString &typeName);

void setVector(
   Statement *stmt,
   unsigned int paramIndex,
   const vector<string> &vect,
   const string &schemaName,
   const string &typeName);

void setVector(
   Statement *stmt,
   unsigned int paramIndex,
   const vector<string> &vect,
   const UString &schemaName,
   const UString &typeName);

void setVector(
   Statement *stmt,
   unsigned int paramIndex,
   const vector<Timestamp> &vect,
   const string &schemaName,
   const string &typeName);

void setVector(
   Statement *stmt,
   unsigned int paramIndex,
   const vector<Timestamp> &vect,
   const UString &schemaName,
   const UString &typeName);

void setVector(
   Statement *stmt,
   unsigned int paramIndex,
   const vector<unsigned int> &vect,
   const string &schemaName,
   const string &typeName);

void setVector(
   Statement *stmt,
   unsigned int paramIndex,
   const vector<unsigned int> &vect,
   const UString &schemaName,
   const UString &typeName);

void setVector(
   Statement *stmt,
   unsigned int paramIndex,
   vector<Bfile> &vect,
   string &sqltype);

void setVector(
   Statement *stmt,
   unsigned int paramIndex,
   vector<Blob> &vect,
   string &sqltype);

void setVector(
   Statement *stmt,
   unsigned int paramIndex,
   vector<Clob> &vect,
   string &sqltype);

void setVector(
   Statement *stmt,
   unsigned int paramIndex,
   vector<Date> &vect,
   string &sqltype);

void setVector(
   Statement *stmt,
   unsigned int paramIndex,
   vector<double> &vect,
   string &sqltype);

void setVector(
   Statement *stmt,
   unsigned int paramIndex,
   vector<float> &vect,
   string &sqltype);

void setVector(
   Statement *stmt,
   unsigned int paramIndex,
   vector<int> &vect,
   string &sqltype);

void setVector(
   Statement *stmt,
   unsigned int paramIndex,
   vector<IntervalDS> &vect,
   string &sqltype);

void setVector(
   Statement *stmt,
   unsigned int paramIndex,
   vector<IntervalYM> &vect,
   string &sqltype);

void setVector(
   Statement *stmt,
   unsigned int paramIndex,
   vector<Number> &vect,
   string &sqltype);

void setVector(
   Statement *stmt,
   unsigned int paramIndex,
   vector<RefAny> &vect,
   string &sqltype);

void setVector(
   Statement *stmt,
   unsigned int paramIndex,
   vector<string> &vect,
   string &sqltype);

void setVector(
   Statement *stmt,
   unsigned int paramIndex,
   vector<Timestamp> &vect,
   string &sqltype);

void setVector(
   Statement *stmt,
   unsigned int paramIndex,
   vector<unsigned int> &vect,
   string &sqltype);

template <class T>
void setVector(
   Statement *stmt,
   unsigned int paramIndex,
   const vector< T* > &vect,
   const string &sqltype);

template <class T>
void setVector(
   Statement *stmt,
   unsigned int paramIndex,
   const vector<T> &vect,
   const string &sqltype);

template <class T>
void setVector(
   Statement *stmt,
   unsigned int paramIndex,
   vector<Ref<T>> &vect,
   string &sqltype);

stmt

paramIndex

vect

sqltype

schemaName

typeName

setVectorOfRefs()

Sets a parameter to a vector; is necessary when the type is a collection of REFs or nested tables of REFs.

template  <class T> void setVectorOfRefs(
   Statement *stmt, unsigned int paramIndex,
   const vector<Ref<T> > &vect,
   const string &sqltype);

template  <class T>  void setVectorOfRefs(
   Statement *stmt,
   unsigned int paramIndex,
   const vector<Ref<T> > &vect,
   const string &sqltype);

template  <class T> void setVectorOfRefs(
   Statement *stmt,
   unsigned int paramIndex,
   const vector<Ref<T>> &vect,
   const string &schemaName,
   const string &typeName);

template  <class T> void setVectorOfRefs(
   Statement *stmt,
   unsigned int paramIndex,
   const vector<Ref<T> &vect,
   const UString &schemaName,
   const UString &typeName);

template <class T>  void setVector(
Statement *stmt,
unsigned int paramIndex,
const vector<T* > &vect,
const UString &schemaName,
const UString &typeName);

stmt

paramIndex

vect

sqltype

schemaName

typeName

status()

Returns the current status of the statement. Useful when there is streamed data to be written (or read). Other methods such as getCurrentStreamParam() and getCurrentIteration() can be called to find out the streamed parameter that must be written and the current iteration number for an iterative or array execute. The status()method can be called repeatedly to find out the status of the execution.

The returned value, Status, is defined in Table 13-42.

Syntax

Status status() const;