Entity Field Query throws QueryException when querying all revisions and setting condition on entity reference field where target doesn't support revisions

Created on 13 January 2016, over 9 years ago

Updated 30 January 2023, about 2 years ago

Problem/Motivation

When using Entity Field Query to query a revisionable entity and calling:
$query->allRevisions()
If you set a condition on an entity reference where the target entity type DOES NOT support revisions then the you get a fatal error form \Drupal\Core\Entity\Query\Sql\Tables::ensureEntityTable because \Drupal\Core\Entity\Query\Sql\Tables::addField will attempt to use the revision tables of the target entity even though they do not exist.

The simplest way to demonstrate this is to write a Entity Query to find all the node revisions that have a term in field_tags where the name equals a value.

$query = $this->entityTypeManager()->getStorage('node')->getQuery('AND');
    $query->condition('field_tags.entity.name', $search_str);
    $query->allRevisions();
    $ids = $query->execute();

This code throws the error.

Here is github demo repo that provides a module that demonstrates this problem.

Proposed resolution

Instead of directly using the "allRevision" metadata from the query use an $use_revisions variable which will be update if \Drupal\Core\Entity\Query\Sql\Tables::addField
determines the field is using a "valid relationship" through an entity reference field.

Remaining tasks

Complete patch
Write Tests

User interface changes

None

API changes

None

Data model changes

None

🐛 Bug report

Status

Needs work

Version

10.1 ✨

Component

Entity →

Last updated 1 day ago

Maintained by
🇬🇧United Kingdom @catch
🇨🇭Switzerland @berdir
🇩🇪Germany @hchonov

Created by

🇺🇸United States tedbow Ithaca, NY, USA

Live updates comments and jobs are added and updated live.

Entity query

Incomplete comments

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

Comment about 2 years ago →
needs-review-queue-bot
The Needs Review Queue Bot → tested this issue. It either no longer applies to Drupal core, or fails the Drupal core commit checks. Therefore, this issue status is now "Needs work".

Apart from a re-roll or rebase, this issue may need more work to address feedback in the issue or MR comments. To progress an issue, incorporate this feedback as part of the process of updating the issue. This helps other contributors to know what is outstanding.

Consult the Drupal Contributor Guide → to find step-by-step guides for working with issues.
Open in Jenkins → Open on Drupal.org →
Environment: PHP 8.0 & MySQL 5.7
last update almost 2 years ago
Patch Failed to Apply

contrib.social Blog FAQ Discussions

Production build 0.71.5 2024