Interface INeevoDriver
Interface implemented by all Neevo drivers.
All Neevo drivers must implement this interface, not only
reproduce all it's methods, or they won't be recognised as valid drivers.
If something is not implemented, the method must throw
NeevoImplementationException. The exception will be catched and Neevo will
decide, what to do next.
If something is not supported by the driver (e.g. number of result rows on
unbuffered queries) the driver should throw NeevoDriverException.
When the driver needs to rewrite default output of SQL commands, it
must extend NeevoParser class. For proper use,
see source of
NeevoParser class.
Methods summary
public
|
#
__construct( )
Check for required PHP extension.
Check for required PHP extension.
Throws
|
public
|
#
connect( array $config )
Create connection to database.
Create connection to database.
Parameters
- $config
array
$config Configuration options
|
public
|
|
public
boolean
|
#
freeResultSet( resource $resultSet )
Free memory used by given result.
Free memory used by given result.
Parameters
- $resultSet
resource
$resultSet Returns
boolean
|
public
resource|boolean
|
#
runQuery( string $queryString )
Execute given SQL statement.
Execute given SQL statement.
Parameters
- $queryString
string
$queryString Returns
resource|boolean
|
public
|
#
beginTransaction( string $savepoint = null )
Begin a transaction if supported.
Begin a transaction if supported.
Parameters
- $savepoint
string
$savepoint
|
public
|
#
commit( string $savepoint = null )
Commit statements in a transaction.
Commit statements in a transaction.
Parameters
- $savepoint
string
$avepoint
|
public
|
#
rollback( string $savepoint = null )
Rollback changes in a transaction.
Rollback changes in a transaction.
Parameters
- $savepoint
string
$savepoint
|
public
array
|
#
fetch( resource $resultSet )
Fetch row from given result set as an associative array.
Fetch row from given result set as an associative array.
Parameters
- $resultSet
resource
$resultSet Returns
array
|
public
boolean
|
#
seek( resource $resultSet, integer $offset )
Move internal result pointer.
Move internal result pointer.
Parameters
- $resultSet
resource
$resultSet- $offset
integer
$offset Returns
boolean
|
public
integer
|
#
getInsertId( )
Get the ID generated in the INSERT statement.
Get the ID generated in the INSERT statement.
Returns
integer
|
public
|
|
public
integer|false
|
#
getNumRows( resource $resultSet )
Get the number of rows in the given result set.
Get the number of rows in the given result set.
Parameters
- $resultSet
resource
$resultSet Returns
integer|false
|
public
integer
|
#
getAffectedRows( )
Get the number of affected rows in previous operation.
Get the number of affected rows in previous operation.
Returns
integer
|
public
mixed
|
#
escape( mixed $value, string $type )
Escape given value.
Parameters
- $value
mixed
$value- $type
string
$type Returns
mixed
|
public
mixed
|
#
unescape( mixed $value, string $type )
Decode given value.
Parameters
- $value
mixed
$value- $type
string
$type Returns
mixed
|
public
string|null
|
#
getPrimaryKey( string $table )
Get the PRIMARY KEY column for given table.
Get the PRIMARY KEY column for given table.
Parameters
Returns
string|null
|
public
array
|
#
getColumnTypes( resource $resultSet, string $table )
Get types of columns in given result set.
Get types of columns in given result set.
Parameters
- $resultSet
resource
$resultSet- $table
string
$table Returns
array
|
Magic methods summary