TZASAStatement Class Reference

Implements Generic ASA Statement. More...

Inheritance diagram for TZASAStatement:

TZAbstractStatement 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.
 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.
 ClearWarnings ()
 Clears all the warnings reported on this Statement object.
 Close ()
 Releases this Statement object's database and JDBC resources immediately instead of waiting for this to happen when it is automatically closed.
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.
IZResultSet ExecuteQuery (const string SQL)
 Executes an SQL statement that returns a single ResultSet object.
Integer ExecuteUpdate (const string SQL)
 Executes an SQL INSERT, UPDATE or DELETE statement.
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.
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.
 SetCursorName (const string Value)
 Defines the SQL cursor name that will be used by subsequent Statement object execute methods.
 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.
 SetLocateUpdates (TZLocateUpdatesMode Value)
 Sets a new value for locate updates.
 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.
 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.
 TZASAStatement (IZConnection Connection, TStrings Info)
 Constructs this object and assignes the main properties.
 ~TZASAStatement ()

Protected Member Functions

 RaiseUnsupportedException ()
 Raises unsupported operation exception.

Protected Attributes

TStrings BatchQueries
Boolean Closed
IZConnection Connection
string CursorName
Boolean EscapeProcessing
TZFetchDirection FetchDirection
Integer FetchSize
TStrings Info
IZResultSet LastResultSet
Integer LastUpdateCount
Integer MaxFieldSize
Integer MaxRows
Integer QueryTimeout
TZResultSetConcurrency ResultSetConcurrency
TZResultSetType ResultSetType

Private Attributes

IZASAConnection FASAConnection
Boolean FCachedBlob
Boolean FMoreResults
IZASASQLDA FSQLData
SmallInt FStmtNum


Detailed Description

Implements Generic ASA Statement.

Definition at line 66 of file ZDbcASAStatement.pas.


Constructor & Destructor Documentation

TZASAStatement::TZASAStatement ( IZConnection  Connection,
TStrings  Info 
)

Constructs this object and assignes the main properties.

Parameters:
Connection a database connection object.
Handle a connection handle pointer.
Dialect a dialect Interbase SQL must be 1 or 2 or 3.
Info a statement parameters.

Definition at line 287 of file ZDbcASAStatement.pas.

TZASAStatement::~TZASAStatement (  ) 

Definition at line 306 of file ZDbcASAStatement.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.

TZASAStatement::Cancel (  ) 

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

Definition at line 331 of file ZDbcASAStatement.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.

TZASAStatement::ClearWarnings (  ) 

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

Definition at line 349 of file ZDbcASAStatement.pas.

TZASAStatement::Close (  ) 

Releases this Statement object's database and JDBC resources immediately instead of waiting for this to happen when it is automatically closed.

It is generally good practice to release resources as soon as you are finished with them to avoid tying up database resources.

Note: A Statement object is automatically closed when it is garbage collected. When a Statement object is closed, its current ResultSet object, if one exists, is also closed.

Reimplemented from TZAbstractStatement.

Definition at line 315 of file ZDbcASAStatement.pas.

Boolean TZASAStatement::Execute ( const string  SQL  ) 

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
See also:
getResultSet

getUpdateCount

getMoreResults

Reimplemented from TZAbstractStatement.

Definition at line 508 of file ZDbcASAStatement.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.

IZResultSet TZASAStatement::ExecuteQuery ( const string  SQL  ) 

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 388 of file ZDbcASAStatement.pas.

Integer TZASAStatement::ExecuteUpdate ( const string  SQL  ) 

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 464 of file ZDbcASAStatement.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.

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.

Boolean TZASAStatement::GetMoreResults (  ) 

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

Definition at line 357 of file ZDbcASAStatement.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 TZASAStatement::GetWarnings (  ) 

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

Definition at line 341 of file ZDbcASAStatement.pas.

TZAbstractStatement::RaiseUnsupportedException (  )  [protected, inherited]

Raises unsupported operation exception.

Definition at line 779 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.

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.

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.

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.

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.


Member Data Documentation

TStrings TZAbstractStatement::BatchQueries [protected, inherited]

See also:
FBatchQueries For reading

Definition at line 161 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.

Definition at line 75 of file ZDbcASAStatement.pas.

Boolean TZASAStatement::FCachedBlob [private]

Definition at line 71 of file ZDbcASAStatement.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.

Boolean TZASAStatement::FMoreResults [private]

Definition at line 79 of file ZDbcASAStatement.pas.

IZASASQLDA TZASAStatement::FSQLData [private]

Definition at line 77 of file ZDbcASAStatement.pas.

SmallInt TZASAStatement::FStmtNum [private]

Definition at line 73 of file ZDbcASAStatement.pas.

TStrings TZAbstractStatement::Info [protected, inherited]

See also:
FInfo For reading

Definition at line 167 of file ZDbcStatement.pas.

See also:
FLastResultSet For reading

SetLastResultSet For writing

Definition at line 140 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.


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

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