Drupal\Core\Database\Driver\mysql\Schema | Drupal Core API Explorer

class Schema extends Schema (View source)

MySQL implementation of \Drupal\Core\Database\Schema.

Constants

COMMENT_MAX_TABLE

Maximum length of a table comment in MySQL.

COMMENT_MAX_COLUMN

Maximum length of a column comment in MySQL.

Properties

protected Connection	$connection	The database connection.	from Schema
protected int	$placeholder	The placeholder counter.	from Schema
protected string	$defaultSchema	Definition of prefixInfo array structure.	from Schema
protected string	$uniqueIdentifier	A unique identifier for this query object.	from Schema
protected array	$mysqlStringTypes

Methods

__construct($connection)

No description

from Schema

__clone()

Implements the magic __clone function.

from Schema

uniqueIdentifier()

Returns a unique identifier for this object.

from Schema

The

nextPlaceholder()

Returns the next placeholder ID for the query.

from Schema

array

getPrefixInfo(string $table = 'default', bool $add_prefix = TRUE)

Get information about the table and database name from the prefix.

prefixNonTable($table)

Create names for indexes, primary keys and constraints.

from Schema

Condition

buildTableNameCondition($table_name, $operator = '=', $add_prefix = TRUE)

Build a condition to match a table name against a standard information_schema.

true

tableExists($table)

Check if a table exists.

array

findTables(string $table_expression)

Finds all tables that are like the specified base table name.

from Schema

true

fieldExists(string $table, string $column)

Check if a column exists in the given table.

array

getFieldTypeMap()

Returns a mapping of Drupal schema field names to DB-native field types.

renameTable($table, $new_name)

Rename a table.

true

dropTable($table)

Drop a table.

addField($table, $field, $spec, $keys_new = [])

Add a new field to a table.

true

dropField($table, $field)

Drop a field.

true

indexExists($table, $name)

Checks if an index exists in the given table.

addPrimaryKey($table, $fields)

Add a primary key.

true

dropPrimaryKey($table)

Drop the primary key.

string[]|false

findPrimaryKeyColumns(string $table)

Finds the primary key columns of a table, from the database.

addUniqueKey($table, $name, $fields)

Add a unique key.

true

dropUniqueKey($table, $name)

Drop a unique key.

addIndex($table, $name, $fields, array $spec)

Add an index.

true

dropIndex($table, $name)

Drop an index.

array

introspectIndexSchema(string $table)

Finds the columns for the primary key, unique keys and indexes of a table.

changeField($table, $field, $field_new, $spec, $keys_new = [])

Change a field definition.

createTable($name, $table)

Create a new table from a Drupal table definition.

from Schema

fieldNames($fields)

Return an array of field names from an array of key/index column specifiers.

from Schema

The

prepareComment($comment, $length = NULL)

Prepare a table or column comment for database query.

string|int|float

escapeDefaultValue(mixed $value)

Return an escaped version of its parameter to be used as a default value on a column.

from Schema

ensureNotNullPrimaryKey(array $primary_key, array $fields)

Ensures that all the primary key fields are correctly defined.

from Schema

createTableSql($name, $table)

Generate SQL to create a new table from a Drupal schema definition.

createFieldSql(string $name, array $spec)

Create an SQL string for a field to be used in table creation or alteration.

processField($field)

Set database-engine specific properties for a field.

createKeysSql($spec)

No description

array

getNormalizedIndexes(array $spec)

Gets normalized indexes from a table specification.

shortenIndex(array $index)

Helper function for normalizeIndexes().

createKeySql($fields)

No description

getComment($table, $column = NULL)

Retrieve a table or column comment.

Details

in Schema at line 46
`__construct($connection)`

No description

Parameters

$connection

in Schema at line 54
`__clone()`

Implements the magic __clone function.

in Schema at line 61
`uniqueIdentifier()`

Returns a unique identifier for this object.

in Schema at line 68
`The nextPlaceholder()`

