Drupal\Core\Entity\Query\Sql\Query | Drupal Core API Explorer

class Query extends QueryBase implements QueryInterface (View source)

The SQL storage entity query class.

Properties

protected string	$entityTypeId	The entity type this query runs against.	from QueryBase
protected EntityTypeInterface	$entityType	Information about the entity type.	from QueryBase
protected array	$sort	The list of sorts.	from QueryBase
protected bool	$count	TRUE if this is a count query, FALSE if it isn't.	from QueryBase
protected ConditionInterface	$condition	Conditions.	from QueryBase
protected array	$aggregate	The list of aggregate expressions.	from QueryBase
protected array	$groupBy	The list of columns to group on.	from QueryBase
protected ConditionAggregateInterface	$conditionAggregate	Aggregate Conditions	from QueryBase
protected array	$sortAggregate	The list of sorts over the aggregate results.	from QueryBase
protected array	$range	The query range.	from QueryBase
protected array	$alterMetaData	The query metadata for alter purposes.	from QueryBase
protected array	$alterTags	The query tags.	from QueryBase
protected bool	$accessCheck	Whether access check is requested or not. Defaults to TRUE.	from QueryBase
protected bool	$allRevisions	Flag indicating whether to query the current revision or all revisions.	from QueryBase
protected bool	$latestRevision	Flag indicating whether to query the latest revision.	from QueryBase
protected array	$pager	The query pager data.	from QueryBase
protected array	$namespaces	List of potential namespaces of the classes belonging to this query.	from QueryBase
protected SelectInterface	$sqlQuery	The build sql select query.
protected TablesInterface	$tables	The Tables object for this query.
protected array	$sqlFields	An array of fields keyed by the field alias.
protected array	$sqlGroupBy	An array of strings added as to the group by, keyed by the string to avoid duplicates.
protected Connection	$connection

Methods

__construct(EntityTypeInterface $entity_type, string $conjunction, Connection $connection, array $namespaces)

Constructs a query object.

string

getEntityTypeId()

Gets the ID of the entity type for this query.

from QueryBase

$this

condition($property, $value = NULL, $operator = NULL, $langcode = NULL)

Add a condition to the query or a condition group.

from QueryBase

$this

exists($property, $langcode = NULL)

Queries for a non-empty value on a field.

from QueryBase

$this

notExists($property, $langcode = NULL)

Queries for an empty field.

from QueryBase

$this

range(null $start = NULL, null $length = NULL)

No description

from QueryBase

ConditionInterface

conditionGroupFactory(string $conjunction = 'AND')

Creates an object holding a group of conditions.

from QueryBase

ConditionInterface

andConditionGroup()

Creates a new group of conditions ANDed together.

from QueryBase

ConditionInterface

orConditionGroup()

Creates a new group of conditions ORed together.

from QueryBase

$this

sort($field, string $direction = 'ASC', $langcode = NULL)

No description

from QueryBase

$this

count()

Makes this a count query.

from QueryBase

$this

accessCheck($access_check = TRUE)

No description

from QueryBase

$this

currentRevision()

Queries the current revision.

from QueryBase

$this

latestRevision()

Queries the latest revision.

from QueryBase

$this

allRevisions()

Queries all the revisions.

from QueryBase

$this

pager($limit = 10, $element = NULL)

Enables a pager for the query.

from QueryBase

initializePager()

Gets the total number of results and initialize a pager for the query.

from QueryBase

$this

tableSort($headers)

Enables sortable tables for this query.

from QueryBase

__clone()

Implements the magic __clone method.

$this

addTag($tag)

Adds a tag to a query.

from QueryBase

true

hasTag($tag)

Determines if a given query has a given tag.

from QueryBase

true

hasAllTags()

Determines if a given query has all specified tags.

from QueryBase

true

hasAnyTag()

Determines if a given query has any specified tag.

from QueryBase

$this

addMetaData($key, $object)

Adds additional metadata to the query.

from QueryBase

The

getMetaData($key)

Retrieves a given piece of metadata.

from QueryBase

aggregate($field, $function, $langcode = NULL, $alias = NULL)

{@inheritdoc}

from QueryBase

conditionAggregate($field, $function = NULL, $value = NULL, $operator = '=', $langcode = NULL)

