TZMySQLPreparedStatement Class Reference

Implements Prepared SQL Statement. More...

Inheritance diagram for TZMySQLPreparedStatement:

TZEmulatedPreparedStatement TZAbstractPreparedStatement TZAbstractStatement IZPreparedStatement TInterfacedObject IZStatement

List of all members.

Public Member Functions

 AddBatch (const string SQL)
 Adds an SQL command to the current batch of commmands for this Statement object.
 AddBatchPrepared ()
 Adds a set of parameters to this PreparedStatement object's batch of commands.
 Cancel ()
 Cancels this Statement object if both the DBMS and driver support aborting an SQL statement.
 ClearBatch ()
 Makes the set of commands in the current batch empty.
 ClearParameters ()
 Clears the current parameter values immediately.
 ClearWarnings ()
 Clears all the warnings reported on this Statement object.
 Close ()
 Closes this statement and frees all resources.
Boolean Execute (const string SQL)
 Executes an SQL statement that may return multiple results.
TIntegerDynArray ExecuteBatch ()
 Submits a batch of commands to the database for execution and if all commands execute successfully, returns an array of update counts.
Boolean ExecutePrepared ()
 Executes the SQL query in this PreparedStatement object and returns the result set generated by the query.
IZResultSet ExecuteQuery (const string SQL)
 Executes an SQL statement that returns a single ResultSet object.
IZResultSet ExecuteQueryPrepared ()
 Executes the SQL query in this PreparedStatement object and returns the result set generated by the query.
Integer ExecuteUpdate (const string SQL)
 Executes an SQL INSERT, UPDATE or DELETE statement.
Integer ExecuteUpdatePrepared ()
 Executes the SQL INSERT, UPDATE or DELETE statement in this PreparedStatement object.
IZConnection GetConnection ()
 Returns the Connection object that produced this Statement object.
TZFetchDirection GetFetchDirection ()
 Retrieves the direction for fetching rows from database tables that is the default for result sets generated from this Statement object.
Integer GetFetchSize ()
 Retrieves the number of result set rows that is the default fetch size for result sets generated from this Statement object.
TZLocateUpdatesMode GetLocateUpdates ()
 Gets the current value for locate updates.
Integer GetMaxFieldSize ()
 Returns the maximum number of bytes allowed for any column value.
Integer GetMaxRows ()
 Retrieves the maximum number of rows that a ResultSet object can contain.
IZResultSetMetaData GetMetaData ()
 Gets the number, types and properties of a ResultSet object's columns.
Boolean GetMoreResults ()
 Moves to a Statement object's next result.
TStrings GetParameters ()
 Gets statement parameters.
TZPostUpdatesMode GetPostUpdates ()
 Gets the current value for post updates.
Integer GetQueryTimeout ()
 Retrieves the number of seconds the driver will wait for a Statement object to execute.
IZResultSet GetResultSet ()
 Returns the current result as a ResultSet object.
TZResultSetConcurrency GetResultSetConcurrency ()
 Retrieves the result set concurrency for ResultSet objects generated by this Statement object.
TZResultSetType GetResultSetType ()
 Retrieves the result set type for ResultSet objects generated by this Statement object.
Integer GetUpdateCount ()
 Returns the current result as an update count; if the result is a ResultSet object or there are no more results, -1 is returned.
EZSQLWarning GetWarnings ()
 Retrieves the first warning reported by calls on this Statement object.
 SetAsciiStream (Integer ParameterIndex, TStream Value)
 Sets the designated parameter to the given input stream, which will have the specified number of bytes.
 SetBigDecimal (Integer ParameterIndex, Extended Value)
 Sets the designated parameter to a java.math.BigDecimal value.
 SetBinaryStream (Integer ParameterIndex, TStream Value)
 Sets the designated parameter to the given input stream, which will have the specified number of bytes.
 SetBlob (Integer ParameterIndex, TZSQLType SQLType, IZBlob Value)
 Sets a blob object for the specified parameter.
 SetBoolean (Integer ParameterIndex, Boolean Value)
 Sets the designated parameter to a Java boolean value.
 SetByte (Integer ParameterIndex, ShortInt Value)
 Sets the designated parameter to a Java byte value.
 SetBytes (Integer ParameterIndex, const TByteDynArray Value)
 Sets the designated parameter to a Java array of bytes.
 SetCursorName (const string Value)
 Defines the SQL cursor name that will be used by subsequent Statement object execute methods.
 SetDate (Integer ParameterIndex, TDateTime Value)
 Sets the designated parameter to a <code<java.sql.Date value.
 SetDefaultValue (Integer ParameterIndex, const string Value)
 Sets the designated parameter the default SQL value.
 SetDouble (Integer ParameterIndex, Double Value)
 Sets the designated parameter to a Java double value.
 SetEscapeProcessing (Boolean Value)
 Sets escape processing on or off.
 SetFetchDirection (TZFetchDirection Value)
 Gives the driver a hint as to the direction in which the rows in a result set will be processed.
 SetFetchSize (Integer Value)
 Gives the JDBC driver a hint as to the number of rows that should be fetched from the database when more rows are needed.
 SetFloat (Integer ParameterIndex, Single Value)
 Sets the designated parameter to a Java float value.
 SetInt (Integer ParameterIndex, Integer Value)
 Sets the designated parameter to a Java int value.
 SetLocateUpdates (TZLocateUpdatesMode Value)
 Sets a new value for locate updates.
 SetLong (Integer ParameterIndex, Int64 Value)
 Sets the designated parameter to a Java long value.
 SetMaxFieldSize (Integer Value)
 Sets the limit for the maximum number of bytes in a column to the given number of bytes.
 SetMaxRows (Integer Value)
 Sets the limit for the maximum number of rows that any ResultSet object can contain to the given number.
 SetNull (Integer ParameterIndex, TZSQLType SQLType)
 Sets the designated parameter to SQL NULL.
 SetPChar (Integer ParameterIndex, PChar Value)
 Sets the designated parameter to a Java String value.
 SetPostUpdates (TZPostUpdatesMode Value)
 Sets a new value for post updates.
 SetQueryTimeout (Integer Value)
 Sets the number of seconds the driver will wait for a Statement object to execute to the given number of seconds.
 SetResultSetConcurrency (TZResultSetConcurrency Value)
 Sets a result set concurrency for ResultSet objects generated by this Statement object.
 SetResultSetType (TZResultSetType Value)
 Sets a result set type for ResultSet objects generated by this Statement object.
 SetShort (Integer ParameterIndex, SmallInt Value)
 Sets the designated parameter to a Java short value.
 SetString (Integer ParameterIndex, const string Value)
 Sets the designated parameter to a Java String value.
 SetTime (Integer ParameterIndex, TDateTime Value)
 Sets the designated parameter to a java.sql.Time value.
 SetTimestamp (Integer ParameterIndex, TDateTime Value)
 Sets the designated parameter to a java.sql.Timestamp value.
 SetUnicodeStream (Integer ParameterIndex, TStream Value)
 Sets the designated parameter to the given input stream, which will have the specified number of bytes.
 SetUnicodeString (Integer ParameterIndex, const WideString Value)
 Sets the designated parameter to a Object Pascal WideString value.
 SetValue (Integer ParameterIndex, const TZVariant Value)
 Sets a variant value for the specified parameter.
 TZMySQLPreparedStatement (IZMySQLPlainDriver PlainDriver, IZConnection Connection, const string SQL, TStrings Info, PZMySQLConnect Handle)
 Constructs this object and assignes the main properties.