Returns the next placeholder ID for the query.

Return Value

The	next available placeholder ID as an integer.

at line 50
`protected array getPrefixInfo(string $table = 'default', bool $add_prefix = TRUE)`

Get information about the table and database name from the prefix.

Parameters

string	$table	Name of table to look prefix up for. Defaults to 'default' because that's default key for prefix.
bool	$add_prefix	Boolean that indicates whether the given table name should be prefixed.

Return Value

array

A keyed array with information about the schema, table name and prefix.

in Schema at line 113
`prefixNonTable($table)`

Create names for indexes, primary keys and constraints.

This prevents using } around non-table names like indexes and keys.

Parameters

$table

at line 74
`protected Condition buildTableNameCondition($table_name, $operator = '=', $add_prefix = TRUE)`

Build a condition to match a table name against a standard information_schema.

MySQL uses databases like schemas rather than catalogs so when we build a condition to query the information_schema.tables, we set the default database as the schema unless specified otherwise, and exclude table_catalog from the condition criteria.

Parameters

	$table_name	The name of the table in question.
	$operator	The operator to apply on the 'table' part of the condition.
	$add_prefix	Boolean to indicate whether the table name needs to be prefixed.

Return Value

Condition

A Condition object.

at line 674
`true tableExists($table)`

Check if a table exists.

Parameters

$table

The name of the table in drupal (no prefixing).

Return Value

true	if the given table exists, otherwise FALSE.

in Schema at line 188
`array findTables(string $table_expression)`

Finds all tables that are like the specified base table name.

Parameters

string

$table_expression

An SQL expression, for example "cache_%" (without the quotes).

Return Value

array

Both the keys and the values are the matching tables.

at line 694
`true fieldExists(string $table, string $column)`

Check if a column exists in the given table.

Parameters

string	$table	The name of the table in drupal (no prefixing).
string	$column	The name of the column.

Return Value

true	if the given column exists, otherwise FALSE.

at line 236
`array getFieldTypeMap()`

Returns a mapping of Drupal schema field names to DB-native field types.

Because different field types do not map 1:1 between databases, Drupal has its own normalized field type names. This function returns a driver-specific mapping table from Drupal names to the native names for each database.

Return Value

array

An array of Schema API field types to driver-specific field types.

at line 379
`renameTable($table, $new_name)`

Rename a table.

Parameters

	$table	The table to be renamed.
	$new_name	The new name for the table.

Exceptions

SchemaObjectDoesNotExistException
SchemaObjectExistsException

at line 394
`true dropTable($table)`

Drop a table.

Parameters

$table

The table to be dropped.

Return Value

true	if the table was successfully dropped, FALSE if there was no table by that name to begin with.

at line 406
`addField($table, $field, $spec, $keys_new = [])`

Add a new field to a table.

Parameters

	$table	Name of the table to be altered.
	$field	Name of the field to be added.
	$spec	The field specification array, as taken from a schema definition. The specification may also contain the key 'initial', the newly created field will be set to the value of the key in all rows. This is most useful for creating NOT NULL columns with no default value in existing tables. Alternatively, the 'initial_form_field' key may be used, which will auto-populate the new field with values from the specified field.
	$keys_new	(optional) Keys and indexes specification to be created on the table along with adding the field. The format is the same as a table specification but without the 'fields' element. If you are adding a type 'serial' field, you MUST specify at least one key or index including it in this array. See ::changeField() for more explanation why.

Exceptions

SchemaObjectDoesNotExistException
SchemaObjectExistsException

at line 465
`true dropField($table, $field)`

Drop a field.

Parameters

	$table	The table to be altered.
	$field	The field to be dropped.

Return Value

true	if the field was successfully dropped, FALSE if there was no field by that name to begin with.

at line 489
`true indexExists($table, $name)`

Checks if an index exists in the given table.

Parameters

	$table	The name of the table in drupal (no prefixing).
	$name	The name of the index in drupal (no prefixing).

Return Value