{@inheritdoc}

from QueryBase

sortAggregate($field, $function, $direction = 'ASC', $langcode = NULL)

{@inheritdoc}

from QueryBase

groupBy($field, $langcode = NULL)

{@inheritdoc}

from QueryBase

string

getAggregationAlias(string $field, string $function)

Generates an alias for a field and its aggregated function.

from QueryBase

static array

getNamespaces($object)

Gets a list of namespaces of the ancestors of a class.

from QueryBase

static string

getClass(array $namespaces, string $short_class_name)

Finds a class in a list of namespaces.

from QueryBase

int|array

execute()

Execute the query.

$this

prepare()

Prepares the basic query with proper metadata/tags and base fields.

$this

compile()

Compiles the conditions.

$this

addSort()

Adds the sort to the build query.

$this

finish()

Finish the query by adding fields, GROUP BY and range.

int|array

result()

Executes the query and returns the result.

string

getSqlField(string $field, string $langcode)

Constructs a select expression for a given field and language.

bool

isSimpleQuery()

Determines whether the query requires GROUP BY and ORDER BY MIN/MAX.

TablesInterface

getTables(SelectInterface $sql_query)

Gets the Tables object for this query.

__toString()

Implements the magic __toString method.

Details

at line 69
`__construct(EntityTypeInterface $entity_type, string $conjunction, Connection $connection, array $namespaces)`

Constructs a query object.

Parameters

EntityTypeInterface	$entity_type	The entity type definition.
string	$conjunction	AND: all of the conditions on the query need to match. OR: at least one of the conditions on the query need to match.
Connection	$connection	The database connection to run the query against.
array	$namespaces	List of potential namespaces of the classes belonging to this query.

in QueryBase at line 160
`string getEntityTypeId()`

Gets the ID of the entity type for this query.

Return Value

string

in QueryBase at line 167
`$this condition($property, $value = NULL, $operator = NULL, $langcode = NULL)`

Add a condition to the query or a condition group.

For example, to find all entities containing both the Turkish 'merhaba' and the Polish 'siema' within a 'greetings' text field:

Parameters

	$property
	$value	The value for $field. In most cases, this is a scalar and it's treated as case-insensitive. For more complex operators, it is an array. The meaning of each element in the array is dependent on $operator.
	$operator	Possible values: '=', '<>', '>', '>=', '<', '<=', 'STARTS_WITH', 'CONTAINS', 'ENDS_WITH': These operators expect $value to be a literal of the same type as the column. 'IN', 'NOT IN': These operators expect $value to be an array of literals of the same type as the column. 'BETWEEN': This operator expects $value to be an array of two literals of the same type as the column.
	$langcode	Language code (optional). If omitted, any translation satisfies the condition. However, if two or more conditions omit the langcode within one condition group then they are presumed to apply to the same translation. If within one condition group one condition has a langcode and another does not they are not presumed to apply to the same translation.

Return Value

$this

in QueryBase at line 175
`$this exists($property, $langcode = NULL)`

Queries for a non-empty value on a field.

Parameters

	$property
	$langcode	Language code (optional).

Return Value

$this

in QueryBase at line 183
`$this notExists($property, $langcode = NULL)`

Queries for an empty field.

Parameters

	$property
	$langcode	Language code (optional).

Return Value

$this

in QueryBase at line 191
`$this range(null $start = NULL, null $length = NULL)`

No description

Parameters

null	$start
null	$length

Return Value

$this

The called object.

in QueryBase at line 211
`protected ConditionInterface conditionGroupFactory(string $conjunction = 'AND')`

Creates an object holding a group of conditions.

See andConditionGroup() and orConditionGroup() for more.

Parameters

string

$conjunction

AND (default): this is the equivalent of andConditionGroup().
OR: this is the equivalent of orConditionGroup().

Return Value

ConditionInterface

An object holding a group of conditions.

in QueryBase at line 219
`ConditionInterface andConditionGroup()`

Creates a new group of conditions ANDed together.

For example, consider a drawing entity type with a 'figures' multi-value field containing 'shape' and 'color' columns. To find all drawings containing both a red triangle and a blue circle:

Return Value

ConditionInterface

in QueryBase at line 226
`ConditionInterface orConditionGroup()`

Creates a new group of conditions ORed together.