Protected Member Functions

IZStatement CreateExecStatement ()
 Creates a temporary statement which executes queries.
string GetEscapeString (const string Value)
 Converts an string into escape MySQL format.
IZStatement GetExecStatement ()
 Creates a temporary statement which executes queries.
string PrepareSQLParam (Integer ParamIndex)
 Prepares an SQL parameter for the query.
string PrepareSQLQuery ()
 Prepares an SQL statement and inserts all data values.
 RaiseUnsupportedException ()
 Raises unsupported operation exception.
 SetInParam (Integer ParameterIndex, TZSQLType SQLType, const TZVariant Value)
 Sets a variant value into specified parameter.
 SetInParamCount (Integer NewParamCount)
 Sets a new parameter count and initializes the buffers.
TStrings TokenizeSQLQuery ()
 Splits a SQL query into a list of sections.

Protected Attributes

TStrings BatchQueries
TStrings CachedQuery
Boolean Closed
IZConnection Connection
string CursorName
Boolean EscapeProcessing
IZStatement ExecStatement
TZFetchDirection FetchDirection
Integer FetchSize
TStrings Info
Integer InParamCount
TStringDynArray InParamDefaultValues
TZSQLTypeArray InParamTypes
TZVariantDynArray InParamValues
IZResultSet LastResultSet
IZStatement LastStatement
Integer LastUpdateCount
Integer MaxFieldSize
Integer MaxRows
Integer QueryTimeout
TZResultSetConcurrency ResultSetConcurrency
TZResultSetType ResultSetType
string SQL

Private Attributes

PZMySQLConnect FHandle
IZMySQLPlainDriver FPlainDriver


Detailed Description

Implements Prepared SQL Statement.

Definition at line 131 of file ZDbcMySqlStatement.pas.


Constructor & Destructor Documentation

TZMySQLPreparedStatement::TZMySQLPreparedStatement ( IZMySQLPlainDriver  PlainDriver,
IZConnection  Connection,
const string  SQL,
TStrings  Info,
PZMySQLConnect  Handle 
)

Constructs this object and assignes the main properties.

Parameters:
PlainDriver a native MySQL Plain driver.
Connection a database connection object.
Info a statement parameters.
Handle a connection handle pointer.

Definition at line 445 of file ZDbcMySqlStatement.pas.


Member Function Documentation

TZAbstractStatement::AddBatch ( const string  SQL  )  [inherited]

Adds an SQL command to the current batch of commmands for this Statement object.

This method is optional.

Parameters:
sql typically this is a static SQL INSERT or UPDATE statement

Reimplemented from IZStatement.

Definition at line 1349 of file ZDbcStatement.pas.

TZAbstractPreparedStatement::AddBatchPrepared (  )  [inherited]

Adds a set of parameters to this PreparedStatement object's batch of commands.

See also:
Statement::addBatch

Reimplemented from IZPreparedStatement.

Definition at line 2196 of file ZDbcStatement.pas.

TZAbstractStatement::Cancel (  )  [inherited]

Cancels this Statement object if both the DBMS and driver support aborting an SQL statement.

This method can be used by one thread to cancel a statement that is being executed by another thread.

Reimplemented from IZStatement.

Reimplemented in TZASAStatement, TZASAPreparedStatement, and TZASACallableStatement.

Definition at line 990 of file ZDbcStatement.pas.

TZAbstractStatement::ClearBatch (  )  [inherited]

Makes the set of commands in the current batch empty.

This method is optional.

Reimplemented from IZStatement.

Definition at line 1362 of file ZDbcStatement.pas.

TZAbstractPreparedStatement::ClearParameters (  )  [inherited]

Clears the current parameter values immediately.