true	if the given index exists, otherwise FALSE.

at line 499
`addPrimaryKey($table, $fields)`

Add a primary key.

Parameters

	$table	The table to be altered.
	$fields	Fields for the primary key.

Exceptions

SchemaObjectDoesNotExistException
SchemaObjectExistsException

at line 513
`true dropPrimaryKey($table)`

Drop the primary key.

Parameters

$table

The table to be altered.

Return Value

true	if the primary key was successfully dropped, FALSE if there was no primary key on this table to begin with.

at line 525
`protected string[]|false findPrimaryKeyColumns(string $table)`

Finds the primary key columns of a table, from the database.

Parameters

string

$table

The name of the table.

Return Value

string[]|false

A simple array with the names of the columns composing the table's primary key, or FALSE if the table does not exist.

Exceptions

RuntimeException

at line 536
`addUniqueKey($table, $name, $fields)`

Add a unique key.

Parameters

	$table	The table to be altered.
	$name	The name of the key.
	$fields	An array of field names.

Exceptions

SchemaObjectDoesNotExistException
SchemaObjectExistsException

at line 550
`true dropUniqueKey($table, $name)`

Drop a unique key.

Parameters

	$table	The table to be altered.
	$name	The name of the key.

Return Value

true	if the key was successfully dropped, FALSE if there was no key by that name to begin with.

at line 562
`addIndex($table, $name, $fields, array $spec)`

Add an index.

Parameters

	$table	The table to be altered.
	$name	The name of the index.
	$fields	An array of field names or field information; if field information is passed, it's an array whose first element is the field name and whose second is the maximum length in the index. For example, the following will use the full length of the `foo` field, but limit the `bar` field to 4 characters: @code $fields = ['foo', ['bar', 4]]; @endcode
