Statement Interface Reference

Inheritance diagram for Statement:

MSSQLStatement MySQLiStatement MySQLStatement OCI8Statement ODBCStatement PgSQLStatement SQLiteStatement

List of all members.

Public Member Functions

 setLimit ($v)
 Sets the maximum number of rows to return from db.
 getLimit ()
 Returns the maximum number of rows to return or 0 for all.
 setOffset ($v)
 Sets the start row.
 getOffset ()
 Returns the start row.
 close ()
 Free resources associated with this statement.
 execute ($sql, $fetchmode=null)
 Generic execute() function has to check to see whether SQL is an update or select query.
 getResultSet ()
 Get result set.
 getUpdateCount ()
 Get update count.
 executeQuery ($sql, $fetchmode=null)
 Executes the SQL query in this PreparedStatement object and returns the resultset generated by the query.
 executeUpdate ($sql)
 Executes the SQL INSERT, UPDATE, or DELETE statement in this PreparedStatement object.
 getMoreResults ()
 Gets next result set (if this behavior is supported by driver).
 getConnection ()
 Gets the db Connection that created this statement.


Detailed Description

Definition at line 36 of file Statement.php.


Member Function Documentation

Statement::close (  ) 

Free resources associated with this statement.

Some drivers will need to implement this method to free database result resources.

Returns:
void

Statement::execute ( sql,
fetchmode = null 
)

Generic execute() function has to check to see whether SQL is an update or select query.

If you already know whether it's a SELECT or an update (manipulating) SQL, then use the appropriate method, as this one will incurr overhead to check the SQL.

Parameters:
int $fetchmode Fetchmode (only applies to queries).
Returns:
boolean True if it is a result set, false if not or if no more results (this is identical to JDBC return val).
Exceptions:
SQLException 

Statement::executeQuery ( sql,
fetchmode = null 
)

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

Parameters:
string $sql This method may optionally be called with the SQL statement.
int $fetchmode The mode to use when fetching the results (e.g. ResultSet::FETCHMODE_NUM, ResultSet::FETCHMODE_ASSOC).
Returns:
object Creole::ResultSet
Exceptions:
SQLException if a database access error occurs.

Implemented in MSSQLStatement, and ODBCStatement.

Statement::executeUpdate ( sql  ) 

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

Parameters:
string $sql This method may optionally be called with the SQL statement.
Returns:
int Number of affected rows (or 0 for drivers that return nothing).
Exceptions:
SQLException if a database access error occurs.

Statement::getConnection (  ) 

Gets the db Connection that created this statement.

Returns:
Connection

Statement::getLimit (  ) 

Returns the maximum number of rows to return or 0 for all.

Returns:
int

Statement::getMoreResults (  ) 

Gets next result set (if this behavior is supported by driver).

Some drivers (e.g. MSSQL) support returning multiple result sets -- e.g. from stored procedures.

This function also closes any current restult set.

Default behavior is for this function to return false. Driver-specific implementations of this class can override this method if they actually support multiple result sets.

Returns:
boolean True if there is another result set, otherwise false.

Implemented in MSSQLStatement.

Statement::getOffset (  ) 

Returns the start row.

Offset only applies when Limit is set!

Returns:
int

Statement::getResultSet (  ) 

Get result set.

This assumes that the last thing done was an executeQuery() or an execute() with SELECT-type query.

Returns:
RestultSet (or null if none)

Statement::getUpdateCount (  ) 

Get update count.

Returns:
int Number of records affected, or null if not applicable.

Statement::setLimit ( v  ) 

Sets the maximum number of rows to return from db.

This will affect the SQL if the RDBMS supports native LIMIT; if not, it will be emulated. Limit only applies to queries (not update sql).

Parameters:
int $v Maximum number of rows or 0 for all rows.
Returns:
void

Statement::setOffset ( v  ) 

Sets the start row.

This will affect the SQL if the RDBMS supports native OFFSET; if not, it will be emulated. Offset only applies to queries (not update) and only is evaluated when LIMIT is set!

Parameters:
int $v
Returns:
void


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

Generated on Wed May 6 23:10:50 2009 for fareofficelib by  doxygen 1.5.8