For example, consider a map entity with an 'attributes' field containing 'building_type' and 'color' columns. To find all green and red bikesheds:

Return Value

ConditionInterface

in QueryBase at line 233
`$this sort($field, string $direction = 'ASC', $langcode = NULL)`

No description

Parameters

	$field	Name of a field.
string	$direction
	$langcode	Language code (optional).

Return Value

$this

The called object.

in QueryBase at line 245
`$this count()`

Makes this a count query.

For count queries, execute() returns the number entities found.

Return Value

$this

The called object.

in QueryBase at line 253
`$this accessCheck($access_check = TRUE)`

No description

Parameters

$access_check

Return Value

$this

The called object.

in QueryBase at line 261
`$this currentRevision()`

Queries the current revision.

Return Value

$this

in QueryBase at line 270
`$this latestRevision()`

Queries the latest revision.

The latest revision is the most recent revision of an entity. This will be either the default revision, or a pending revision if one exists and it is newer than the default.

Return Value

$this

in QueryBase at line 279
`$this allRevisions()`

Queries all the revisions.

Return Value

$this

in QueryBase at line 288
`$this pager($limit = 10, $element = NULL)`

Enables a pager for the query.

Parameters

	$limit	An integer specifying the number of elements per page. If passed a false value (FALSE, 0, NULL), the pager is disabled.
	$element	An optional integer to distinguish between multiple pagers on one page. If not provided, one is automatically calculated.

Return Value

$this

The called object.

in QueryBase at line 311
`protected initializePager()`

Gets the total number of results and initialize a pager for the query.

The pager can be disabled by either setting the pager limit to 0, or by setting this query to be a count query.

in QueryBase at line 325
`$this tableSort($headers)`

Enables sortable tables for this query.

Parameters

$headers

An array of headers of the same structure as described in template_preprocess_table(). Use a 'specifier' in place of a 'field' to specify what to sort on. This can be an entity or a field as described in condition().

Return Value

$this

The called object.

at line 309
`__clone()`

Implements the magic __clone method.

Reset fields and GROUP BY when cloning.

in QueryBase at line 354
`$this addTag($tag)`

Adds a tag to a query.

Tags are strings that identify a query. A query may have any number of tags. Tags are used to mark a query so that alter hooks may decide if they wish to take action. Tags should be all lower-case and contain only letters, numbers, and underscore, and start with a letter. That is, they should follow the same rules as PHP identifiers in general.

Parameters

$tag

The tag to add.

Return Value

$this

The called object.

in QueryBase at line 362
`true hasTag($tag)`

Determines if a given query has a given tag.

Parameters

$tag

The tag to check.

Return Value

true	if this query has been marked with this tag, FALSE otherwise.

in QueryBase at line 369
`true hasAllTags()`

Determines if a given query has all specified tags.

Each tag to check should be supplied as a separate argument.

Return Value

true	if this query has been marked with all specified tags, FALSE otherwise.

in QueryBase at line 376
`true hasAnyTag()`

Determines if a given query has any specified tag.

Each tag to check should be supplied as a separate argument.

Return Value

true	if this query has been marked with at least one of the specified tags, FALSE otherwise.

in QueryBase at line 383
`$this addMetaData($key, $object)`

Adds additional metadata to the query.

Often, a query may need to provide additional contextual data to alter hooks. Alter hooks may then use that information to decide if and how to take action.

Parameters

	$key	The unique identifier for this piece of metadata. Must be a string that follows the same rules as any other PHP identifier.
	$object	The additional data to add to the query. May be any valid PHP variable.

Return Value

$this

The called object.

in QueryBase at line 391
`The getMetaData($key)`

Retrieves a given piece of metadata.

Parameters

$key

The unique identifier for the piece of metadata to retrieve.

Return Value

The	previously attached metadata object, or NULL if one doesn't exist.

in QueryBase at line 398
`aggregate($field, $function, $langcode = NULL, $alias = NULL)`

{@inheritdoc}

Parameters

	$field
	$function
	$langcode
	$alias

in QueryBase at line 416
`conditionAggregate($field, $function = NULL, $value = NULL, $operator = '=', $langcode = NULL)`

{@inheritdoc}

Parameters

	$field
	$function
	$value
	$operator
	$langcode

