Db

Type

Class

Namespace

craft\helpers

Inherits

craft\helpers\Db

Since

3.0.0

Class Db

View source

Public Methods

Method	Description
areColumnTypesCompatible()	Returns whether two column type definitions are relatively compatible with each other.
batch()	Starts a batch query, similar to yii\db\Query::batch().
batchInsert()	Creates and executes a batch INSERT SQL statement.
delete()	Creates and executes a DELETE SQL statement.
deleteIfExists()	Creates and executes a DELETE SQL statement, but only if there are any rows to delete, avoiding deadlock issues when deleting data from large tables.
each()	Starts a batch query and retrieves data row by row.
escapeForLike()	Escapes underscores within a value for a LIKE condition.
escapeParam()	Escapes commas and asterisks in a string so they are not treated as special characters in craft\helpers\Db::parseParam().
extractGlue()	Extracts a “glue” param from an a param value.
getMaxAllowedValueForNumericColumn()	Returns the maximum number allowed for a given column type.
getMinAllowedValueForNumericColumn()	Returns the minimum number allowed for a given column type.
getNumericalColumnType()	Returns a number column type, taking the min, max, and number of decimal points into account.
getSimplifiedColumnType()	Returns a simplified version of a given column type.
getTextualColumnStorageCapacity()	Returns the maximum number of bytes a given textual column type can hold for a given database.
getTextualColumnTypeByContentLength()	Given a length of a piece of content, returns the underlying database column type to use for saving.
idByUid()	Returns the id of a row in the given table by its uid.
idsByUids()	Returns an array uid:id pairs from a given table, by their uids.
insert()	Creates and executes an INSERT SQL statement.
isNumericColumnType()	Returns whether the given column type is numeric.
isTextualColumnType()	Returns whether the given column type is textual.
isTypeSupported()	Returns whether a given DB connection’s schema supports a column type.
normalizeParam()	Normalizes a param value with a provided resolver function, unless the resolver function ever returns an empty value.
parseBooleanParam()	Parses a query param value for a boolean column and returns a yii\db\QueryInterface::where()-compatible condition.
parseColumnLength()	Parses a column type definition and returns just the column length/size.
parseColumnType()	Parses a column type definition and returns just the column type, if it can be determined.
parseDateParam()	Parses a query param value for a date/time column, and returns a yii\db\QueryInterface::where()-compatible condition.
parseDsn()	Parses a DSN string and returns an array with the driver and any driver params, or just a single key.
parseParam()	Parses a query param value and returns a yii\db\QueryInterface::where()-compatible condition.
prepareDateForDb()	Prepares a date to be sent to the database.
prepareValueForDb()	Prepares a value to be sent to the database.
prepareValuesForDb()	Prepares an array or object’s values to be sent to the database.
replace()	Creates and executes a SQL statement for replacing some text with other text in a given table column.
reset()	Resets the memoized database connection.
supportsTimeZones()	Returns whether the database supports time zone conversions.
truncateTable()	Creates and executes a TRUNCATE TABLE SQL statement.
uidById()	Returns the uid of a row in the given table by its id.
uidsByIds()	Returns an array id:uid pairs from a given table, by their ids.
update()	Creates and executes an UPDATE SQL statement.
upsert()	Creates and executes a command to insert rows into a database table if they do not already exist (matching unique constraints), or update them if they do.
url2config()	Generates a DB config from a database connection URL.

areColumnTypesCompatible()

Returns whether two column type definitions are relatively compatible with each other.

View source

Arguments

• $typeA (string)
• $typeB (string)

Returns

boolean

batch()

Since

3.7.0

Starts a batch query, similar to yii\db\Query::batch().

Each iteration will be a batch of rows.

foreach (Db::batch($query) as $batch) {
    foreach ($batch as $row) {
        // ...
    }
}

If using MySQL and $db is null, a new unbuffered DB connection will be created for the query so that the data can actually be retrieved in batches, to work around limitations with query batching in MySQL. Therefore keep in mind that the data retrieved by the batch query won’t reflect any changes that have been made over the main DB connection, if a transaction is currently active.

View source

Arguments

• $query (yii\db\Query) – The query that should be executed
• $batchSize (integer) – The number of rows to be fetched in each batch

Returns

yii\db\BatchQueryResult – The batched query to be iterated on

batchInsert()

Since

3.5.0

Creates and executes a batch INSERT SQL statement.

The method will properly escape the column names, and bind the values to be inserted.

