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

MySQLDatabase

class MySQLDatabase extends Database implements TransactionManager (View source)

MySQL connector class.

Supported indexes for requireTable()

You are advised to backup your tables if changing settings on an existing database connection_charset and charset should be equal, similarly so should connection_collation and collation

Traits

Configurable

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

Constants

PARTIAL_QUERY

FULL_QUERY

Config options

optimistic_connect bool

In cases where your environment does not have 'SHOW DATABASES' permission, you can set this to true. Then selectDatabase() will always connect without doing databaseExists() check.

 from  Database
connection_charset string

Default connection charset (may be overridden in $databaseConfig)
connection_collation string

Default connection collation
charset string

Default charset
sql_mode string

SQL Mode used on connections to MySQL. Defaults to ANSI. For basic ORM compatibility, this setting must always include ANSI or ANSI_QUOTES.
collation string

Default collation

Properties

protected static array $whitelist_array

To use, call from _config.php Example:

Database::setWhitelistQueryArray([
     'Qualmark' => 'partial_query',
     'SELECT "Version" FROM "SiteTree_Live" WHERE "ID" = ?' => 'full_query',
])
 from  Database
protected DBConnector $connector

Database connector object

 from  Database
protected int $queryCount

Amount of queries executed, for debugging purposes.

 from  Database
protected DBSchemaManager $schemaManager

Database schema manager object

 from  Database
protected DBQueryBuilder $queryBuilder

Query builder object

 from  Database

Methods

public
DBConnector
getConnector()

Get the current connector

from  Database
public
setConnector(DBConnector $connector)

Injector injection point for connector dependency

from  Database
public
DBSchemaManager
getSchemaManager()

Returns the current schema manager

from  Database
public
setSchemaManager(DBSchemaManager $schemaManager)

Injector injection point for schema manager

from  Database
public
DBQueryBuilder
getQueryBuilder()

Returns the current query builder

from  Database
public
setQueryBuilder(DBQueryBuilder $queryBuilder)

Injector injection point for schema manager

from  Database
public
Query
query(string $sql, int $errorLevel = E_USER_ERROR)

Execute the given SQL query.

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

Execute the given SQL parameterised query with the specified arguments

protected
bool
previewWrite(string $sql)

Determines if the query should be previewed, and thus interrupted silently.

from  Database
protected
mixed
benchmarkQuery(string $sql, callable $callback, array $parameters = [])

Allows the display and benchmarking of queries as they are being run

from  Database
protected
displayQuery(mixed $query, float $endtime)

Display query message

from  Database
public static 
setWhitelistQueryArray(array $whitelistArray)

Add the sql queries that need to be partially or fully matched

from  Database
public static 
array
getWhitelistQueryArray()

Get the sql queries that need to be partially or fully matched

from  Database
public
int
getGeneratedID(string $table)

Get the autogenerated ID from the previous INSERT query.

from  Database
public
bool
isActive()

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

from  Database
public
string
escapeString(mixed $value)

Returns an escaped string. This string won't be quoted, so would be suitable for appending to other quoted strings.

from  Database
public
string
quoteString(mixed $value)

Wrap a string into DB-specific quotes.