array	$spec	The table specification for the table to be altered. This is used in order to be able to ensure that the index length is not too long. This schema definition can usually be obtained through hook_schema(), or in case the table was created by the Entity API, through the schema handler listed in the entity class definition. For reference, see SqlContentEntityStorageSchema::getDedicatedTableSchema() and SqlContentEntityStorageSchema::getSharedTableFieldSchema(). In order to prevent human error, it is recommended to pass in the complete table specification. However, in the edge case of the complete table specification not being available, we can pass in a partial table definition containing only the fields that apply to the index: @code $spec = [ // Example partial specification for a table: 'fields' => [ 'example_field' => [ 'description' => 'An example field', 'type' => 'varchar', 'length' => 32, 'not null' => TRUE, 'default' => '', ], ], 'indexes' => [ 'table_example_field' => ['example_field'], ], ]; @endcode Note that the above is a partial table definition and that we would usually pass a complete table definition as obtained through hook_schema() instead.

Exceptions

SchemaObjectDoesNotExistException
SchemaObjectExistsException

at line 579
`true dropIndex($table, $name)`

Drop an index.

Parameters

	$table	The table to be altered.
	$name	The name of the index.

Return Value

true	if the index was successfully dropped, FALSE if there was no index by that name to begin with.

at line 591
`protected array introspectIndexSchema(string $table)`

Finds the columns for the primary key, unique keys and indexes of a table.

Parameters

string

$table

The name of the table.

Return Value

array

A schema array with the following keys: 'primary key', 'unique keys' and 'indexes', and values as arrays of database columns.

Exceptions

SchemaObjectDoesNotExistException
RuntimeException

at line 621
`changeField($table, $field, $field_new, $spec, $keys_new = [])`

Change a field definition.

IMPORTANT NOTE: To maintain database portability, you have to explicitly recreate all indices and primary keys that are using the changed field.

That means that you have to drop all affected keys and indexes with Schema::dropPrimaryKey(), Schema::dropUniqueKey(), or Schema::dropIndex() before calling ::changeField(). To recreate the keys and indices, pass the key definitions as the optional $keys_new argument directly to ::changeField().

For example, suppose you have:

Parameters

	$table	Name of the table.
	$field	Name of the field to change.
	$field_new	New name for the field (set to the same as $field if you don't want to change the name).
	$spec	The field specification for the new field.
	$keys_new	(optional) Keys and indexes specification to be created on the table along with changing the field. The format is the same as a table specification but without the 'fields' element.

Exceptions

SchemaObjectDoesNotExistException
SchemaObjectExistsException

in Schema at line 612
`createTable($name, $table)`

Create a new table from a Drupal table definition.

Parameters

	$name	The name of the table to create.
	$table	A Schema API table definition array.

Exceptions

SchemaObjectExistsException

in Schema at line 634
`An fieldNames($fields)`

Return an array of field names from an array of key/index column specifiers.

This is usually an identity function but if a key/index uses a column prefix specification, this function extracts just the name.

Parameters

$fields

An array of key/index column specifiers.

Return Value

An	array of field names.

at line 642
`The prepareComment($comment, $length = NULL)`

Prepare a table or column comment for database query.

Parameters

	$comment	The comment string to prepare.
	$length	Optional upper limit on the returned string length.

Return Value

The	prepared comment.

in Schema at line 674
`protected string|int|float escapeDefaultValue(mixed $value)`

Return an escaped version of its parameter to be used as a default value on a column.

Parameters

mixed

$value

The value to be escaped (int, float, null or string).

Return Value

string|int|float

The escaped value.

in Schema at line 694
`protected ensureNotNullPrimaryKey(array $primary_key, array $fields)`

Ensures that all the primary key fields are correctly defined.

Parameters

array	$primary_key	An array containing the fields that will form the primary key of a table.
array	$fields	An array containing the field specifications of the table, as per the schema data structure format.

Exceptions

SchemaException

at line 94
`protected An createTableSql($name, $table)`

Generate SQL to create a new table from a Drupal schema definition.

Parameters

	$name	The name of the table to create.
	$table	A Schema API table definition array.

Return Value

An	array of SQL statements to create the table.

at line 148
`protected createFieldSql(string $name, array $spec)`

Create an SQL string for a field to be used in table creation or alteration.

Parameters

string	$name	Name of the field.
array	$spec	The field specification, as per the schema data structure format.

at line 210
`protected processField($field)`

Set database-engine specific properties for a field.

Parameters

$field

A field description array, as specified in the schema documentation.

at line 279
`protected createKeysSql($spec)`

No description

Parameters

$spec

at line 315
`protected array getNormalizedIndexes(array $spec)`

Gets normalized indexes from a table specification.

Shortens indexes to 191 characters if they apply to utf8mb4-encoded fields, in order to comply with the InnoDB index limitation of 756 bytes.

Parameters

array

$spec

The table specification.

Return Value

array

List of shortened indexes.

Exceptions

SchemaException

at line 352
`protected shortenIndex(array $index)`

Helper function for normalizeIndexes().

Shortens an index to 191 characters.

Parameters

array

$index

The index array to be used in createKeySql.

at line 363
`protected createKeySql($fields)`

No description

Parameters

$fields

at line 656
`getComment($table, $column = NULL)`

Retrieve a table or column comment.

Parameters

	$table
	$column

\Drupal\Core\Database\Driver\mysql\Drupal\Core\Database\Driver\mysql\Schema::createKeySql()
\Drupal\Core\Database\Driver\mysql\Drupal\Core\Database\Driver\mysql\Schema::normalizeIndexes()

Schema

Constants

Properties

Methods

Details

in Schema at line 46 __construct($connection)

Parameters

in Schema at line 54 __clone()

in Schema at line 61 uniqueIdentifier()

in Schema at line 68 The nextPlaceholder()

Return Value

at line 50 protected array getPrefixInfo(string $table = 'default', bool $add_prefix = TRUE)

Parameters

Return Value

in Schema at line 113 prefixNonTable($table)

Parameters

at line 74 protected Condition buildTableNameCondition($table_name, $operator = '=', $add_prefix = TRUE)

Parameters

Return Value

at line 674 true tableExists($table)

Parameters

Return Value

in Schema at line 188 array findTables(string $table_expression)

Parameters

Return Value

at line 694 true fieldExists(string $table, string $column)

Parameters

Return Value

at line 236 array getFieldTypeMap()

Return Value

at line 379 renameTable($table, $new_name)

Parameters

Exceptions

at line 394 true dropTable($table)

Parameters

Return Value

at line 406 addField($table, $field, $spec, $keys_new = [])

Parameters

Exceptions

at line 465 true dropField($table, $field)

Parameters

Return Value

at line 489 true indexExists($table, $name)

Parameters

Return Value

at line 499 addPrimaryKey($table, $fields)

Parameters

Exceptions

at line 513 true dropPrimaryKey($table)

Parameters

Return Value

at line 525 protected string[]|false findPrimaryKeyColumns(string $table)

Parameters

Return Value

Exceptions

at line 536 addUniqueKey($table, $name, $fields)

Parameters

Exceptions

at line 550 true dropUniqueKey($table, $name)

Parameters

Return Value

at line 562 addIndex($table, $name, $fields, array $spec)

Parameters

Exceptions

at line 579 true dropIndex($table, $name)

Parameters

Return Value

at line 591 protected array introspectIndexSchema(string $table)

Parameters

Return Value

Exceptions

at line 621 changeField($table, $field, $field_new, $spec, $keys_new = [])

Parameters

Exceptions

in Schema at line 612 createTable($name, $table)

Parameters

Exceptions

in Schema at line 634 An fieldNames($fields)

Parameters

Return Value

in Schema at line 46
`__construct($connection)`

in Schema at line 54
`__clone()`

in Schema at line 61
`uniqueIdentifier()`

in Schema at line 68
`The nextPlaceholder()`

at line 50
`protected array getPrefixInfo(string $table = 'default', bool $add_prefix = TRUE)`

in Schema at line 113
`prefixNonTable($table)`

at line 74
`protected Condition buildTableNameCondition($table_name, $operator = '=', $add_prefix = TRUE)`

at line 674
`true tableExists($table)`

in Schema at line 188
`array findTables(string $table_expression)`

at line 694
`true fieldExists(string $table, string $column)`

at line 236
`array getFieldTypeMap()`

at line 379
`renameTable($table, $new_name)`

at line 394
`true dropTable($table)`

at line 406
`addField($table, $field, $spec, $keys_new = [])`

at line 465
`true dropField($table, $field)`

at line 489
`true indexExists($table, $name)`

at line 499
`addPrimaryKey($table, $fields)`

at line 513
`true dropPrimaryKey($table)`

at line 525
`protected string[]|false findPrimaryKeyColumns(string $table)`

at line 536
`addUniqueKey($table, $name, $fields)`

at line 550
`true dropUniqueKey($table, $name)`

at line 562
`addIndex($table, $name, $fields, array $spec)`

at line 579
`true dropIndex($table, $name)`

at line 591
`protected array introspectIndexSchema(string $table)`

at line 621
`changeField($table, $field, $field_new, $spec, $keys_new = [])`

in Schema at line 612
`createTable($name, $table)`

in Schema at line 634
`An fieldNames($fields)`

at line 642
`The prepareComment($comment, $length = NULL)`

in Schema at line 674
`protected string|int|float escapeDefaultValue(mixed $value)`

in Schema at line 694
`protected ensureNotNullPrimaryKey(array $primary_key, array $fields)`

at line 94
`protected An createTableSql($name, $table)`

at line 148
`protected createFieldSql(string $name, array $spec)`

at line 210
`protected processField($field)`

at line 279
`protected createKeysSql($spec)`

at line 315
`protected array getNormalizedIndexes(array $spec)`

at line 352
`protected shortenIndex(array $index)`

at line 363
`protected createKeySql($fields)`

at line 656
`getComment($table, $column = NULL)`