Package org.elasticsearch.xpack.esql.expression.function.fulltext

Class Kql

java.lang.Object

org.elasticsearch.xpack.esql.core.tree.Node<Expression>

org.elasticsearch.xpack.esql.core.expression.Expression

org.elasticsearch.xpack.esql.core.expression.function.Function

org.elasticsearch.xpack.esql.expression.function.fulltext.FullTextFunction

org.elasticsearch.xpack.esql.expression.function.fulltext.Kql

All Implemented Interfaces:

NamedWriteable, Writeable, PostAnalysisPlanVerificationAware, PostOptimizationPlanVerificationAware, PostOptimizationVerificationAware, RewriteableAware, TranslationAware, Resolvable, EvaluatorMapper, ConfigurationFunction, OptionalArgument, ExpressionScoreMapper

public class Kql
extends FullTextFunction
implements OptionalArgument, ConfigurationFunction

Full text function that performs a KqlQuery .

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.xpack.esql.core.expression.Expression

Expression.TypeResolution

Nested classes/interfaces inherited from interface org.elasticsearch.xpack.esql.evaluator.mapper.EvaluatorMapper

EvaluatorMapper.ToEvaluator

Nested classes/interfaces inherited from interface org.elasticsearch.xpack.esql.score.ExpressionScoreMapper

ExpressionScoreMapper.ToScorer

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

PostOptimizationVerificationAware.CoordinatorOnly

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

TranslationAware.FinishedTranslatable, TranslationAware.SingleValueTranslationAware, TranslationAware.Translatable

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final Map<String,DataType>	ALLOWED_OPTIONS
static final NamedWriteableRegistry.Entry	ENTRY

Fields inherited from class org.elasticsearch.xpack.esql.core.tree.Node

TO_STRING_MAX_WIDTH

Constructor Summary

Constructors

Constructor	Description
Kql(Source source, Expression queryString, Expression options, QueryBuilder queryBuilder, Configuration configuration)
Kql(Source source, Expression queryString, Expression options, Configuration configuration)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getWriteableName()
int	hashCode()
protected NodeInfo<? extends Expression>	info()
Expression	options()
Expression	replaceChildren(List<Expression> newChildren)
Expression	replaceQueryBuilder(QueryBuilder queryBuilder)	Replaces the current query builder with a rewritten iteration.
protected Expression.TypeResolution	resolveParams()	Resolves the type for the function parameters, as part of the type resolution for the function
String	toString()
protected Query	translate(LucenePushdownPredicates pushdownPredicates, TranslatorHandler handler)
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.xpack.esql.expression.function.fulltext.FullTextFunction

asQuery, dataType, evaluatorQueryBuilder, fieldAsFieldAttribute, fieldVerifier, functionType, getNameFromFieldAttribute, nullable, postAnalysisPlanVerification, postOptimizationPlanVerification, postOptimizationVerification, query, queryBuilder, resolveQuery, resolveType, toEvaluator, toScorer, translatable

Methods inherited from class org.elasticsearch.xpack.esql.core.expression.function.Function

arguments, functionName, nodeString

Methods inherited from class org.elasticsearch.xpack.esql.core.expression.Expression

canonical, canonicalize, childrenResolved, fold, foldable, propertiesToString, references, resolved, semanticEquals, semanticHash, typeResolved

Methods inherited from class org.elasticsearch.xpack.esql.core.tree.Node

anyMatch, children, collect, collect, collect, collectFirstChildren, collectLeaves, doCollectFirst, forEachDown, forEachDown, forEachDownMayReturnEarly, forEachProperty, forEachPropertyDown, forEachPropertyOnly, forEachPropertyUp, forEachUp, forEachUp, nodeName, nodeProperties, replaceChildrenSameSize, source, sourceLocation, sourceText, transformChildren, transformDown, transformDown, transformDown, transformNodeProps, transformPropertiesDown, transformPropertiesOnly, transformPropertiesUp, transformUp, transformUp, transformUp

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.xpack.esql.evaluator.mapper.EvaluatorMapper

fold

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

asLuceneQuery

Field Details

ENTRY

public static final NamedWriteableRegistry.Entry ENTRY

ALLOWED_OPTIONS

public static final Map<String,DataType> ALLOWED_OPTIONS

Constructor Details

Kql

public Kql(Source source,
 Expression queryString,
 Expression options,
 Configuration configuration)

Kql

public Kql(Source source,
 Expression queryString,
 Expression options,
 QueryBuilder queryBuilder,
 Configuration configuration)

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

getWriteableName

public String getWriteableName()

Specified by:

getWriteableName in interface NamedWriteable

options

public Expression options()

resolveParams

protected Expression.TypeResolution resolveParams()

Description copied from class: FullTextFunction

Resolves the type for the function parameters, as part of the type resolution for the function

Overrides:

resolveParams in class FullTextFunction

Returns:

type resolution for the function parameters

replaceChildren

public Expression replaceChildren(List<Expression> newChildren)

Specified by:

replaceChildren in class Node<Expression>

info

protected NodeInfo<? extends Expression> info()

Specified by:

info in class Node<Expression>

translate

protected Query translate(LucenePushdownPredicates pushdownPredicates,
 TranslatorHandler handler)

Specified by:

translate in class FullTextFunction

replaceQueryBuilder

public Expression replaceQueryBuilder(QueryBuilder queryBuilder)

Description copied from interface: RewriteableAware

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.

Specified by:

replaceQueryBuilder in interface RewriteableAware

Parameters:

queryBuilder - QueryBuilder

Returns:

Expression defining the active QueryBuilder

equals

public boolean equals(Object o)

Overrides:

equals in class FullTextFunction

hashCode

public int hashCode()

Overrides:

hashCode in class FullTextFunction

toString

public String toString()

Overrides:

toString in class Expression