in QueryBase at line 426
`sortAggregate($field, $function, $direction = 'ASC', $langcode = NULL)`

{@inheritdoc}

Parameters

	$field
	$function
	$direction
	$langcode

in QueryBase at line 443
`groupBy($field, $langcode = NULL)`

{@inheritdoc}

Parameters

	$field
	$langcode

in QueryBase at line 463
`protected string getAggregationAlias(string $field, string $function)`

Generates an alias for a field and its aggregated function.

Parameters

string	$field	The field name used in the alias.
string	$function	The aggregation function used in the alias.

Return Value

string

The alias for the field.

in QueryBase at line 477
`static array getNamespaces($object)`

Gets a list of namespaces of the ancestors of a class.

Parameters

$object

An object within a namespace.

Return Value

array

A list containing the namespace of the class, the namespace of the parent of the class and so on and so on.

in QueryBase at line 496
`static string getClass(array $namespaces, string $short_class_name)`

Finds a class in a list of namespaces.

Parameters

array	$namespaces	A list of namespaces.
string	$short_class_name	A class name without namespace.

Return Value

string

The fully qualified name of the class.

at line 77
`int|array execute()`

Execute the query.

Return Value

int|array

Returns an integer for count queries or an array of ids. The values of the array are always entity ids. The keys will be revision ids if the entity supports revision and entity ids if not.

at line 95
`protected $this prepare()`

Prepares the basic query with proper metadata/tags and base fields.

Return Value

$this

Returns the called object.

Exceptions

QueryException

at line 171
`protected $this compile()`

Compiles the conditions.

Return Value

$this

Returns the called object.

at line 182
`protected $this addSort()`

Adds the sort to the build query.

Return Value

$this

Returns the called object.

at line 240
`protected $this finish()`

Finish the query by adding fields, GROUP BY and range.

Return Value

$this

Returns the called object.

at line 260
`protected int|array result()`

Executes the query and returns the result.

Return Value

int|array

Returns the query result as entity IDs.

at line 282
`protected string getSqlField(string $field, string $langcode)`

Constructs a select expression for a given field and language.

Parameters

string	$field	The name of the field being queried.
string	$langcode	The language code of the field.

Return Value

string

An expression that will select the given field for the given language in a SELECT query, such as 'base_table.id'.

at line 300
`protected bool isSimpleQuery()`

Determines whether the query requires GROUP BY and ORDER BY MIN/MAX.

Return Value

bool

at line 324
`TablesInterface getTables(SelectInterface $sql_query)`

Gets the Tables object for this query.

Parameters

SelectInterface

$sql_query

The SQL query object being built.

Return Value

TablesInterface

The object that adds tables and fields to the SQL query object.

at line 332
`__toString()`

Implements the magic __toString method.

Query

Properties

Methods

Details

at line 69 __construct(EntityTypeInterface $entity_type, string $conjunction, Connection $connection, array $namespaces)

Parameters

in QueryBase at line 160 string getEntityTypeId()

Return Value

in QueryBase at line 167 $this condition($property, $value = NULL, $operator = NULL, $langcode = NULL)

Parameters

Return Value

in QueryBase at line 175 $this exists($property, $langcode = NULL)

Parameters

Return Value

in QueryBase at line 183 $this notExists($property, $langcode = NULL)

Parameters

Return Value

in QueryBase at line 191 $this range(null $start = NULL, null $length = NULL)

Parameters

Return Value

in QueryBase at line 211 protected ConditionInterface conditionGroupFactory(string $conjunction = 'AND')

Parameters

Return Value

in QueryBase at line 219 ConditionInterface andConditionGroup()

Return Value

in QueryBase at line 226 ConditionInterface orConditionGroup()

Return Value

in QueryBase at line 233 $this sort($field, string $direction = 'ASC', $langcode = NULL)

Parameters

Return Value

in QueryBase at line 245 $this count()

Return Value

in QueryBase at line 253 $this accessCheck($access_check = TRUE)

Parameters

Return Value

in QueryBase at line 261 $this currentRevision()

Return Value

in QueryBase at line 270 $this latestRevision()

Return Value

in QueryBase at line 279 $this allRevisions()

Return Value

in QueryBase at line 288 $this pager($limit = 10, $element = NULL)

