ESQL: Clarify inheriting from Attributes#145898
Merged
alex-spies merged 4 commits intoelastic:mainfrom Apr 8, 2026
Merged
Conversation
elasticsearchmachine
added
v9.4.0
Team:Analytics
Collaborator
|
Pinging @elastic/es-analytical-engine (Team:Analytics) |
ivancea
reviewed
Apr 8, 2026
...k/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/core/expression/FieldAttribute.java
Show resolved
Hide resolved
idegtiarenko
reviewed
Apr 8, 2026
...k/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/core/expression/FieldAttribute.java
Show resolved
Hide resolved
Contributor
There are also |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR clarifies and tightens the intended inheritance model for ES|QL Attribute implementations, reducing the risk of unexpected subclassing in core expression types.
Changes:
- Mark
ReferenceAttribute,MetadataAttribute, andEmptyAttributeasfinalto prevent subclassing. - Update
FieldAttributeJavadoc to discourage new subclasses and suggest extendingEsFieldwhen appropriate.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/core/expression/ReferenceAttribute.java |
Declares ReferenceAttribute as final to prevent inheritance. |
x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/core/expression/MetadataAttribute.java |
Declares MetadataAttribute as final to prevent inheritance. |
x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/core/expression/FieldAttribute.java |
Adds Javadoc guidance to treat FieldAttribute as effectively final and prefer EsField extension. |
x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/core/expression/EmptyAttribute.java |
Declares EmptyAttribute as final to prevent inheritance. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Contributor
That one will be removed in #145902. |
Contributor
Author
Right! This is what triggered this PR. Already discussed with Sergey and Jonas, and opened #145903. |
alex-spies
requested review from
idegtiarenko and
ivancea
and removed request for
idegtiarenko
ivancea
approved these changes
Apr 8, 2026
szybia
added a commit
to szybia/elasticsearch
that referenced
this pull request
Apr 8, 2026
…cation * upstream/main: Reindex relocation: store source TaskResult at destination node (elastic#145488) Bump versions after 9.2.8 release [CI] DLMFrozenTransitionServiceTests testCheckForFrozenIndicesReturnsEarlyWhenCapacityExhausted failing [elastic#145778] (elastic#145906) Update branches.json for 9.2.8 release ESQL: Clarify inheriting from Attributes (elastic#145898) Bump versions after 9.3.3 release Update branches.json for 9.3.3 release
szybia
added a commit
to szybia/elasticsearch
that referenced
this pull request
Apr 8, 2026
* upstream/main: Mute org.elasticsearch.xpack.esql.expression.function.aggregate.FirstDocIdGroupingAggregatorFunctionTests testSimple elastic#145923 Reindex relocation: store source TaskResult at destination node (elastic#145488) Bump versions after 9.2.8 release [CI] DLMFrozenTransitionServiceTests testCheckForFrozenIndicesReturnsEarlyWhenCapacityExhausted failing [elastic#145778] (elastic#145906) Update branches.json for 9.2.8 release ESQL: Clarify inheriting from Attributes (elastic#145898) Bump versions after 9.3.3 release Update branches.json for 9.3.3 release Prune changelogs after 8.19.14 release Bump versions after 8.19.14 release Update branches.json for 8.19.14 release [ML] Call old inference API (elastic#145690) ESQL: Unmute CsvIT sumWithOverflowRow (elastic#145893) Index a document when testing runtime fields shadowing dimensions & metrics (elastic#145882) [TEST] Fix version check in testSequenceNumbersDisabled (elastic#145879) [ESQL] Per-file filter pushdown awareness (elastic#145755) Unmute testGetReindexFollowsRelocation (elastic#145841) Correctly ignore system indices when validating dot-prefixed indices (elastic#128868) [Transform] Remove tests for deleted code (elastic#145685) ESQL: Add generative tests for LIMIT BY (elastic#144238)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Inheriting from FieldAttribute is mildly terrifying as this class is used throughout ESQL and was essentially always assumed final (except for the UnssuportedAttribute subclass).
Let's update the javadoc to reflect that.