DBConnector
abstract class DBConnector (View source)
Represents an object responsible for wrapping DB connector api
Properties
| static private array | $write_operations | List of operations to treat as write Implicitly includes all ddl_operations |
|
| static private array | $ddl_operations | List of operations to treat as DDL |
Methods
Determine if this SQL statement is a destructive operation (write or ddl)
Determine if this SQL statement is a DDL operation
Determine if this SQL statement is a write operation (alters content but not structure)
Link this connector to the database given the specified parameters Will throw an exception rather than return a success state.
Query for the version of the currently connected database
Given a value escape this for use in a query for the current database connector. Note that this does not quote the value.
Given a value escape and quote this appropriately for the current database connector.
Escapes an identifier (table / database name). Typically the value is simply double quoted. Don't pass in already escaped identifiers in, as this will double escape the value!
Executes the following query with the specified error level.
Execute the given SQL parameterised query with the specified arguments
Select a database by name
Retrieves the name of the currently selected database
De-selects the currently selected database
Retrieves the last error generated from the database connection
Determines the last ID generated from the specified table.
Determines the number of affected rows from the last SQL query
Determines if we are connected to a server AND have a valid database selected.
Details
bool
isQueryMutable(string $sql)
Determine if this SQL statement is a destructive operation (write or ddl)
bool
isQueryDDL(string $sql)
Determine if this SQL statement is a DDL operation
bool
isQueryWrite(string $sql)
Determine if this SQL statement is a write operation (alters content but not structure)
abstract
connect(array $parameters, bool $selectDB = false)
Link this connector to the database given the specified parameters Will throw an exception rather than return a success state.
The connector should not select the database once connected until explicitly called by selectDatabase()
abstract string
getVersion()
Query for the version of the currently connected database
abstract string
escapeString(string $value)
Given a value escape this for use in a query for the current database connector. Note that this does not quote the value.
abstract string
quoteString(string $value)
Given a value escape and quote this appropriately for the current database connector.
escapeIdentifier(string $value, string $separator = '.')
Escapes an identifier (table / database name). Typically the value is simply double quoted. Don't pass in already escaped identifiers in, as this will double escape the value!
abstract
query(string $sql, int $errorLevel = E_USER_ERROR)
Executes the following query with the specified error level.
Implementations of this function should respect previewWrite and benchmarkQuery
abstract SS_Query
preparedQuery(string $sql, array $parameters, int $errorLevel = E_USER_ERROR)
Execute the given SQL parameterised query with the specified arguments
abstract bool
selectDatabase(string $name)
Select a database by name
abstract string
getSelectedDatabase()
Retrieves the name of the currently selected database
abstract
unloadDatabase()
De-selects the currently selected database
abstract string
getLastError()
Retrieves the last error generated from the database connection
abstract int
getGeneratedID(string $table)
Determines the last ID generated from the specified table.
Note that some connectors may not be able to return $table specific responses, and this parameter may be ignored.
abstract int
affectedRows()
Determines the number of affected rows from the last SQL query
abstract bool
isActive()
Determines if we are connected to a server AND have a valid database selected.