function FieldStorageDefinitionInterface::getSchema
Same name in other branches
- 9 core/lib/Drupal/Core/Field/FieldStorageDefinitionInterface.php \Drupal\Core\Field\FieldStorageDefinitionInterface::getSchema()
- 10 core/lib/Drupal/Core/Field/FieldStorageDefinitionInterface.php \Drupal\Core\Field\FieldStorageDefinitionInterface::getSchema()
- 11.x core/lib/Drupal/Core/Field/FieldStorageDefinitionInterface.php \Drupal\Core\Field\FieldStorageDefinitionInterface::getSchema()
Returns the field schema.
Note that this method returns an empty array for computed fields which have no schema.
Return value
array[] The field schema, as an array of key/value pairs in the format returned by \Drupal\Core\Field\FieldItemInterface::schema():
- columns: An array of Schema API column specifications, keyed by column name. This specifies what comprises a single value for a given field. No assumptions should be made on how storage backends internally use the original column name to structure their storage.
- indexes: An array of Schema API index definitions. Some storage backends might not support indexes.
- unique keys: An array of Schema API unique key definitions. Some storage backends might not support unique keys.
- foreign keys: An array of Schema API foreign key definitions. Note, however, that depending on the storage backend specified for the field, the field data is not necessarily stored in SQL.
2 methods override FieldStorageDefinitionInterface::getSchema()
- BaseFieldDefinition::getSchema in core/
lib/ Drupal/ Core/ Field/ BaseFieldDefinition.php - Returns the field schema.
- FieldStorageConfig::getSchema in core/
modules/ field/ src/ Entity/ FieldStorageConfig.php - Returns the field schema.
File
-
core/
lib/ Drupal/ Core/ Field/ FieldStorageDefinitionInterface.php, line 262
Class
- FieldStorageDefinitionInterface
- Defines an interface for entity field storage definitions.
Namespace
Drupal\Core\FieldCode
public function getSchema();
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.