DBConnector

class DBConnector

Represents an object responsible for wrapping DB connector api

Config options

write_operations array List of operations to treat as write Implicitly includes all ddl_operations
ddl_operations array List of operations to treat as DDL

Methods

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)

connect(array $parameters, boolean $selectDB = false)

Link this connector to the database given the specified parameters Will throw an exception rather than return a success state.

string
getVersion()

Query for the version of the currently connected database

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.

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!

query(string $sql, integer $errorLevel = E_USER_ERROR)

Executes the following query with the specified error level.

SS_Query
preparedQuery(string $sql, array $parameters, int $errorLevel = E_USER_ERROR)

Execute the given SQL parameterised query with the specified arguments

boolean
selectDatabase(string $name)

Select a database by name

string
getSelectedDatabase()

Retrieves the name of the currently selected database

unloadDatabase()

De-selects the currently selected database

string
getLastError()

Retrieves the last error generated from the database connection

integer
getGeneratedID(string $table)

Determines the last ID generated from the specified table.

integer
affectedRows()

Determines the number of affected rows from the last SQL query

boolean
isActive()

Determines if we are connected to a server AND have a valid database selected.

Details

at line 67
bool isQueryMutable(string $sql)

Determine if this SQL statement is a destructive operation (write or ddl)

Parameters

string $sql

Return Value

bool

at line 81
bool isQueryDDL(string $sql)

Determine if this SQL statement is a DDL operation

Parameters

string $sql

Return Value

bool

at line 93
bool isQueryWrite(string $sql)

Determine if this SQL statement is a write operation (alters content but not structure)

Parameters

string $sql

Return Value

bool

at line 150
abstract connect(array $parameters, boolean $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()

Parameters

array $parameters List of parameters such as

  • type
  • server
  • username
  • password
  • database
  • path
boolean $selectDB By default database selection should be handled by the database controller (to enable database creation on the fly if necessary), but some interfaces require that the database is specified during connection (SQLite, Azure, etc).

at line 157
abstract string getVersion()

Query for the version of the currently connected database

Return Value

string Version of this database

at line 166
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.

Parameters

string $value The value to be escaped

Return Value

string The appropritaely escaped string for value

at line 175
abstract string quoteString(string $value)

Given a value escape and quote this appropriately for the current database connector.

Parameters

string $value The value to be injected into a query

Return Value

string The appropriately escaped and quoted string for $value

at line 185
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!

Parameters

string $value The identifier to escape
string $separator optional identifier splitter

at line 206
abstract query(string $sql, integer $errorLevel = E_USER_ERROR)

Executes the following query with the specified error level.

Implementations of this function should respect previewWrite and benchmarkQuery

Parameters

string $sql The SQL query to execute
integer $errorLevel For errors to this query, raise PHP errors using this error level.

See also

http://php.net/manual/en/errorfunc.constants.php

at line 216
abstract SS_Query preparedQuery(string $sql, array $parameters, int $errorLevel = E_USER_ERROR)

Execute the given SQL parameterised query with the specified arguments

Parameters

string $sql The SQL query to execute. The ? character will denote parameters.
array $parameters An ordered list of arguments.
int $errorLevel The level of error reporting to enable for the query

Return Value

SS_Query

at line 224
abstract boolean selectDatabase(string $name)

Select a database by name

Parameters

string $name Name of database

Return Value

boolean Flag indicating success

at line 231
abstract string getSelectedDatabase()

Retrieves the name of the currently selected database

Return Value

string Name of the database, or null if none selected

at line 236
abstract unloadDatabase()

De-selects the currently selected database

at line 243
abstract string getLastError()

Retrieves the last error generated from the database connection

Return Value

string The error message

at line 253
abstract integer 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.

Parameters

string $table The target table to return the last generated ID for

Return Value

integer ID value

at line 260
abstract integer affectedRows()

Determines the number of affected rows from the last SQL query

Return Value

integer Number of affected rows

at line 268
abstract boolean isActive()

Determines if we are connected to a server AND have a valid database selected.

Return Value

boolean Flag indicating that a valid database is connected