Parameters

Return Value

in QueryBase at line 311 protected initializePager()

in QueryBase at line 325 $this tableSort($headers)

Parameters

Return Value

at line 309 __clone()

in QueryBase at line 354 $this addTag($tag)

Parameters

Return Value

in QueryBase at line 362 true hasTag($tag)

Parameters

Return Value

in QueryBase at line 369 true hasAllTags()

Return Value

in QueryBase at line 376 true hasAnyTag()

Return Value

in QueryBase at line 383 $this addMetaData($key, $object)

Parameters

Return Value

in QueryBase at line 391 The getMetaData($key)

Parameters

Return Value

in QueryBase at line 398 aggregate($field, $function, $langcode = NULL, $alias = NULL)

Parameters

in QueryBase at line 416 conditionAggregate($field, $function = NULL, $value = NULL, $operator = '=', $langcode = NULL)

Parameters

in QueryBase at line 426 sortAggregate($field, $function, $direction = 'ASC', $langcode = NULL)

Parameters

in QueryBase at line 443 groupBy($field, $langcode = NULL)

Parameters

in QueryBase at line 463 protected string getAggregationAlias(string $field, string $function)

Parameters

Return Value

in QueryBase at line 477 static array getNamespaces($object)

Parameters

Return Value

in QueryBase at line 496 static string getClass(array $namespaces, string $short_class_name)

at line 69
`__construct(EntityTypeInterface $entity_type, string $conjunction, Connection $connection, array $namespaces)`

in QueryBase at line 160
`string getEntityTypeId()`

in QueryBase at line 167
`$this condition($property, $value = NULL, $operator = NULL, $langcode = NULL)`

in QueryBase at line 175
`$this exists($property, $langcode = NULL)`

in QueryBase at line 183
`$this notExists($property, $langcode = NULL)`

in QueryBase at line 191
`$this range(null $start = NULL, null $length = NULL)`

in QueryBase at line 211
`protected ConditionInterface conditionGroupFactory(string $conjunction = 'AND')`

in QueryBase at line 219
`ConditionInterface andConditionGroup()`

in QueryBase at line 226
`ConditionInterface orConditionGroup()`

in QueryBase at line 233
`$this sort($field, string $direction = 'ASC', $langcode = NULL)`

in QueryBase at line 245
`$this count()`

in QueryBase at line 253
`$this accessCheck($access_check = TRUE)`

in QueryBase at line 261
`$this currentRevision()`

in QueryBase at line 270
`$this latestRevision()`

in QueryBase at line 279
`$this allRevisions()`

in QueryBase at line 288
`$this pager($limit = 10, $element = NULL)`

in QueryBase at line 311
`protected initializePager()`

in QueryBase at line 325
`$this tableSort($headers)`

at line 309
`__clone()`

in QueryBase at line 354
`$this addTag($tag)`

in QueryBase at line 362
`true hasTag($tag)`

in QueryBase at line 369
`true hasAllTags()`

in QueryBase at line 376
`true hasAnyTag()`

in QueryBase at line 383
`$this addMetaData($key, $object)`

in QueryBase at line 391
`The getMetaData($key)`

in QueryBase at line 398
`aggregate($field, $function, $langcode = NULL, $alias = NULL)`

in QueryBase at line 416
`conditionAggregate($field, $function = NULL, $value = NULL, $operator = '=', $langcode = NULL)`

in QueryBase at line 426
`sortAggregate($field, $function, $direction = 'ASC', $langcode = NULL)`

in QueryBase at line 443
`groupBy($field, $langcode = NULL)`

in QueryBase at line 463
`protected string getAggregationAlias(string $field, string $function)`

in QueryBase at line 477
`static array getNamespaces($object)`

in QueryBase at line 496
`static string getClass(array $namespaces, string $short_class_name)`

at line 77
`int|array execute()`

at line 95
`protected $this prepare()`

at line 171
`protected $this compile()`

at line 182
`protected $this addSort()`

at line 240
`protected $this finish()`

at line 260
`protected int|array result()`

at line 282
`protected string getSqlField(string $field, string $langcode)`

at line 300
`protected bool isSimpleQuery()`

at line 324
`TablesInterface getTables(SelectInterface $sql_query)`

at line 332
`__toString()`