View source

Arguments

• $table (string) – The table that new rows will be inserted into
• $columns (array) – The column names
• $rows (array) – The rows to be batch inserted into the table
• $includeAuditColumns (boolean) – Whether dateCreated, dateUpdated, and uid values should be added to $columns
• $db (craft\db\Connection, null) – The database connection to use

Returns

integer – The number of rows affected by the execution

Throws

• yii\db\Exception
  if execution failed

delete()

Since

3.5.0

Creates and executes a DELETE SQL statement.

View source

Arguments

• $table (string) – The table where the data will be deleted from
• $condition (array, string) – The conditions that will be put in the WHERE part. Please refer to craft\db\Query::where() on how to specify conditions.
• $params (array) – The parameters to be bound to the query.
• $db (craft\db\Connection, null) – The database connection to use

Returns

integer – The number of rows affected by the execution

Throws

• yii\db\Exception
  if execution failed

deleteIfExists()

Since

3.0.12

Creates and executes a DELETE SQL statement, but only if there are any rows to delete, avoiding deadlock issues when deleting data from large tables.

View source

Arguments

• $table (string) – The table where the data will be deleted from
• $condition (string, array) – The condition that will be put in the WHERE part. Please refer to craft\db\Query::where() on how to specify condition.
• $params (array) – The parameters to be bound to the command
• $db (craft\db\Connection, null) – The database connection to use

Returns

integer – Number of rows affected by the execution

Throws

• yii\db\Exception
  execution failed

each()

Since

3.7.0

Starts a batch query and retrieves data row by row.

This method is similar to batch() except that in each iteration of the result, only one row of data is returned.

foreach (Db::each($query) as $row) {
    // ...
}

If using MySQL and $db is null, a new unbuffered DB connection will be created for the query so that the data can actually be retrieved in batches, to work around limitations with query batching in MySQL. Therefore keep in mind that the data retrieved by the batch query won’t reflect any changes that have been made over the main DB connection, if a transaction is currently active.

View source

Arguments

• $query (yii\db\Query) – The query that should be executed
• $batchSize (integer) – The number of rows to be fetched in each batch

Returns

yii\db\BatchQueryResult – The batched query to be iterated on

escapeForLike()

Since

3.7.64

Escapes underscores within a value for a LIKE condition.

View source

Arguments

• $value (string) – The value

Returns

string – The escaped value

escapeParam()

Escapes commas and asterisks in a string so they are not treated as special characters in craft\helpers\Db::parseParam().

View source

Arguments

• $value (string) – The param value.

Returns

string – The escaped param value.

extractGlue()

Since

3.7.40

Extracts a “glue” param from an a param value.

Supported glue values are and, or, and not.

View source

Arguments

• $value (mixed)

Returns

string, null

getMaxAllowedValueForNumericColumn()

Returns the maximum number allowed for a given column type.

View source

Arguments

• $columnType (string)

Returns

integer, false – The max allowed number, or false if it can't be determined

getMinAllowedValueForNumericColumn()

Returns the minimum number allowed for a given column type.

View source

Arguments

• $columnType (string)

Returns

integer, false – The min allowed number, or false if it can't be determined

getNumericalColumnType()

Returns a number column type, taking the min, max, and number of decimal points into account.

View source

Arguments

• $min (integer, null)
• $max (integer, null)
• $decimals (integer, null)

Returns

string

Throws

• yii\base\Exception
  if no column types can contain this

getSimplifiedColumnType()

Returns a simplified version of a given column type.

View source

Arguments

• $columnType (string)

Returns

string

getTextualColumnStorageCapacity()

Returns the maximum number of bytes a given textual column type can hold for a given database.

View source

Arguments

• $columnType (string) – The textual column type to check
• $db (craft\db\Connection, null) – The database connection

Returns

integer, null, false – The storage capacity of the column type in bytes, null if unlimited, or false or it can't be determined.

getTextualColumnTypeByContentLength()

Given a length of a piece of content, returns the underlying database column type to use for saving.

View source

Arguments

• $contentLength (integer)
• $db (craft\db\Connection, null) – The database connection

Returns

string

Throws

• yii\base\Exception
  if using an unsupported connection type

idByUid()

Since

3.1.0

Returns the id of a row in the given table by its uid.

View source

Arguments

• $table (string)
• $uid (string)
• $db (craft\db\Connection, null) – The database connection to use

Returns

integer, null

idsByUids()

