Schema
class Schema extends Schema (View source)
PostgreSQL implementation of \Drupal\Core\Database\Schema.
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 | $tableInformation | A cache of information about blob columns and sequences of tables. |
|
| protected int | $maxIdentifierLength | The maximum allowed length for index, primary key and constraint names. |
|
| protected string | $tempNamespaceName | PostgreSQL's temporary namespace name. |
Methods
Get information about the table name and schema from the prefix.
Build a condition to match a table name against a standard information_schema.
Check if a table exists.
Finds all tables that are like the specified base table name.
Check if a column exists in the given table.
Returns a mapping of Drupal schema field names to DB-native field types.
Rename a table.
Drop a table.
Add a new field to a table.
Drop a field.
Checks if an index exists in the given table.
Add a primary key.
Drop the primary key.
Finds the primary key columns of a table, from the database.
Add a unique key.
Drop a unique key.
Add an index.
Drop an index.
Finds the columns for the primary key, unique keys and indexes of a table.
Change a field definition.
Return an array of field names from an array of key/index column specifiers.
Prepare a table or column comment for database query.
Return an escaped version of its parameter to be used as a default value on a column.
Ensures that all the primary key fields are correctly defined.
Make sure to limit identifiers according to PostgreSQL compiled in length.
Fetch the list of blobs and sequences used on a table.
Gets PostgreSQL's temporary namespace name.
Resets information about table blobs, sequences and serial fields.
Fetches the list of constraints used on a field.
Generate SQL to create a new table from a Drupal schema definition.
Create an SQL string for a field to be used in table creation or alteration.
Set database-engine specific properties for a field.
No description
Create the SQL expression for primary keys.
Helper function: check if a constraint (PK, FK, UK) exists.
No description
No description
Retrieve a table or column comment.
Calculates a base-64 encoded, PostgreSQL-safe sha-256 hash per PostgreSQL documentation: 4.1. Lexical Structure.
Determines whether the PostgreSQL extension is created.
Details
in
Schema at line 46
__construct($connection)
No description
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.
in
Schema at line 84
protected array
getPrefixInfo(string $table = 'default', bool $add_prefix = TRUE)
Get information about the table name and schema from the prefix.
prefixNonTable($table)
Create names for indexes, primary keys and constraints.
This prevents using } around non-table names like indexes and keys.
protected Condition
buildTableNameCondition($table_name, $operator = '=', $add_prefix = TRUE)
Build a condition to match a table name against a standard information_schema.
The information_schema is a SQL standard that provides information about the database server and the databases, schemas, tables, columns and users within it. This makes information_schema a useful tool to use across the drupal database drivers and is used by a few different functions. The function below describes the conditions to be meet when querying information_schema.tables for drupal tables or information associated with drupal tables. Even though this is the standard method, not all databases follow standards and so this method should be overwritten by a database driver if the database provider uses alternate methods. Because information_schema.tables is used in a few different functions, a database driver will only need to override this function to make all the others work. For example see core/includes/databases/mysql/schema.inc.
true
tableExists($table)
Check if a table exists.
array
findTables(string $table_expression)
Finds all tables that are like the specified base table name.
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.
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.
renameTable($table, $new_name)
Rename a table.
true
dropTable($table)
Drop a table.
addField($table, $field, $spec, $new_keys = [])
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.
protected 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.
protected array
introspectIndexSchema(string $table)
Finds the columns for the primary key, unique keys and indexes of a table.
changeField($table, $field, $field_new, $spec, $new_keys = [])
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:
createTable($name, $table)
Create a new table from a Drupal table definition.
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.
The
prepareComment($comment, $length = NULL)
Prepare a table or column comment for database query.
protected string|int|float
escapeDefaultValue(mixed $value)
Return an escaped version of its parameter to be used as a default value on a column.
protected
ensureNotNullPrimaryKey(array $primary_key, array $fields)
Ensures that all the primary key fields are correctly defined.
protected string
ensureIdentifiersLength(string $table_identifier_part, string $column_identifier_part, string $tag, string $separator = '__')
Make sure to limit identifiers according to PostgreSQL compiled in length.
PostgreSQL allows in standard configuration identifiers no longer than 63 chars for table/relation names, indexes, primary keys, and constraints. So we map all identifiers that are too long to drupal_base64hash_tag, where tag is one of:
- idx for indexes
- key for constraints
- pkey for primary keys
- seq for sequences
mixed|object
queryTableInformation(string $table)
Fetch the list of blobs and sequences used on a table.
We introspect the database to collect the information required by insert and update queries.
protected string
getTempNamespaceName()
Gets PostgreSQL's temporary namespace name.
protected
resetTableInformation($table)
Resets information about table blobs, sequences and serial fields.
array
queryFieldInformation(string $table, string $field, string $constraint_type = 'c')
Fetches the list of constraints used on a field.
We introspect the database to collect the information required by field alteration.
protected array
createTableSql(string $name, array $table)
Generate SQL to create a new table from a Drupal schema definition.
protected
createFieldSql($name, $spec)
Create an SQL string for a field to be used in table creation or alteration.
protected
processField($field)
Set database-engine specific properties for a field.
protected
_createKeySql($fields)
No description
protected
createPrimaryKeySql($fields)
Create the SQL expression for primary keys.
Postgresql does not support key length. It does support fillfactor, but that requires a separate database lookup for each column in the key. The key length defined in the schema is ignored.
bool
constraintExists(string $table, string $name)
Helper function: check if a constraint (PK, FK, UK) exists.
protected
_createIndexSql($table, $name, $fields)
No description
protected
_createKeys($table, $new_keys)
No description
getComment($table, $column = NULL)
Retrieve a table or column comment.
protected string
hashBase64($data)
Calculates a base-64 encoded, PostgreSQL-safe sha-256 hash per PostgreSQL documentation: 4.1. Lexical Structure.
bool
extensionExists(string $name)
| internal |
Determines whether the PostgreSQL extension is created.