TableMappingInterface

Provides a common interface for mapping field columns to SQL tables.

Warning: using methods provided here should be done only when writing code that is explicitly targeting a SQL-based entity storage. Typically this API is used by SQL storage classes, or other SQL-specific code like the Views integration code for the Entity SQL storage. Another example of legal usage of this API is when needing to write a query that \Drupal::entityQuery() does not support. Always retrieve entity identifiers and use them to load entities instead of accessing data stored in the database directly. Any other usage circumvents the entity system and is strongly discouraged, at least when writing contributed code.

Hierarchy

File

core/lib/Drupal/Core/Entity/Sql/TableMappingInterface.php, line 20

Namespace

Drupal\Core\Entity\Sql

Members

Name Modifiers Type Description
TableMappingInterface::DELTA constant A property that represents delta used in entity query conditions.
TableMappingInterface::getAllColumns public function Gets a list of all database columns for a given table.
TableMappingInterface::getColumnNames public function Gets a mapping of field columns to database columns for a given field.
TableMappingInterface::getExtraColumns public function Gets a list of extra database columns, which store denormalized data.
TableMappingInterface::getFieldColumnName public function Generates a column name for a field property.
TableMappingInterface::getFieldNames public function Gets a list of names for entity fields stored in the specified table.
TableMappingInterface::getFieldTableName public function Gets the table name for a given column.
TableMappingInterface::getReservedColumns public function Gets the list of columns that can not be used as field type columns.
TableMappingInterface::getTableNames public function Gets a list of table names for this mapping.
doc_Drupal
2016-10-29 09:46:04
Comments
Leave a Comment

Please login to continue.