Since

3.1.0

Returns an array uid:id pairs from a given table, by their uids.

View source

Arguments

• $table (string)
• $uids (string[])
• $db (craft\db\Connection, null) – The database connection to use

Returns

string[]

insert()

Since

3.5.0

Creates and executes an INSERT SQL statement.

The method will properly escape the column names, and bind the values to be inserted.

View source

Arguments

• $table (string) – The table that new rows will be inserted into
• $columns (array) – The column data (name=>value) to be inserted into the table
• $includeAuditColumns (boolean) – Whether to include the data for the audit columns (dateCreated, dateUpdated, and uid)
• $db (craft\db\Connection, null) – The database connection to use

Returns

integer – The number of rows affected by the execution

Throws

• yii\db\Exception
  if execution failed

isNumericColumnType()

Returns whether the given column type is numeric.

View source

Arguments

• $columnType (string)

Returns

boolean

isTextualColumnType()

Returns whether the given column type is textual.

View source

Arguments

• $columnType (string)

Returns

boolean

isTypeSupported()

Returns whether a given DB connection’s schema supports a column type.

View source

Arguments

• $type (string)
• $db (craft\db\Connection, null)

Returns

boolean

Throws

• yii\base\NotSupportedException

normalizeParam()

Since

3.7.40

Normalizes a param value with a provided resolver function, unless the resolver function ever returns an empty value.

If the original param value began with and, or, or not, that will be preserved.

View source

Arguments

• $value (mixed) – The param value to be normalized
• $resolver (callable) – Method to resolve non-model values to models

Returns

boolean – Whether the value was normalized

parseBooleanParam()

Since

3.4.14

Parses a query param value for a boolean column and returns a yii\db\QueryInterface::where()-compatible condition.

The follow values are supported:

• true or false
• :empty: or :notempty: (normalizes to false and true)
• 'not x' or '!= x' (normalizes to the opposite of the boolean value of x)
• Anything else (normalizes to the boolean value of itself)

If $defaultValue is set, and it matches the normalized $value, then the resulting condition will match any null values as well.

View source

Arguments

• $column (string) – The database column that the param is targeting.
• $value (string, boolean) – The param value
• $defaultValue (boolean, null) – How null values should be treated

Returns

mixed

parseColumnLength()

Parses a column type definition and returns just the column length/size.

View source

Arguments

• $columnType (string)

Returns

integer, null

parseColumnType()

Parses a column type definition and returns just the column type, if it can be determined.

View source

Arguments

• $columnType (string)

Returns

string, null

parseDateParam()

Parses a query param value for a date/time column, and returns a yii\db\QueryInterface::where()-compatible condition.

View source

Arguments

• $column (string) – The database column that the param is targeting.
• $value (string, array, DateTime) – The param value
• $defaultOperator (string) – The default operator to apply to the values (can be not, !=, <=, >=, <, >, or =)

Returns

mixed

parseDsn()

Since

3.4.0

Parses a DSN string and returns an array with the driver and any driver params, or just a single key.

View source

Arguments

• $dsn (string)
• $key (string, null) – The key that is needed from the DSN, if only one param is needed.

Returns

array, string, false – The full array, or the specific key value, or false if $key is a param that doesn’t exist in the DSN string.

Throws

• yii\base\InvalidArgumentException
  if $dsn is invalid

parseParam()

Parses a query param value and returns a yii\db\QueryInterface::where()-compatible condition.

If the $value is a string, it will automatically be converted to an array, split on any commas within the string (via craft\helpers\ArrayHelper::toArray()). If that is not desired behavior, you can escape the comma with a backslash before it.

The first value can be set to either and, or, or not to define whether all, any, or none of the values must match. (or will be assumed by default.)

Values can begin with the operators 'not ', '!=', '<=', '>=', '<', '>', or '='. If they don’t, '=' will be assumed.

Values can also be set to either ':empty:' or ':notempty:' if you want to search for empty or non-empty database values. (An “empty” value is either NULL or an empty string of text).

View source

Arguments

• $column (string) – The database column that the param is targeting.
• $value (string, integer, array) – The param value(s).
• $defaultOperator (string) – The default operator to apply to the values (can be not, !=, <=, >=, <, >, or =)
• $caseInsensitive (boolean) – Whether the resulting condition should be case-insensitive
• $columnType (string, null) – The database column type the param is targeting

Returns

mixed

prepareDateForDb()

Prepares a date to be sent to the database.

