Package org.elasticsearch.xpack.esql.capabilities

Interface RewriteableAware

All Superinterfaces:

TranslationAware

All Known Implementing Classes:

FullTextFunction, Knn, Kql, Match, MatchOperator, MatchPhrase, QueryString, SingleFieldFullTextFunction

public interface RewriteableAware
extends TranslationAware

Defines objects that need to go through the rewrite phase.

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.xpack.esql.capabilities.TranslationAware

TranslationAware.FinishedTranslatable, TranslationAware.SingleValueTranslationAware, TranslationAware.Translatable

Method Summary

Modifier and Type	Method	Description
QueryBuilder	queryBuilder()
Expression	replaceQueryBuilder(QueryBuilder queryBuilder)	Replaces the current query builder with a rewritten iteration.
boolean	requiresQueryBuilderRewrite()

Methods inherited from interface org.elasticsearch.xpack.esql.capabilities.TranslationAware

asLuceneQuery, asQuery, translatable

Method Details

queryBuilder

QueryBuilder queryBuilder()

Returns:

The current active query builder.

replaceQueryBuilder

Expression replaceQueryBuilder(QueryBuilder queryBuilder)

Replaces the current query builder with a rewritten iteration. This happens multiple times through the rewrite phase until the final iteration of the query builder is stored.

Parameters:

queryBuilder - QueryBuilder

Returns:

Expression defining the active QueryBuilder

requiresQueryBuilderRewrite

boolean requiresQueryBuilderRewrite()

Returns:

true if the `QueryBuilder` needs to be rewritten, false otherwise. If no rewrite is required, this instance will be skipped during the rewrite phase in QueryBuilderResolver.resolveQueryBuilders(org.elasticsearch.xpack.esql.plan.logical.LogicalPlan, org.elasticsearch.xpack.esql.plugin.TransportActionServices, org.elasticsearch.action.ActionListener<org.elasticsearch.xpack.esql.plan.logical.LogicalPlan>).