from  Database
public
string
escapeIdentifier(string|array $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!

from  Database
protected
array
escapeColumnKeys(array $fieldValues)

Escapes unquoted columns keys in an associative array

from  Database
public
manipulate(array $manipulation)

Execute a complex manipulation on the database.

from  Database
public
quiet()

Enable suppression of database messages.

from  Database
public
clearAllData()

Clear all data out of the database

from  Database
public
clearTable(string $table)

Clear all data in a given table

public
string
nullCheckClause(string $field, bool $isNull)

Generates a WHERE clause for null comparison check

from  Database
public
string
comparisonClause(string $field, string $value, bool $exact = false, bool $negate = false, bool $caseSensitive = null, bool $parameterised = false)

Generate a WHERE clause for text matching.

public
string
formattedDatetimeClause(string $date, string $format)

function to return an SQL datetime expression that can be used with the adapter in use used for querying a datetime in a certain format

public
string
datetimeIntervalClause(string $date, string $interval)

function to return an SQL datetime expression that can be used with the adapter in use used for querying a datetime addition

public
string
datetimeDifferenceClause(string $date1, string $date2)

function to return an SQL datetime expression that can be used with the adapter in use used for querying a datetime subtraction

public
string
concatOperator()

String operator for concatenation of strings

from  Database
public
bool
supportsCollations()

Returns true if this database supports collations

public
bool
supportsTimezoneOverride()

Can the database override timezone as a connection setting, or does it use the system timezone exclusively?

public
string
getVersion()

Query for the version of the currently connected database

from  Database
public
string
getDatabaseServer()

Get the database server type (e.g. mysql, postgresql).

public
int
affectedRows()

Return the number of rows affected by the previous operation.

from  Database
public
PaginatedList
searchEngine(array $classesToSearch, string $keywords, int $start, int $pageLength, string $sortBy = "Relevance DESC", string $extraFilter = "", bool $booleanSearch = false, string $alternativeFileFilter = "", bool $invertedMatch = false)

The core search engine, used by this class and its subclasses to do fun stuff.

public
bool
supportsTransactions()

Determines if this database supports transactions

public
bool
supportsSavepoints()

Does this database support savepoints in transactions By default it is assumed that they don't unless they are explicitly enabled.

public
bool
supportsTransactionMode(string $mode)

Determines if the used database supports given transactionMode as an argument to startTransaction() If transactions are completely unsupported, returns false.

from  Database
public
withTransaction(callable $callback, callable $errorCallback = null, bool|string $transactionMode = false, bool $errorIfTransactionsUnsupported = false)

Invoke $callback within a transaction

from  Database
public
supportsExtensions($extensions)

No description

from  Database
public
transactionStart(string|bool $transactionMode = false, string|bool $sessionCharacteristics = false)

Start a prepared transaction See http://developer.postgresql.org/pgdocs/postgres/sql-set-transaction.html for details on transaction isolation options

public
transactionSavepoint(string $savepoint)

Create a savepoint that you can jump back to if you encounter problems

public
bool|null
transactionRollback(string|bool $savepoint = false)

Rollback or revert to a savepoint if your queries encounter problems If you encounter a problem at any point during a transaction, you may need to rollback that particular query, or return to a savepoint

public
bool|null
transactionEnd(bool $chain = false)

Commit everything inside this transaction so far

public
int
transactionDepth()

Return depth of current transaction

public
bool
supportsLocks()

Determines if the used database supports application-level locks, which is different from table- or row-level locking.

public
bool
canLock(string $name)

Returns if the lock is available.

public
bool
getLock(string $name, int $timeout = 5)

Sets an application-level lock so that no two processes can run at the same time, also called a "cooperative advisory lock".

public
bool
releaseLock(string $name)

Remove an application-level lock file to allow another process to run (if the execution aborts (e.g. due to an error) all locks are automatically released).

public
connect(array $parameters)

Instruct the database to generate a live connection

public
bool
databaseExists(string $name)

Determine if the database with the specified name exists

from  Database
public
array
databaseList()

Retrieves the list of all databases the user has access to

from  Database
public
bool
selectDatabase(string $name, bool $create = false, int|bool $errorLevel = E_USER_ERROR)

Change the connection to the specified database, optionally creating the database if it doesn't exist in the current schema.

from  Database
public
dropSelectedDatabase()

Drop the database that this object is currently connected to.

from  Database
public
string|null
getSelectedDatabase()

Returns the name of the currently selected database

from  Database
public
string
now()

Return SQL expression used to represent the current date/time

public
string
random()

Returns the database-specific version of the random() function

public static 
Config_ForClass
config()

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

from  Configurable
public
mixed
stat(string $name) deprecated

Get inherited config value

from  Configurable
public
mixed
uninherited(string $name)

Gets the uninherited value for the given config option

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

Update the config value for a given property

from  Configurable
public
setSQLMode(string $mode)

Sets the SQL mode

public
selectTimezone(string $timezone)

Sets the system timezone for the database connection

protected
TransactionManager
getTransactionManager()

Returns the TransactionManager to handle transactions for this database.

protected
resetTransactionNesting()

In error condition, set transactionNesting to zero

protected
inspectQuery(string $sql)

Inspect a SQL query prior to execution

protected
getLockIdentifier($name)

No description

Details

in Database at line 67
DBConnector getConnector()

Get the current connector

Return Value

DBConnector

in Database at line 77
setConnector(DBConnector $connector)

Injector injection point for connector dependency

Parameters

DBConnector $connector

in Database at line 94
DBSchemaManager getSchemaManager()

Returns the current schema manager

Return Value

DBSchemaManager

in Database at line 104
setSchemaManager(DBSchemaManager $schemaManager)

Injector injection point for schema manager

Parameters

DBSchemaManager $schemaManager

in Database at line 125
DBQueryBuilder getQueryBuilder()

Returns the current query builder

Return Value

DBQueryBuilder

in Database at line 135
setQueryBuilder(DBQueryBuilder $queryBuilder)

Injector injection point for schema manager

Parameters

DBQueryBuilder $queryBuilder

at line 397
Query query(string $sql, int $errorLevel = E_USER_ERROR)

Execute the given SQL query.

Parameters

string $sql

The SQL query to execute
int $errorLevel

The level of error reporting to enable for the query

Return Value

Query

at line 403
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

in Database at line 200
protected bool previewWrite(string $sql)

Determines if the query should be previewed, and thus interrupted silently.

If so, this function also displays the query via the debugging system. Subclasess should respect the results of this call for each query, and not execute any queries that generate a true response.

Parameters

string $sql

The query to be executed

Return Value

bool

Flag indicating that the query was previewed

in Database at line 224
protected mixed benchmarkQuery(string $sql, callable $callback, array $parameters = [])

Allows the display and benchmarking of queries as they are being run

Parameters

string $sql

Query to run, and single parameter to callback
callable $callback

Callback to execute code
array $parameters

Parameters for any parameterised query

Return Value

mixed

Result of query

in Database at line 267
protected displayQuery(mixed $query, float $endtime)

Display query message

Parameters

mixed $query
float $endtime

in Database at line 278
static setWhitelistQueryArray(array $whitelistArray)

Add the sql queries that need to be partially or fully matched

Parameters

array $whitelistArray

in Database at line 288
static array getWhitelistQueryArray()

Get the sql queries that need to be partially or fully matched

Return Value

array

in Database at line 299
int getGeneratedID(string $table)

Get the autogenerated ID from the previous INSERT query.

Parameters

string $table

The name of the table to get the generated ID for

Return Value

int

the most recently generated ID for the specified table

in Database at line 310
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

in Database at line 322
string escapeString(mixed $value)

Returns an escaped string. This string won't be quoted, so would be suitable for appending to other quoted strings.

Parameters

mixed $value

Value to be prepared for database query

Return Value

string

Prepared string

in Database at line 333
string quoteString(mixed $value)

Wrap a string into DB-specific quotes.

Parameters

mixed $value

Value to be prepared for database query

Return Value

string

Prepared string

in Database at line 347
string escapeIdentifier(string|array $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|array $value

The identifier to escape or list of split components
string $separator

Splitter for each component

Return Value

string

in Database at line 364
protected array escapeColumnKeys(array $fieldValues)

Escapes unquoted columns keys in an associative array

Parameters

array $fieldValues

Return Value

array

List of field values with the keys as escaped column names

in Database at line 387
manipulate(array $manipulation)

Execute a complex manipulation on the database.

A manipulation is an array of insert / or update sequences. The keys of the array are table names, and the values are map containing 'command' and 'fields'. Command should be 'insert' or 'update', and fields should be a map of field names to field values, NOT including quotes.

The field values could also be in paramaterised format, such as array('MAX(?,?)' => array(42, 69)), allowing the use of raw SQL values such as array('NOW()' => array()).

Parameters

array $manipulation

See also

SQLWriteExpression::addAssignments for syntax examples

in Database at line 443
quiet()

Enable suppression of database messages.

in Database at line 451
clearAllData()

Clear all data out of the database

at line 552
clearTable(string $table)

Clear all data in a given table

Parameters

string $table

Name of table

in Database at line 476
string nullCheckClause(string $field, bool $isNull)

Generates a WHERE clause for null comparison check

Parameters

string $field

Quoted field name
bool $isNull

Whether to check for NULL or NOT NULL

Return Value

string

Non-parameterised null comparison clause

at line 425
string comparisonClause(string $field, string $value, bool $exact = false, bool $negate = false, bool $caseSensitive = null, bool $parameterised = false)

Generate a WHERE clause for text matching.

Parameters

string $field

Quoted field name
string $value

Escaped search. Can include percentage wildcards. Ignored if $parameterised is true.
bool $exact

Exact matches or wildcard support.
bool $negate

Negate the clause.
bool $caseSensitive

Enforce case sensitivity if TRUE or FALSE. Fallback to default collation if set to NULL.
bool $parameterised

Insert the ? placeholder rather than the given value. If this is true then $value is ignored.

Return Value

string SQL

at line 449
string formattedDatetimeClause(string $date, string $format)

function to return an SQL datetime expression that can be used with the adapter in use used for querying a datetime in a certain format

Parameters

string $date

to be formatted, can be either 'now', literal datetime like '1973-10-14 10:30:00' or field name, e.g. '"SiteTree"."Created"'
string $format

to be used, supported specifiers: %Y = Year (four digits) %m = Month (01..12) %d = Day (01..31) %H = Hour (00..23) %i = Minutes (00..59) %s = Seconds (00..59) %U = unix timestamp, can only be used on it's own

Return Value

string

SQL datetime expression to query for a formatted datetime

at line 471
string datetimeIntervalClause(string $date, string $interval)

function to return an SQL datetime expression that can be used with the adapter in use used for querying a datetime addition

Parameters

string $date

can be either 'now', literal datetime like '1973-10-14 10:30:00' or field name, e.g. '"SiteTree"."Created"'
string $interval

to be added, use the format [sign][integer] [qualifier], e.g. -1 Day, +15 minutes, +1 YEAR supported qualifiers:

  • years
  • months
  • days
  • hours
  • minutes
  • seconds This includes the singular forms as well

Return Value

string

SQL datetime expression to query for a datetime (YYYY-MM-DD hh:mm:ss) which is the result of the addition

at line 484
string datetimeDifferenceClause(string $date1, string $date2)

function to return an SQL datetime expression that can be used with the adapter in use used for querying a datetime subtraction

Parameters

string $date1

can be either 'now', literal datetime like '1973-10-14 10:30:00' or field name e.g. '"SiteTree"."Created"'
string $date2

to be subtracted of $date1, can be either 'now', literal datetime like '1973-10-14 10:30:00' or field name, e.g. '"SiteTree"."Created"'

Return Value

string

SQL datetime expression to query for the interval between $date1 and $date2 in seconds which is the result of the subtraction

in Database at line 564
string concatOperator()

String operator for concatenation of strings

Return Value

string

at line 139
bool supportsCollations()

Returns true if this database supports collations

Return Value

bool

at line 144
bool supportsTimezoneOverride()

Can the database override timezone as a connection setting, or does it use the system timezone exclusively?

Return Value

bool

in Database at line 589
string getVersion()

Query for the version of the currently connected database

Return Value

string

Version of this database

at line 149
string getDatabaseServer()

Get the database server type (e.g. mysql, postgresql).

This value is passed to the connector as the 'driver' argument when initiating a database connection

Return Value

string

in Database at line 607
int affectedRows()

Return the number of rows affected by the previous operation.

Return Value

int

at line 176
PaginatedList searchEngine(array $classesToSearch, string $keywords, int $start, int $pageLength, string $sortBy = "Relevance DESC", string $extraFilter = "", bool $booleanSearch = false, string $alternativeFileFilter = "", bool $invertedMatch = false)

The core search engine, used by this class and its subclasses to do fun stuff.

Searches both SiteTree and File.

Caution: While the $keywords argument is escaped for safe use in a query context, you need to ensure that it is also a valid boolean expression when opting into $booleanSearch. For example, the "asterisk" and "greater than" characters have a special meaning in this context, and can only be placed in certain parts of the keywords. You will need to preprocess and sanitise user input accordingly in order to avoid query errors.

Parameters

array $classesToSearch

List of classes to search
string $keywords

Keywords as a string.
int $start

Item to start returning results from
int $pageLength

Number of items per page
string $sortBy

Sort order expression
string $extraFilter

Additional filter
bool $booleanSearch

Flag for boolean search mode
string $alternativeFileFilter
bool $invertedMatch

Return Value

PaginatedList

Search results

Exceptions

Exception

at line 340
bool supportsTransactions()

Determines if this database supports transactions

Return Value

bool

Flag indicating support for transactions

at line 344
bool supportsSavepoints()

Does this database support savepoints in transactions By default it is assumed that they don't unless they are explicitly enabled.

Return Value

bool

Flag indicating support for savepoints in transactions

in Database at line 665
bool supportsTransactionMode(string $mode)

Determines if the used database supports given transactionMode as an argument to startTransaction() If transactions are completely unsupported, returns false.

Parameters

string $mode

Return Value

bool

in Database at line 681
withTransaction(callable $callback, callable $errorCallback = null, bool|string $transactionMode = false, bool $errorIfTransactionsUnsupported = false)

Invoke $callback within a transaction

Parameters

callable $callback

Callback to run
callable $errorCallback

Optional callback to run after rolling back transaction.
bool|string $transactionMode

Optional transaction mode to use
bool $errorIfTransactionsUnsupported

If true, this method will fail if transactions are unsupported. Otherwise, the $callback will potentially be invoked outside of a transaction.

Exceptions

Exception

in Database at line 719
supportsExtensions($extensions)

No description

Parameters

$extensions

at line 349
transactionStart(string|bool $transactionMode = false, string|bool $sessionCharacteristics = false)

Start a prepared transaction See http://developer.postgresql.org/pgdocs/postgres/sql-set-transaction.html for details on transaction isolation options

Parameters

string|bool $transactionMode

Transaction mode, or false to ignore
string|bool $sessionCharacteristics

Session characteristics, or false to ignore

at line 354
transactionSavepoint(string $savepoint)

Create a savepoint that you can jump back to if you encounter problems

Parameters

string $savepoint

Name of savepoint

at line 359
bool|null transactionRollback(string|bool $savepoint = false)

Rollback or revert to a savepoint if your queries encounter problems If you encounter a problem at any point during a transaction, you may need to rollback that particular query, or return to a savepoint

Parameters

string|bool $savepoint

Name of savepoint, or leave empty to rollback to last savepoint

Return Value

bool|null

Boolean is returned if success state is known, or null if unknown. Note: For error checking purposes null should not be treated as error.

at line 369
bool|null transactionEnd(bool $chain = false)

Commit everything inside this transaction so far

Parameters

bool $chain

Return Value

bool|null

Boolean is returned if success state is known, or null if unknown. Note: For error checking purposes null should not be treated as error.

at line 364
int transactionDepth()

Return depth of current transaction

Return Value

int

Nesting level, or 0 if not in a transaction

at line 502
bool supportsLocks()

Determines if the used database supports application-level locks, which is different from table- or row-level locking.

See getLock() for details.

Return Value

bool

Flag indicating that locking is available

at line 507
bool canLock(string $name)

Returns if the lock is available.

See supportsLocks() to check if locking is generally supported.

Parameters

string $name

Name of the lock

Return Value

bool

at line 513
bool getLock(string $name, int $timeout = 5)

Sets an application-level lock so that no two processes can run at the same time, also called a "cooperative advisory lock".

Return FALSE if acquiring the lock fails; otherwise return TRUE, if lock was acquired successfully. Lock is automatically released if connection to the database is broken (either normally or abnormally), making it less prone to deadlocks than session- or file-based locks. Should be accompanied by a releaseLock() call after the logic requiring the lock has completed. Can be called multiple times, in which case locks "stack" (PostgreSQL, SQL Server), or auto-releases the previous lock (MySQL).

Note that this might trigger the database to wait for the lock to be released, delaying further execution.

Parameters

string $name

Name of lock
int $timeout

Timeout in seconds

Return Value

bool

at line 523
bool releaseLock(string $name)

Remove an application-level lock file to allow another process to run (if the execution aborts (e.g. due to an error) all locks are automatically released).

Parameters

string $name

Name of the lock

Return Value

bool

Flag indicating whether the lock was successfully released

at line 78
connect(array $parameters)

Instruct the database to generate a live connection

Parameters

array $parameters

An map of parameters, which should include:

  • server: The server, eg, localhost
  • username: The username to log on with
  • password: The password to log on with
  • database: The database to connect to
  • charset: The character set to use. Defaults to utf8
  • timezone: (optional) The timezone offset. For example: +12:00, "Pacific/Auckland", or "SYSTEM"
  • driver: (optional) Driver name

in Database at line 870
bool databaseExists(string $name)

Determine if the database with the specified name exists

Parameters

string $name

Name of the database to check for

Return Value

bool

Flag indicating whether this database exists

in Database at line 880
array databaseList()

Retrieves the list of all databases the user has access to

Return Value

array

List of database names

in Database at line 897
bool selectDatabase(string $name, bool $create = false, int|bool $errorLevel = E_USER_ERROR)

Change the connection to the specified database, optionally creating the database if it doesn't exist in the current schema.

Parameters

string $name

Name of the database
bool $create

Flag indicating whether the database should be created if it doesn't exist. If $create is false and the database doesn't exist then an error will be raised
int|bool $errorLevel

The level of error reporting to enable for the query, or false if no error should be raised

Return Value

bool

Flag indicating success

in Database at line 923
dropSelectedDatabase()

Drop the database that this object is currently connected to.

Use with caution.

in Database at line 937
string|null getSelectedDatabase()

Returns the name of the currently selected database

Return Value

string|null

Name of the selected database, or null if none selected

at line 536
string now()

Return SQL expression used to represent the current date/time

Return Value

string

Expression for the current date/time

at line 542
string random()

Returns the database-specific version of the random() function

Return Value

string

Expression for a random value

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 118
setSQLMode(string $mode)

Sets the SQL mode

Parameters

string $mode

Connection mode

at line 131
selectTimezone(string $timezone)

Sets the system timezone for the database connection

Parameters

string $timezone

at line 327
protected TransactionManager getTransactionManager()

Returns the TransactionManager to handle transactions for this database.

Return Value

TransactionManager

at line 386
protected resetTransactionNesting()

In error condition, set transactionNesting to zero

at line 414
protected inspectQuery(string $sql)

Inspect a SQL query prior to execution

Parameters

string $sql

at line 529
protected getLockIdentifier($name)

No description

Parameters

$name