In general, parameter values remain in force for repeated use of a statement. Setting a parameter value automatically clears its previous value. However, in some cases it is useful to immediately release the resources used by the current parameter values; this can be done by calling the method clearParameters.

Reimplemented from IZPreparedStatement.

Reimplemented in TZAdoPreparedStatement, and TZAbstractCallableStatement.

Definition at line 2156 of file ZDbcStatement.pas.

TZAbstractStatement::ClearWarnings (  )  [inherited]

Clears all the warnings reported on this Statement object.

After a call to this method, the method getWarnings will return null until a new warning is reported for this Statement object.

Reimplemented from IZStatement.

Reimplemented in TZASAStatement, TZASAPreparedStatement, and TZASACallableStatement.

Definition at line 1027 of file ZDbcStatement.pas.

TZEmulatedPreparedStatement::Close (  )  [inherited]

Closes this statement and frees all resources.

Reimplemented from TZAbstractStatement.

Definition at line 2804 of file ZDbcStatement.pas.

IZStatement TZMySQLPreparedStatement::CreateExecStatement (  )  [protected]

Creates a temporary statement which executes queries.

Parameters:
Info a statement parameters.
Returns:
a created statement object.

Reimplemented from TZEmulatedPreparedStatement.

Definition at line 466 of file ZDbcMySqlStatement.pas.

Boolean TZEmulatedPreparedStatement::Execute ( const string  SQL  )  [inherited]

Executes an SQL statement that may return multiple results.

Under some (uncommon) situations a single SQL statement may return multiple result sets and/or update counts. Normally you can ignore this unless you are (1) executing a stored procedure that you know may return multiple results or (2) you are dynamically executing an unknown SQL string. The methods execute, getMoreResults, getResultSet, and getUpdateCount let you navigate through multiple results.

The execute method executes an SQL statement and indicates the form of the first result. You can then use the methods getResultSet or getUpdateCount to retrieve the result, and getMoreResults to move to any subsequent result(s).

Parameters:
sql any SQL statement
Returns:
true if the next result is a ResultSet object; false if it is an update count or there are no more results

Reimplemented from TZAbstractStatement.

Definition at line 2835 of file ZDbcStatement.pas.

TIntegerDynArray TZAbstractStatement::ExecuteBatch (  )  [inherited]

Submits a batch of commands to the database for execution and if all commands execute successfully, returns an array of update counts.

The int elements of the array that is returned are ordered to correspond to the commands in the batch, which are ordered according to the order in which they were added to the batch. The elements in the array returned by the method executeBatch may be one of the following:

  1. A number greater than or equal to zero -- indicates that the command was processed successfully and is an update count giving the number of rows in the database that were affected by the command's execution
  2. A value of -2 -- indicates that the command was processed successfully but that the number of rows affected is unknown

    If one of the commands in a batch update fails to execute properly, this method throws a BatchUpdateException, and a JDBC driver may or may not continue to process the remaining commands in the batch. However, the driver's behavior must be consistent with a particular DBMS, either always continuing to process commands or never continuing to process commands. If the driver continues processing after a failure, the array returned by the method BatchUpdateException.getUpdateCounts will contain as many elements as there are commands in the batch, and at least one of the elements will be the following:

  3. A value of -3 -- indicates that the command failed to execute successfully and occurs only if a driver continues to process commands after a command fails

A driver is not required to implement this method. The possible implementations and return values have been modified in the Java 2 SDK, Standard Edition, version 1.3 to accommodate the option of continuing to proccess commands in a batch update after a BatchUpdateException obejct has been thrown.

Returns:
an array of update counts containing one element for each command in the batch. The elements of the array are ordered according to the order in which commands were added to the batch.

Reimplemented from IZStatement.

Definition at line 1413 of file ZDbcStatement.pas.

Boolean TZEmulatedPreparedStatement::ExecutePrepared (  )  [inherited]

Executes the SQL query in this PreparedStatement object and returns the result set generated by the query.

Returns:
a ResultSet object that contains the data produced by the query; never null

Reimplemented from TZAbstractPreparedStatement.

Definition at line 2892 of file ZDbcStatement.pas.

IZResultSet TZEmulatedPreparedStatement::ExecuteQuery ( const string  SQL  )  [inherited]

Executes an SQL statement that returns a single ResultSet object.

Parameters:
sql typically this is a static SQL SELECT statement
Returns:
a ResultSet object that contains the data produced by the given query; never null

Reimplemented from TZAbstractStatement.

Definition at line 2855 of file ZDbcStatement.pas.

IZResultSet TZEmulatedPreparedStatement::ExecuteQueryPrepared (  )  [inherited]

Executes the SQL query in this PreparedStatement object and returns the result set generated by the query.

Returns:
a ResultSet object that contains the data produced by the query; never null

Reimplemented from TZAbstractPreparedStatement.

Definition at line 2907 of file ZDbcStatement.pas.

Integer TZEmulatedPreparedStatement::ExecuteUpdate ( const string  SQL  )  [inherited]

Executes an SQL INSERT, UPDATE or DELETE statement.

In addition, SQL statements that return nothing, such as SQL DDL statements, can be executed.

Parameters:
sql an SQL INSERT, UPDATE or DELETE statement or an SQL statement that returns nothing
Returns:
either the row count for INSERT, UPDATE or DELETE statements, or 0 for SQL statements that return nothing

Reimplemented from TZAbstractStatement.

Definition at line 2875 of file ZDbcStatement.pas.

Integer TZEmulatedPreparedStatement::ExecuteUpdatePrepared (  )  [inherited]

Executes the SQL INSERT, UPDATE or DELETE statement in this PreparedStatement object.

