1. class
  2. SilverStripe
  3. \
  4. ORM
  5. \
  6. Connect
  7. \
  8. DBConnector

DBConnector

abstract class DBConnector (View source)

Represents an object responsible for wrapping DB connector api

Traits

Configurable

Provides extensions to this object to integrate it with standard config API methods.

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

static Config_ForClass
config()

Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).

from  Configurable
mixed
stat(string $name) deprecated

Get inherited config value

from  Configurable
mixed
uninherited(string $name)

Gets the uninherited value for the given config option

from  Configurable
$this
set_stat(string $name, mixed $value) deprecated

Update the config value for a given property

from  Configurable
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, bool $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.

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

Executes the following query with the specified error level.

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

Execute the given SQL parameterised query with the specified arguments

bool
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

int
getGeneratedID(string $table)

Determines the last ID generated from the specified table.

int
affectedRows()

Determines the number of affected rows from the last SQL query

bool
isActive()

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

Details

in Configurable at line 20
static Config_ForClass config()

Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).

Return Value

Config_ForClass

in Configurable at line 32
mixed stat(string $name) deprecated

deprecated 5.0 Use ->config()->get() instead

Get inherited config value

Parameters

string $name

Return Value

mixed

in Configurable at line 44
mixed uninherited(string $name)

Gets the uninherited value for the given config option

Parameters

string $name

Return Value

mixed

in Configurable at line 57
$this set_stat(string $name, mixed $value) deprecated

deprecated 5.0 Use ->config()->set() instead

Update the config value for a given property

Parameters

string $name
mixed $value

Return Value

$this

at line 76
bool isQueryMutable(string $sql)

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

Parameters

string $sql

Return Value

bool

at line 91
bool isQueryDDL(string $sql)

Determine if this SQL statement is a DDL operation

Parameters

string $sql

Return Value

bool

at line 104
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 165
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()

Parameters

array $parameters

List of parameters such as

  • type
  • server
  • username
  • password
  • database
  • path
bool $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 172
abstract string getVersion()

Query for the version of the currently connected database

Return Value

string

Version of this database

at line 181
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 190
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 201
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

Parameters

string $sql

The SQL query to execute
int $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 211
abstract 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

Query

at line 219
abstract bool selectDatabase(string $name)

Select a database by name

Parameters

string $name

Name of database

Return Value

bool

Flag indicating success

at line 226
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 231
abstract unloadDatabase()

De-selects the currently selected database

at line 238
abstract string getLastError()

Retrieves the last error generated from the database connection

Return Value

string

The error message

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

Parameters

string $table

The target table to return the last generated ID for

Return Value

int

ID value

at line 255
abstract int affectedRows()

Determines the number of affected rows from the last SQL query

Return Value

int

Number of affected rows

at line 263
abstract bool isActive()

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

Return Value

bool

Flag indicating that a valid database is connected