View source

Arguments

• $date (mixed) – The date to be prepared
• $stripSeconds (boolean) – Whether the seconds should be omitted from the formatted string

Returns

string, null – The prepped date, or null if it could not be prepared

prepareValueForDb()

Prepares a value to be sent to the database.

View source

Arguments

• $value (mixed) – The value to be prepared

Returns

mixed – The prepped value

prepareValuesForDb()

Prepares an array or object’s values to be sent to the database.

View source

Arguments

• $values (mixed) – The values to be prepared

Returns

array – The prepared values

replace()

Since

3.5.0

Creates and executes a SQL statement for replacing some text with other text in a given table column.

View source

Arguments

• $table (string) – The table to be updated
• $column (string) – The column to be searched
• $find (string) – The text to be searched for
• $replace (string) – The replacement text
• $condition (string, array) – The condition that will be put in the WHERE part. Please refer to craft\db\Query::where() on how to specify condition.
• $params (array) – The parameters to be bound to the command
• $db (craft\db\Connection, null) – The database connection to use

Returns

integer – The number of rows affected by the execution

Throws

• yii\db\Exception
  if execution failed

reset()

Since

3.5.12.1

Resets the memoized database connection.

View source

supportsTimeZones()

Since

3.6.16

Returns whether the database supports time zone conversions.

This could return false if MySQL’s time zone tables haven’t been populated yet. See https://dev.mysql.com/doc/refman/5.7/en/time-zone-support.html for more info.

View source

Arguments

• $db (craft\db\Connection, null)

Returns

boolean

truncateTable()

Since

3.6.8

Creates and executes a TRUNCATE TABLE SQL statement.

View source

Arguments

• $table (string) – The table where the data will be deleted from
• $db (craft\db\Connection, null) – The database connection to use

Returns

integer – The number of rows affected by the execution

Throws

• yii\db\Exception
  if execution failed

uidById()

Since

3.1.0

Returns the uid of a row in the given table by its id.

View source

Arguments

• $table (string)
• $id (integer)
• $db (craft\db\Connection, null) – The database connection to use

Returns

string, null

uidsByIds()

Since

3.1.0

Returns an array id:uid pairs from a given table, by their ids.

View source

Arguments

• $table (string)
• $ids (integer[])
• $db (craft\db\Connection, null) – The database connection to use

Returns

string[]

update()

Since

3.5.0

Creates and executes an UPDATE SQL statement.

The method will properly escape the column names and bind the values to be updated.

View source

Arguments

• $table (string) – The table to be updated
• $columns (array) – The column data (name => value) to be updated
• $condition (string, array) – The condition that will be put in the WHERE part. Please refer to craft\db\Query::where() on how to specify condition
• $params (array) – The parameters to be bound to the command
• $includeAuditColumns (boolean) – Whether the dateUpdated value should be added to $columns
• $db (craft\db\Connection, null) – The database connection to use

Returns

integer – The number of rows affected by the execution

Throws

• yii\db\Exception
  if execution failed

upsert()

Since

3.5.0

Creates and executes a command to insert rows into a database table if they do not already exist (matching unique constraints), or update them if they do.

The method will properly escape the column names, and bind the values to be inserted.

View source

Arguments

• $table (string) – The table that new rows will be inserted into/updated in

• $insertColumns (array, craft\db\Query) – The column data (name => value) to be inserted into the table or instance of craft\db\Query to perform INSERT INTO ... SELECT SQL statement

• $updateColumns (array, boolean) – The column data (name => value) to be updated if they already exist

• If true is passed, the column data will be updated to match the insert column data.

• If false is passed, no update will be performed if the column data already exists.

• $params (array) – The parameters to be bound to the command

• $includeAuditColumns (boolean) – Whether dateCreated, dateUpdated, and uid values should be added to $columns

• $db (craft\db\Connection, null) – The database connection to use

Returns

integer – The number of rows affected by the execution

Throws

• yii\db\Exception
  if execution failed

url2config()

Since

3.4.0

Generates a DB config from a database connection URL.

This can be used from config/db.php:

View source

Arguments

• $url (string)

Returns

array

---

Example

php

$url = craft\helpers\App::env('DB_URL');
return craft\helpers\Db::url2config($url);

Constants

Constant	Description
GLUE_AND
GLUE_NOT
GLUE_OR
SIMPLE_TYPE_NUMERIC
SIMPLE_TYPE_TEXTUAL