In addition, SQL statements that return nothing, such as SQL DDL statements, can be executed.

Returns:
either the row count for INSERT, UPDATE or DELETE statements; or 0 for SQL statements that return nothing

Reimplemented from TZAbstractPreparedStatement.

Definition at line 2925 of file ZDbcStatement.pas.

IZConnection TZAbstractStatement::GetConnection (  )  [inherited]

Returns the Connection object that produced this Statement object.

Returns:
the connection that produced this statement

Reimplemented from IZStatement.

Definition at line 1436 of file ZDbcStatement.pas.

string TZMySQLPreparedStatement::GetEscapeString ( const string  Value  )  [protected]

Converts an string into escape MySQL format.

Parameters:
Value a regular string.
Returns:
a string in MySQL escape format.

Definition at line 479 of file ZDbcMySqlStatement.pas.

IZStatement TZEmulatedPreparedStatement::GetExecStatement (  )  [protected, inherited]

Creates a temporary statement which executes queries.

Parameters:
Info a statement parameters.
Returns:
a created statement object.

Definition at line 2711 of file ZDbcStatement.pas.

TZFetchDirection TZAbstractStatement::GetFetchDirection (  )  [inherited]

Retrieves the direction for fetching rows from database tables that is the default for result sets generated from this Statement object.

If this Statement object has not set a fetch direction by calling the method setFetchDirection, the return value is implementation-specific.

Returns:
the default fetch direction for result sets generated from this Statement object

Reimplemented from IZStatement.

Definition at line 1163 of file ZDbcStatement.pas.

Integer TZAbstractStatement::GetFetchSize (  )  [inherited]

Retrieves the number of result set rows that is the default fetch size for result sets generated from this Statement object.

If this Statement object has not set a fetch size by calling the method setFetchSize, the return value is implementation-specific.

Returns:
the default fetch size for result sets generated from this Statement object

Reimplemented from IZStatement.

Definition at line 1202 of file ZDbcStatement.pas.

TZLocateUpdatesMode TZAbstractStatement::GetLocateUpdates (  )  [inherited]

Gets the current value for locate updates.

Returns:
the current value for locate updates.

Reimplemented from IZStatement.

Definition at line 1296 of file ZDbcStatement.pas.

Integer TZAbstractStatement::GetMaxFieldSize (  )  [inherited]

Returns the maximum number of bytes allowed for any column value.

This limit is the maximum number of bytes that can be returned for any column value. The limit applies only to BINARY, VARBINARY, LONGVARBINARY, CHAR, VARCHAR, and LONGVARCHAR columns. If the limit is exceeded, the excess data is silently discarded.

Returns:
the current max column size limit; zero means unlimited

Reimplemented from IZStatement.

Definition at line 873 of file ZDbcStatement.pas.

Integer TZAbstractStatement::GetMaxRows (  )  [inherited]

Retrieves the maximum number of rows that a ResultSet object can contain.

If the limit is exceeded, the excess rows are silently dropped.

Returns:
the current max row limit; zero means unlimited

Reimplemented from IZStatement.

Definition at line 909 of file ZDbcStatement.pas.

IZResultSetMetaData TZAbstractPreparedStatement::GetMetaData (  )  [inherited]

Gets the number, types and properties of a ResultSet object's columns.

Returns:
the description of a ResultSet object's columns

Reimplemented in TZDBLibPreparedStatementEmulated.

Definition at line 2208 of file ZDbcStatement.pas.

Boolean TZAbstractStatement::GetMoreResults (  )  [inherited]

Moves to a Statement object's next result.

It returns true if this result is a ResultSet object. This method also implicitly closes any current ResultSet object obtained with the method getResultSet.

There are no more results when the following is true:

        (!getMoreResults() && (getUpdateCount() == -1)
  

Returns:
true if the next result is a ResultSet object; false if it is an update count or there are no more results
See also:
execute

Reimplemented from IZStatement.

Reimplemented in TZAdoStatement, TZASAStatement, TZASAPreparedStatement, TZASACallableStatement, TZDBLibStatement, TZDBLibCallableStatement, and TZMySQLStatement.

Definition at line 1144 of file ZDbcStatement.pas.

TStrings TZAbstractStatement::GetParameters (  )  [inherited]

Gets statement parameters.

Returns:
a list with statement parameters.

Reimplemented from IZStatement.

Definition at line 1448 of file ZDbcStatement.pas.

TZPostUpdatesMode TZAbstractStatement::GetPostUpdates (  )  [inherited]

Gets the current value for post updates.

Returns:
the current value for post updates.

Reimplemented from IZStatement.

Definition at line 1321 of file ZDbcStatement.pas.

Integer TZAbstractStatement::GetQueryTimeout (  )  [inherited]

Retrieves the number of seconds the driver will wait for a Statement object to execute.

If the limit is exceeded, a SQLException is thrown.

Returns:
the current query timeout limit in seconds; zero means unlimited

Reimplemented from IZStatement.

Definition at line 960 of file ZDbcStatement.pas.

IZResultSet TZAbstractStatement::GetResultSet (  )  [inherited]

Returns the current result as a ResultSet object.

This method should be called only once per result.

Returns:
the current result as a ResultSet object; null if the result is an update count or there are no more results
See also:
execute

Reimplemented from IZStatement.

Definition at line 1104 of file ZDbcStatement.pas.

TZResultSetConcurrency TZAbstractStatement::GetResultSetConcurrency (  )  [inherited]

Retrieves the result set concurrency for ResultSet objects generated by this Statement object.

Returns:
either ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE

Reimplemented from IZStatement.

Definition at line 1251 of file ZDbcStatement.pas.

TZResultSetType TZAbstractStatement::GetResultSetType (  )  [inherited]

Retrieves the result set type for ResultSet objects generated by this Statement object.

Returns:
one of ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE

Reimplemented from IZStatement.

Definition at line 1284 of file ZDbcStatement.pas.

Integer TZAbstractStatement::GetUpdateCount (  )  [inherited]

Returns the current result as an update count; if the result is a ResultSet object or there are no more results, -1 is returned.

This method should be called only once per result.

Returns:
the current result as an update count; -1 if the current result is a ResultSet object or there are no more results
See also:
execute

Reimplemented from IZStatement.

Definition at line 1121 of file ZDbcStatement.pas.

EZSQLWarning TZAbstractStatement::GetWarnings (  )  [inherited]

Retrieves the first warning reported by calls on this Statement object.

Subsequent Statement object warnings will be chained to this SQLWarning object.

The warning chain is automatically cleared each time a statement is (re)executed.

Note: If you are processing a ResultSet object, any warnings associated with reads on that ResultSet object will be chained on it.

Returns:
the first SQLWarning object or null

Reimplemented from IZStatement.

Reimplemented in TZASAStatement, TZASAPreparedStatement, and TZASACallableStatement.

Definition at line 1012 of file ZDbcStatement.pas.

string TZMySQLPreparedStatement::PrepareSQLParam ( Integer  ParamIndex  )  [protected]

Prepares an SQL parameter for the query.

Parameters:
ParameterIndex the first parameter is 1, the second is 2, ...
Returns:
a string representation of the parameter.

Reimplemented from TZEmulatedPreparedStatement.

Definition at line 508 of file ZDbcMySqlStatement.pas.

string TZEmulatedPreparedStatement::PrepareSQLQuery (  )  [protected, inherited]

Prepares an SQL statement and inserts all data values.

Returns:
a prepared SQL statement.

Definition at line 2776 of file ZDbcStatement.pas.

TZAbstractStatement::RaiseUnsupportedException (  )  [protected, inherited]

Raises unsupported operation exception.

Definition at line 779 of file ZDbcStatement.pas.

TZAbstractPreparedStatement::SetAsciiStream ( Integer  ParameterIndex,
TStream  Value 
) [inherited]

Sets the designated parameter to the given input stream, which will have the specified number of bytes.

When a very large ASCII value is input to a LONGVARCHAR parameter, it may be more practical to send it via a java.io.InputStream. Data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from ASCII to the database char format.

Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.

Parameters:
parameterIndex the first parameter is 1, the second is 2, ...
x the Java input stream that contains the ASCII parameter value
length the number of bytes in the stream

Reimplemented from IZPreparedStatement.

Definition at line 2028 of file ZDbcStatement.pas.

TZAbstractPreparedStatement::SetBigDecimal ( Integer  ParameterIndex,
Extended  Value 
) [inherited]

Sets the designated parameter to a java.math.BigDecimal value.

The driver converts this to an SQL NUMERIC value when it sends it to the database.

Parameters:
parameterIndex the first parameter is 1, the second is 2, ...
x the parameter value

Reimplemented from IZPreparedStatement.

Definition at line 1801 of file ZDbcStatement.pas.

TZAbstractPreparedStatement::SetBinaryStream ( Integer  ParameterIndex,
TStream  Value 
) [inherited]

Sets the designated parameter to the given input stream, which will have the specified number of bytes.

When a very large binary value is input to a LONGVARBINARY parameter, it may be more practical to send it via a java.io.InputStream object. The data will be read from the stream as needed until end-of-file is reached.

Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.

Parameters:
parameterIndex the first parameter is 1, the second is 2, ...
x the java input stream which contains the binary parameter value

Reimplemented from IZPreparedStatement.

Definition at line 2081 of file ZDbcStatement.pas.

TZAbstractPreparedStatement::SetBlob ( Integer  ParameterIndex,
TZSQLType  SQLType,
IZBlob  Value 
) [inherited]

Sets a blob object for the specified parameter.

Parameters:
ParameterIndex the first parameter is 1, the second is 2, ...
Value the java blob object.

Reimplemented from IZPreparedStatement.

Definition at line 2096 of file ZDbcStatement.pas.

TZAbstractPreparedStatement::SetBoolean ( Integer  ParameterIndex,
Boolean  Value 
) [inherited]

Sets the designated parameter to a Java boolean value.

The driver converts this to an SQL BIT value when it sends it to the database.

Parameters:
parameterIndex the first parameter is 1, the second is 2, ...
x the parameter value

Reimplemented from IZPreparedStatement.

Definition at line 1619 of file ZDbcStatement.pas.

References p.

TZAbstractPreparedStatement::SetByte ( Integer  ParameterIndex,
ShortInt  Value 
) [inherited]

Sets the designated parameter to a Java byte value.

The driver converts this to an SQL TINYINT value when it sends it to the database.

Parameters:
parameterIndex the first parameter is 1, the second is 2, ...
x the parameter value

Reimplemented from IZPreparedStatement.

Definition at line 1645 of file ZDbcStatement.pas.

TZAbstractPreparedStatement::SetBytes ( Integer  ParameterIndex,
const TByteDynArray  Value 
) [inherited]

Sets the designated parameter to a Java array of bytes.

The driver converts this to an SQL VARBINARY or LONGVARBINARY (depending on the argument's size relative to the driver's limits on VARBINARY values) when it sends it to the database.

Parameters:
parameterIndex the first parameter is 1, the second is 2, ...
x the parameter value

Reimplemented from IZPreparedStatement.

Definition at line 1915 of file ZDbcStatement.pas.

TZAbstractStatement::SetCursorName ( const string  Value  )  [inherited]

Defines the SQL cursor name that will be used by subsequent Statement object execute methods.

This name can then be used in SQL positioned update/delete statements to identify the current row in the ResultSet object generated by this statement. If the database doesn't support positioned update/delete, this method is a noop. To insure that a cursor has the proper isolation level to support updates, the cursor's SELECT statement should be of the form 'select for update ...'. If the 'for update' phrase is omitted, positioned updates may fail.

Note: By definition, positioned update/delete execution must be done by a different Statement object than the one which generated the ResultSet object being used for positioning. Also, cursor names must be unique within a connection.

Parameters:
name the new cursor name, which must be unique within a connection

Reimplemented from IZStatement.

Definition at line 1053 of file ZDbcStatement.pas.

TZAbstractPreparedStatement::SetDate ( Integer  ParameterIndex,
TDateTime  Value 
) [inherited]

Sets the designated parameter to a <code<java.sql.Date value.

The driver converts this to an SQL DATE value when it sends it to the database.

Parameters:
parameterIndex the first parameter is 1, the second is 2, ...
x the parameter value

Reimplemented from IZPreparedStatement.

Definition at line 1941 of file ZDbcStatement.pas.

TZAbstractPreparedStatement::SetDefaultValue ( Integer  ParameterIndex,
const string  Value 
) [inherited]

Sets the designated parameter the default SQL value.

Note: You must specify the default value.

Parameters:
parameterIndex the first parameter is 1, the second is 2, ...
Value the default value normally defined in the field's DML SQL statement

Reimplemented from IZPreparedStatement.

Definition at line 1581 of file ZDbcStatement.pas.

TZAbstractPreparedStatement::SetDouble ( Integer  ParameterIndex,
Double  Value 
) [inherited]

Sets the designated parameter to a Java double value.

The driver converts this to an SQL DOUBLE value when it sends it to the database.

Parameters:
parameterIndex the first parameter is 1, the second is 2, ...
x the parameter value

Reimplemented from IZPreparedStatement.

Definition at line 1775 of file ZDbcStatement.pas.

TZAbstractStatement::SetEscapeProcessing ( Boolean  Value  )  [inherited]

Sets escape processing on or off.

If escape scanning is on (the default), the driver will do escape substitution before sending the SQL to the database.

Note: Since prepared statements have usually been parsed prior to making this call, disabling escape processing for prepared statements will have no effect.

Parameters:
enable true to enable; false to disable

Reimplemented from IZStatement.

Definition at line 944 of file ZDbcStatement.pas.

TZAbstractStatement::SetFetchDirection ( TZFetchDirection  Value  )  [inherited]

Gives the driver a hint as to the direction in which the rows in a result set will be processed.

The hint applies only to result sets created using this Statement object. The default value is ResultSet.FETCH_FORWARD.

Note that this method sets the default fetch direction for result sets generated by this Statement object. Each result set has its own methods for getting and setting its own fetch direction.

Parameters:
direction the initial direction for processing rows

Reimplemented from IZStatement.

Definition at line 1183 of file ZDbcStatement.pas.

TZAbstractStatement::SetFetchSize ( Integer  Value  )  [inherited]

Gives the JDBC driver a hint as to the number of rows that should be fetched from the database when more rows are needed.

The number of rows specified affects only result sets created using this statement. If the value specified is zero, then the hint is ignored. The default value is zero.

Parameters:
rows the number of rows to fetch

Reimplemented from IZStatement.

Definition at line 1219 of file ZDbcStatement.pas.

TZAbstractPreparedStatement::SetFloat ( Integer  ParameterIndex,
Single  Value 
) [inherited]

Sets the designated parameter to a Java float value.

The driver converts this to an SQL FLOAT value when it sends it to the database.

Parameters:
parameterIndex the first parameter is 1, the second is 2, ...
x the parameter value

Reimplemented from IZPreparedStatement.

Definition at line 1749 of file ZDbcStatement.pas.

TZAbstractPreparedStatement::SetInParam ( Integer  ParameterIndex,
TZSQLType  SQLType,
const TZVariant  Value 
) [protected, inherited]

Sets a variant value into specified parameter.

Parameters:
ParameterIndex a index of the parameter.
SqlType a parameter SQL type. Value a new parameter value.

Reimplemented in TZAdoPreparedStatement.

Definition at line 1524 of file ZDbcStatement.pas.

TZAbstractPreparedStatement::SetInParamCount ( Integer  NewParamCount  )  [protected, inherited]

Sets a new parameter count and initializes the buffers.

Parameters:
NewParamCount a new parameters count.

Reimplemented in TZAdoPreparedStatement, and TZDBLibCallableStatement.

Definition at line 1494 of file ZDbcStatement.pas.

TZAbstractPreparedStatement::SetInt ( Integer  ParameterIndex,
Integer  Value 
) [inherited]

Sets the designated parameter to a Java int value.

The driver converts this to an SQL INTEGER value when it sends it to the database.

Parameters:
parameterIndex the first parameter is 1, the second is 2, ...
x the parameter value

Reimplemented from IZPreparedStatement.

Definition at line 1697 of file ZDbcStatement.pas.

TZAbstractStatement::SetLocateUpdates ( TZLocateUpdatesMode  Value  )  [inherited]

Sets a new value for locate updates.

Parameters:
Value a new value for locate updates.

Reimplemented from IZStatement.

Definition at line 1308 of file ZDbcStatement.pas.

TZAbstractPreparedStatement::SetLong ( Integer  ParameterIndex,
Int64  Value 
) [inherited]

Sets the designated parameter to a Java long value.

The driver converts this to an SQL BIGINT value when it sends it to the database.

Parameters:
parameterIndex the first parameter is 1, the second is 2, ...
x the parameter value

Reimplemented from IZPreparedStatement.

Definition at line 1723 of file ZDbcStatement.pas.

TZAbstractStatement::SetMaxFieldSize ( Integer  Value  )  [inherited]

Sets the limit for the maximum number of bytes in a column to the given number of bytes.

This is the maximum number of bytes that can be returned for any column value. This limit applies only to BINARY, VARBINARY, LONGVARBINARY, CHAR, VARCHAR, and LONGVARCHAR fields. If the limit is exceeded, the excess data is silently discarded. For maximum portability, use values greater than 256.

Parameters:
max the new max column size limit; zero means unlimited

Reimplemented from IZStatement.

Definition at line 893 of file ZDbcStatement.pas.

TZAbstractStatement::SetMaxRows ( Integer  Value  )  [inherited]

Sets the limit for the maximum number of rows that any ResultSet object can contain to the given number.

If the limit is exceeded, the excess rows are silently dropped.

Parameters:
max the new max rows limit; zero means unlimited

Reimplemented from IZStatement.

Definition at line 924 of file ZDbcStatement.pas.

TZAbstractPreparedStatement::SetNull ( Integer  ParameterIndex,
TZSQLType  SQLType 
) [inherited]

Sets the designated parameter to SQL NULL.

Note: You must specify the parameter's SQL type.

Parameters:
parameterIndex the first parameter is 1, the second is 2, ...
sqlType the SQL type code defined in java.sql.Types

Reimplemented from IZPreparedStatement.

Definition at line 1601 of file ZDbcStatement.pas.

TZAbstractPreparedStatement::SetPChar ( Integer  ParameterIndex,
PChar  Value 
) [inherited]

Sets the designated parameter to a Java String value.

The driver converts this to an SQL VARCHAR or LONGVARCHAR value (depending on the argument's size relative to the driver's limits on VARCHAR values) when it sends it to the database.

Parameters:
parameterIndex the first parameter is 1, the second is 2, ...
x the parameter value

Reimplemented from IZPreparedStatement.

Definition at line 1830 of file ZDbcStatement.pas.

TZAbstractStatement::SetPostUpdates ( TZPostUpdatesMode  Value  )  [inherited]

Sets a new value for post updates.

Parameters:
Value a new value for post updates.

Reimplemented from IZStatement.

Definition at line 1333 of file ZDbcStatement.pas.

References P.

TZAbstractStatement::SetQueryTimeout ( Integer  Value  )  [inherited]

Sets the number of seconds the driver will wait for a Statement object to execute to the given number of seconds.

If the limit is exceeded, an SQLException is thrown.

Parameters:
seconds the new query timeout limit in seconds; zero means unlimited

Reimplemented from IZStatement.

Definition at line 975 of file ZDbcStatement.pas.

TZAbstractStatement::SetResultSetConcurrency ( TZResultSetConcurrency  Value  )  [inherited]

Sets a result set concurrency for ResultSet objects generated by this Statement object.

Parameters:
Concurrency either ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE

Reimplemented from IZStatement.

Definition at line 1235 of file ZDbcStatement.pas.

TZAbstractStatement::SetResultSetType ( TZResultSetType  Value  )  [inherited]

Sets a result set type for ResultSet objects generated by this Statement object.

Parameters:
ResultSetType one of ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE

Reimplemented from IZStatement.

Definition at line 1267 of file ZDbcStatement.pas.

TZAbstractPreparedStatement::SetShort ( Integer  ParameterIndex,
SmallInt  Value 
) [inherited]

Sets the designated parameter to a Java short value.

The driver converts this to an SQL SMALLINT value when it sends it to the database.

Parameters:
parameterIndex the first parameter is 1, the second is 2, ...
x the parameter value

Reimplemented from IZPreparedStatement.

Definition at line 1671 of file ZDbcStatement.pas.

TZAbstractPreparedStatement::SetString ( Integer  ParameterIndex,
const string  Value 
) [inherited]

Sets the designated parameter to a Java String value.

The driver converts this to an SQL VARCHAR or LONGVARCHAR value (depending on the argument's size relative to the driver's limits on VARCHAR values) when it sends it to the database.

Parameters:
parameterIndex the first parameter is 1, the second is 2, ...
x the parameter value

Reimplemented from IZPreparedStatement.

Definition at line 1859 of file ZDbcStatement.pas.

TZAbstractPreparedStatement::SetTime ( Integer  ParameterIndex,
TDateTime  Value 
) [inherited]

Sets the designated parameter to a java.sql.Time value.

The driver converts this to an SQL TIME value when it sends it to the database.

Parameters:
parameterIndex the first parameter is 1, the second is 2, ...
x the parameter value

Reimplemented from IZPreparedStatement.

Definition at line 1967 of file ZDbcStatement.pas.

TZAbstractPreparedStatement::SetTimestamp ( Integer  ParameterIndex,
TDateTime  Value 
) [inherited]

Sets the designated parameter to a java.sql.Timestamp value.

The driver converts this to an SQL TIMESTAMP value when it sends it to the database.

Parameters:
parameterIndex the first parameter is 1, the second is 2, ...
x the parameter value

Reimplemented from IZPreparedStatement.

Definition at line 1993 of file ZDbcStatement.pas.

TZAbstractPreparedStatement::SetUnicodeStream ( Integer  ParameterIndex,
TStream  Value 
) [inherited]

Sets the designated parameter to the given input stream, which will have the specified number of bytes.

When a very large UNICODE value is input to a LONGVARCHAR parameter, it may be more practical to send it via a java.io.InputStream object. The data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from UNICODE to the database char format. The byte format of the Unicode stream must be Java UTF-8, as defined in the Java Virtual Machine Specification.

Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.

Parameters:
parameterIndex the first parameter is 1, the second is 2, ...
x the java input stream which contains the UNICODE parameter value

Reimplemented from IZPreparedStatement.

Definition at line 2056 of file ZDbcStatement.pas.

TZAbstractPreparedStatement::SetUnicodeString ( Integer  ParameterIndex,
const WideString  Value 
) [inherited]

Sets the designated parameter to a Object Pascal WideString value.

The driver converts this to an SQL VARCHAR or LONGVARCHAR value (depending on the argument's size relative to the driver's limits on VARCHAR values) when it sends it to the database.

Parameters:
parameterIndex the first parameter is 1, the second is 2, ...
x the parameter value

Reimplemented from IZPreparedStatement.

Definition at line 1888 of file ZDbcStatement.pas.

TZAbstractPreparedStatement::SetValue ( Integer  ParameterIndex,
const TZVariant  Value 
) [inherited]

Sets a variant value for the specified parameter.

Parameters:
ParameterIndex the first parameter is 1, the second is 2, ...
Value the variant value.

Reimplemented from IZPreparedStatement.

Definition at line 2122 of file ZDbcStatement.pas.

TStrings TZEmulatedPreparedStatement::TokenizeSQLQuery (  )  [protected, inherited]

Splits a SQL query into a list of sections.

Returns:
a list of splitted sections.

Definition at line 2736 of file ZDbcStatement.pas.


Member Data Documentation

TStrings TZAbstractStatement::BatchQueries [protected, inherited]

See also:
FBatchQueries For reading

Definition at line 161 of file ZDbcStatement.pas.

TStrings TZEmulatedPreparedStatement::CachedQuery [protected, inherited]

See also:
FCachedQuery For reading

FCachedQuery For writing

Definition at line 661 of file ZDbcStatement.pas.

Boolean TZAbstractStatement::Closed [protected, inherited]

See also:
FClosed For reading

FClosed For writing

Definition at line 170 of file ZDbcStatement.pas.

See also:
FConnection For reading

Definition at line 164 of file ZDbcStatement.pas.

string TZAbstractStatement::CursorName [protected, inherited]

See also:
FCursorName For reading

FCursorName For writing

Definition at line 158 of file ZDbcStatement.pas.

Boolean TZAbstractStatement::EscapeProcessing [protected, inherited]

See also:
FEscapeProcessing For reading

FEscapeProcessing For writing

Definition at line 129 of file ZDbcStatement.pas.

See also:
FExecStatement For reading

FExecStatement For writing

Definition at line 658 of file ZDbcStatement.pas.

See also:
FFetchDirection For reading

FFetchDirection For writing

Definition at line 144 of file ZDbcStatement.pas.

Integer TZAbstractStatement::FetchSize [protected, inherited]

See also:
FFetchSize For reading

FFetchSize For writing

Definition at line 147 of file ZDbcStatement.pas.

Definition at line 136 of file ZDbcMySqlStatement.pas.

Definition at line 138 of file ZDbcMySqlStatement.pas.

TStrings TZAbstractStatement::Info [protected, inherited]

See also:
FInfo For reading

Definition at line 167 of file ZDbcStatement.pas.

Integer TZAbstractPreparedStatement::InParamCount [protected, inherited]

See also:
FInParamCount For reading

FInParamCount For writing

Definition at line 358 of file ZDbcStatement.pas.

TStringDynArray TZAbstractPreparedStatement::InParamDefaultValues [protected, inherited]

See also:
FInParamDefaultValues For reading

FInParamDefaultValues For writing

Definition at line 355 of file ZDbcStatement.pas.

See also:
FInParamTypes For reading

FInParamTypes For writing

Definition at line 351 of file ZDbcStatement.pas.

See also:
FInParamValues For reading

FInParamValues For writing

Definition at line 347 of file ZDbcStatement.pas.

See also:
FLastResultSet For reading

SetLastResultSet For writing

Definition at line 140 of file ZDbcStatement.pas.

See also:
FLastStatement For reading

SetLastStatement For writing

Definition at line 664 of file ZDbcStatement.pas.

Integer TZAbstractStatement::LastUpdateCount [protected, inherited]

See also:
FLastUpdateCount For reading

FLastUpdateCount For writing

Definition at line 136 of file ZDbcStatement.pas.

Integer TZAbstractStatement::MaxFieldSize [protected, inherited]

See also:
FMaxFieldSize For reading

FMaxFieldSize For writing

Definition at line 122 of file ZDbcStatement.pas.

Integer TZAbstractStatement::MaxRows [protected, inherited]

See also:
FMaxRows For reading

FMaxRows For writing

Definition at line 125 of file ZDbcStatement.pas.

Integer TZAbstractStatement::QueryTimeout [protected, inherited]

See also:
FQueryTimeout For reading

FQueryTimeout For writing

Definition at line 132 of file ZDbcStatement.pas.

See also:
FResultSetConcurrency For reading

FResultSetConcurrency For writing

Definition at line 151 of file ZDbcStatement.pas.

See also:
FResultSetType For reading

FResultSetType For writing

Definition at line 155 of file ZDbcStatement.pas.

string TZAbstractPreparedStatement::SQL [protected, inherited]

See also:
FSQL For reading

FSQL For writing

Definition at line 340 of file ZDbcStatement.pas.


The documentation for this class was generated from the following file:

Generated on Wed Dec 30 08:42:54 2009 for zeoslib by  doxygen 1.5.7.1