Package org.elasticsearch.xpack.esql.parser

Class LogicalPlanBuilder

java.lang.Object

org.antlr.v4.runtime.tree.AbstractParseTreeVisitor<Object>

org.elasticsearch.xpack.esql.parser.EsqlBaseParserBaseVisitor<Object>

org.elasticsearch.xpack.esql.parser.ExpressionBuilder

org.elasticsearch.xpack.esql.parser.LogicalPlanBuilder

All Implemented Interfaces:

org.antlr.v4.runtime.tree.ParseTreeVisitor<Object>, EsqlBaseParserVisitor<Object>

Direct Known Subclasses:

AstBuilder

public class LogicalPlanBuilder
extends ExpressionBuilder

Translates what we get back from Antlr into the data structures the rest of the planner steps will act on. Generally speaking, things which change the grammar will need to make changes here as well.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	LogicalPlanBuilder.PromqlParams	Container for PromQL command parameters: time for instant queries start, end, step for range queries These can be specified in the PROMQL command like so:

Nested classes/interfaces inherited from class org.elasticsearch.xpack.esql.parser.ExpressionBuilder

ExpressionBuilder.ParsingContext

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MAX_QUERY_DEPTH	Maximum number of commands allowed per query

Fields inherited from class org.elasticsearch.xpack.esql.parser.ExpressionBuilder

context, MAX_EXPRESSION_DEPTH

Constructor Summary

Constructors

Constructor	Description
LogicalPlanBuilder(ExpressionBuilder.ParsingContext context)

Method Summary

Modifier and Type	Method	Description
protected LogicalPlan	plan(org.antlr.v4.runtime.tree.ParseTree ctx)
protected List<LogicalPlan>	plans(List<? extends org.antlr.v4.runtime.ParserRuleContext> ctxs)
protected static String	quoteIdString(String unquotedString)
protected EsqlStatement	statement(org.antlr.v4.runtime.tree.ParseTree ctx)
protected static String	unquoteIdentifier(org.antlr.v4.runtime.tree.TerminalNode quotedNode, org.antlr.v4.runtime.tree.TerminalNode unquotedNode)
protected static String	unquoteIdString(String quotedString)
protected static void	validateClusterString(String clusterString, EsqlBaseParser.IndexPatternContext ctx)
Object	visit(org.antlr.v4.runtime.tree.ParseTree tree)
PlanFactory	visitChangePointCommand(EsqlBaseParser.ChangePointCommandContext ctx)	Visit a parse tree produced by EsqlBaseParser.changePointCommand().
String	visitClusterString(EsqlBaseParser.ClusterStringContext ctx)	Visit a parse tree produced by EsqlBaseParser.clusterString().
PlanFactory	visitCompletionCommand(EsqlBaseParser.CompletionCommandContext ctx)	Visit a parse tree produced by EsqlBaseParser.completionCommand().
PlanFactory	visitCompositeForkSubQuery(EsqlBaseParser.CompositeForkSubQueryContext ctx)	Visit a parse tree produced by the compositeForkSubQuery labeled alternative in EsqlBaseParser.forkSubQueryCommand().
LogicalPlan	visitCompositeQuery(EsqlBaseParser.CompositeQueryContext ctx)	Visit a parse tree produced by the compositeQuery labeled alternative in EsqlBaseParser.query().
PlanFactory	visitDissectCommand(EsqlBaseParser.DissectCommandContext ctx)	Visit a parse tree produced by EsqlBaseParser.dissectCommand().
Map<String,Object>	visitDissectCommandOptions(EsqlBaseParser.DissectCommandOptionsContext ctx)	Visit a parse tree produced by EsqlBaseParser.dissectCommandOptions().
PlanFactory	visitDropCommand(EsqlBaseParser.DropCommandContext ctx)	Visit a parse tree produced by EsqlBaseParser.dropCommand().
PlanFactory	visitEnrichCommand(EsqlBaseParser.EnrichCommandContext ctx)	Visit a parse tree produced by EsqlBaseParser.enrichCommand().
PlanFactory	visitEvalCommand(EsqlBaseParser.EvalCommandContext ctx)	Visit a parse tree produced by EsqlBaseParser.evalCommand().
Explain	visitExplainCommand(EsqlBaseParser.ExplainCommandContext ctx)	Visit a parse tree produced by EsqlBaseParser.explainCommand().
PlanFactory	visitForkCommand(EsqlBaseParser.ForkCommandContext ctx)	Visit a parse tree produced by EsqlBaseParser.forkCommand().
List<PlanFactory>	visitForkSubQueries(EsqlBaseParser.ForkSubQueriesContext ctx)	Visit a parse tree produced by EsqlBaseParser.forkSubQueries().
PlanFactory	visitForkSubQuery(EsqlBaseParser.ForkSubQueryContext ctx)	Visit a parse tree produced by EsqlBaseParser.forkSubQuery().
LogicalPlan	visitFromCommand(EsqlBaseParser.FromCommandContext ctx)	Visit a parse tree produced by EsqlBaseParser.fromCommand().
PlanFactory	visitFuseCommand(EsqlBaseParser.FuseCommandContext ctx)	Visit a parse tree produced by EsqlBaseParser.fuseCommand().
PlanFactory	visitGrokCommand(EsqlBaseParser.GrokCommandContext ctx)	Visit a parse tree produced by EsqlBaseParser.grokCommand().
String	visitIdentifier(EsqlBaseParser.IdentifierContext ctx)	Visit a parse tree produced by EsqlBaseParser.identifier().
String	visitIndexPattern(List<EsqlBaseParser.IndexPatternContext> ctx)
String	visitIndexString(EsqlBaseParser.IndexStringContext ctx)	Visit a parse tree produced by EsqlBaseParser.indexString().
PlanFactory	visitInlineStatsCommand(EsqlBaseParser.InlineStatsCommandContext ctx)	Visit a parse tree produced by EsqlBaseParser.inlineStatsCommand().
PlanFactory	visitInsistCommand(EsqlBaseParser.InsistCommandContext ctx)	Visit a parse tree produced by EsqlBaseParser.insistCommand().
PlanFactory	visitJoinCommand(EsqlBaseParser.JoinCommandContext ctx)	Visit a parse tree produced by EsqlBaseParser.joinCommand().
org.elasticsearch.xpack.esql.parser.LogicalPlanBuilder.JoinInfo	visitJoinCondition(EsqlBaseParser.JoinConditionContext ctx)	Visit a parse tree produced by EsqlBaseParser.joinCondition().
PlanFactory	visitKeepCommand(EsqlBaseParser.KeepCommandContext ctx)	Visit a parse tree produced by EsqlBaseParser.keepCommand().
PlanFactory	visitLimitCommand(EsqlBaseParser.LimitCommandContext ctx)	Visit a parse tree produced by EsqlBaseParser.limitCommand().
PlanFactory	visitLookupCommand(EsqlBaseParser.LookupCommandContext ctx)	Visit a parse tree produced by EsqlBaseParser.lookupCommand().
PlanFactory	visitMvExpandCommand(EsqlBaseParser.MvExpandCommandContext ctx)	Visit a parse tree produced by EsqlBaseParser.mvExpandCommand().
LogicalPlan	visitPromqlCommand(EsqlBaseParser.PromqlCommandContext ctx)	Visit a parse tree produced by EsqlBaseParser.promqlCommand().
PlanFactory	visitRenameCommand(EsqlBaseParser.RenameCommandContext ctx)	Visit a parse tree produced by EsqlBaseParser.renameCommand().
PlanFactory	visitRerankCommand(EsqlBaseParser.RerankCommandContext ctx)	Visit a parse tree produced by EsqlBaseParser.rerankCommand().
LogicalPlan	visitRowCommand(EsqlBaseParser.RowCommandContext ctx)	Visit a parse tree produced by EsqlBaseParser.rowCommand().
PlanFactory	visitSampleCommand(EsqlBaseParser.SampleCommandContext ctx)	Visit a parse tree produced by EsqlBaseParser.sampleCommand().
String	visitSelectorString(EsqlBaseParser.SelectorStringContext ctx)	Visit a parse tree produced by EsqlBaseParser.selectorString().
QuerySetting	visitSetCommand(EsqlBaseParser.SetCommandContext ctx)	Visit a parse tree produced by EsqlBaseParser.setCommand().
Alias	visitSetField(EsqlBaseParser.SetFieldContext ctx)	Visit a parse tree produced by EsqlBaseParser.setField().
LogicalPlan	visitShowInfo(EsqlBaseParser.ShowInfoContext ctx)	Visit a parse tree produced by the showInfo labeled alternative in EsqlBaseParser.showCommand().
LogicalPlan	visitSingleStatement(EsqlBaseParser.SingleStatementContext ctx)	Visit a parse tree produced by EsqlBaseParser.singleStatement().
PlanFactory	visitSortCommand(EsqlBaseParser.SortCommandContext ctx)	Visit a parse tree produced by EsqlBaseParser.sortCommand().
EsqlStatement	visitStatements(EsqlBaseParser.StatementsContext ctx)	Visit a parse tree produced by EsqlBaseParser.statements().
PlanFactory	visitStatsCommand(EsqlBaseParser.StatsCommandContext ctx)	Visit a parse tree produced by EsqlBaseParser.statsCommand().
LogicalPlan	visitSubquery(EsqlBaseParser.SubqueryContext ctx)	Visit a parse tree produced by EsqlBaseParser.subquery().
Source	visitTerminal(org.antlr.v4.runtime.tree.TerminalNode node)
LogicalPlan	visitTimeSeriesCommand(EsqlBaseParser.TimeSeriesCommandContext ctx)	Visit a parse tree produced by EsqlBaseParser.timeSeriesCommand().
PlanFactory	visitWhereCommand(EsqlBaseParser.WhereCommandContext ctx)	Visit a parse tree produced by EsqlBaseParser.whereCommand().

Methods inherited from class org.elasticsearch.xpack.esql.parser.ExpressionBuilder

expression, expressions, qualifiersUnsupportedInFieldDefinitions, qualifiersUnsupportedInPatterns, visitAggField, visitAggFields, visitArithmeticBinary, visitArithmeticUnary, visitBooleanArrayLiteral, visitBooleanValue, visitCommandNamedParameters, visitComparison, visitDecimalValue, visitDereference, visitEnrichWithClause, visitField, visitFieldName, visitFields, visitFunctionExpression, visitFunctionName, visitGrouping, visitIdentifierOrParameter, visitInlineCast, visitInputDoubleParams, visitInputNamedOrPositionalDoubleParams, visitInputNamedOrPositionalParam, visitInputParam, visitIntegerValue, visitIsNull, visitLikeExpression, visitLikeListExpression, visitLogicalBinary, visitLogicalIn, visitLogicalNot, visitMapExpression, visitMatchBooleanExpression, visitNullLiteral, visitNumericArrayLiteral, visitOperatorExpressionDefault, visitOrderExpression, visitParenthesizedExpression, visitQualifiedIntegerLiteral, visitQualifiedName, visitQualifiedName, visitQualifiedNamePattern, visitQualifiedNamePattern, visitQualifiedNamePatterns, visitQualifiedNamePatterns, visitRenameClause, visitRerankField, visitRerankFields, visitRlikeExpression, visitRlikeListExpression, visitString, visitStringArrayLiteral, visitStringLiteral, visitToDataType

Methods inherited from class org.elasticsearch.xpack.esql.parser.EsqlBaseParserBaseVisitor

visitBooleanDefault, visitBooleanLiteral, visitComparisonOperator, visitConstantDefault, visitDecimalLiteral, visitDissectCommandOption, visitEnrichPolicyName, visitEntryExpression, visitFieldNamePattern, visitForkSubQueryProcessingCommand, visitFunction, visitFuseConfiguration, visitIdentifierPattern, visitIndexPattern, visitIndexPatternAndMetadataFields, visitIndexPatternOrSubquery, visitInputParameter, visitIntegerLiteral, visitJoinTarget, visitMapValue, visitMatchExpression, visitMetadata, visitNumericValue, visitProcessingCommand, visitPromqlParam, visitPromqlParamContent, visitPromqlQueryPart, visitRegexExpression, visitSingleCommandQuery, visitSingleForkSubQueryCommand, visitSourceCommand, visitStringOrParameter, visitSubqueryExpression, visitUnquotedIndexString, visitValueExpressionDefault

Methods inherited from class org.antlr.v4.runtime.tree.AbstractParseTreeVisitor

aggregateResult, defaultResult, shouldVisitNextChild, visitChildren, visitErrorNode

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.antlr.v4.runtime.tree.ParseTreeVisitor

visitChildren, visitErrorNode

Field Details

MAX_QUERY_DEPTH

public static final int MAX_QUERY_DEPTH

Maximum number of commands allowed per query

See Also:

• Constant Field Values

Constructor Details

LogicalPlanBuilder

public LogicalPlanBuilder(ExpressionBuilder.ParsingContext context)

Method Details

statement

protected EsqlStatement statement(org.antlr.v4.runtime.tree.ParseTree ctx)

plan

protected LogicalPlan plan(org.antlr.v4.runtime.tree.ParseTree ctx)

visitStatements

public EsqlStatement visitStatements(EsqlBaseParser.StatementsContext ctx)

Description copied from class: EsqlBaseParserBaseVisitor

Visit a parse tree produced by EsqlBaseParser.statements().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.

Specified by:

visitStatements in interface EsqlBaseParserVisitor<Object>

Overrides:

visitStatements in class EsqlBaseParserBaseVisitor<Object>

Parameters:

ctx - the parse tree

Returns:

the visitor result

plans

protected List<LogicalPlan> plans(List<? extends org.antlr.v4.runtime.ParserRuleContext> ctxs)

visitSingleStatement

public LogicalPlan visitSingleStatement(EsqlBaseParser.SingleStatementContext ctx)

Description copied from class: EsqlBaseParserBaseVisitor

Visit a parse tree produced by EsqlBaseParser.singleStatement().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.

Specified by:

visitSingleStatement in interface EsqlBaseParserVisitor<Object>

Overrides:

visitSingleStatement in class EsqlBaseParserBaseVisitor<Object>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitSetCommand

public QuerySetting visitSetCommand(EsqlBaseParser.SetCommandContext ctx)

Description copied from class: EsqlBaseParserBaseVisitor

Visit a parse tree produced by EsqlBaseParser.setCommand().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.

Specified by:

visitSetCommand in interface EsqlBaseParserVisitor<Object>

Overrides:

visitSetCommand in class EsqlBaseParserBaseVisitor<Object>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitSetField

public Alias visitSetField(EsqlBaseParser.SetFieldContext ctx)

Description copied from class: EsqlBaseParserBaseVisitor

Visit a parse tree produced by EsqlBaseParser.setField().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.

Specified by:

visitSetField in interface EsqlBaseParserVisitor<Object>

Overrides:

visitSetField in class EsqlBaseParserBaseVisitor<Object>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitCompositeQuery

public LogicalPlan visitCompositeQuery(EsqlBaseParser.CompositeQueryContext ctx)

Description copied from class: EsqlBaseParserBaseVisitor

Visit a parse tree produced by the compositeQuery labeled alternative in EsqlBaseParser.query().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.

Specified by:

visitCompositeQuery in interface EsqlBaseParserVisitor<Object>

Overrides:

visitCompositeQuery in class EsqlBaseParserBaseVisitor<Object>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitEvalCommand

public PlanFactory visitEvalCommand(EsqlBaseParser.EvalCommandContext ctx)

Description copied from class: EsqlBaseParserBaseVisitor

Visit a parse tree produced by EsqlBaseParser.evalCommand().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.

Specified by:

visitEvalCommand in interface EsqlBaseParserVisitor<Object>

Overrides:

visitEvalCommand in class EsqlBaseParserBaseVisitor<Object>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitGrokCommand

public PlanFactory visitGrokCommand(EsqlBaseParser.GrokCommandContext ctx)

Description copied from class: EsqlBaseParserBaseVisitor

Visit a parse tree produced by EsqlBaseParser.grokCommand().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.

Specified by:

visitGrokCommand in interface EsqlBaseParserVisitor<Object>

Overrides:

visitGrokCommand in class EsqlBaseParserBaseVisitor<Object>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitDissectCommand

public PlanFactory visitDissectCommand(EsqlBaseParser.DissectCommandContext ctx)

Description copied from class: EsqlBaseParserBaseVisitor

Visit a parse tree produced by EsqlBaseParser.dissectCommand().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.

Specified by:

visitDissectCommand in interface EsqlBaseParserVisitor<Object>

Overrides:

visitDissectCommand in class EsqlBaseParserBaseVisitor<Object>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitMvExpandCommand

public PlanFactory visitMvExpandCommand(EsqlBaseParser.MvExpandCommandContext ctx)

Description copied from class: EsqlBaseParserBaseVisitor

Visit a parse tree produced by EsqlBaseParser.mvExpandCommand().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.

Specified by:

visitMvExpandCommand in interface EsqlBaseParserVisitor<Object>

Overrides:

visitMvExpandCommand in class EsqlBaseParserBaseVisitor<Object>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitDissectCommandOptions

public Map<String,Object> visitDissectCommandOptions(EsqlBaseParser.DissectCommandOptionsContext ctx)

Description copied from class: EsqlBaseParserBaseVisitor

Visit a parse tree produced by EsqlBaseParser.dissectCommandOptions().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.

Specified by:

visitDissectCommandOptions in interface EsqlBaseParserVisitor<Object>

Overrides:

visitDissectCommandOptions in class EsqlBaseParserBaseVisitor<Object>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitRowCommand

public LogicalPlan visitRowCommand(EsqlBaseParser.RowCommandContext ctx)

Description copied from class: EsqlBaseParserBaseVisitor

Visit a parse tree produced by EsqlBaseParser.rowCommand().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.

Specified by:

visitRowCommand in interface EsqlBaseParserVisitor<Object>

Overrides:

visitRowCommand in class EsqlBaseParserBaseVisitor<Object>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitSubquery

public LogicalPlan visitSubquery(EsqlBaseParser.SubqueryContext ctx)

Description copied from class: EsqlBaseParserBaseVisitor

Visit a parse tree produced by EsqlBaseParser.subquery().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.

Specified by:

visitSubquery in interface EsqlBaseParserVisitor<Object>

Overrides:

visitSubquery in class EsqlBaseParserBaseVisitor<Object>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitFromCommand

public LogicalPlan visitFromCommand(EsqlBaseParser.FromCommandContext ctx)

Description copied from class: EsqlBaseParserBaseVisitor

Visit a parse tree produced by EsqlBaseParser.fromCommand().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.

Specified by:

visitFromCommand in interface EsqlBaseParserVisitor<Object>

Overrides:

visitFromCommand in class EsqlBaseParserBaseVisitor<Object>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitInsistCommand

public PlanFactory visitInsistCommand(EsqlBaseParser.InsistCommandContext ctx)

Description copied from class: EsqlBaseParserBaseVisitor

Visit a parse tree produced by EsqlBaseParser.insistCommand().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.

Specified by:

visitInsistCommand in interface EsqlBaseParserVisitor<Object>

Overrides:

visitInsistCommand in class EsqlBaseParserBaseVisitor<Object>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitStatsCommand

public PlanFactory visitStatsCommand(EsqlBaseParser.StatsCommandContext ctx)

Description copied from class: EsqlBaseParserBaseVisitor

Visit a parse tree produced by EsqlBaseParser.statsCommand().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.

Specified by:

visitStatsCommand in interface EsqlBaseParserVisitor<Object>

Overrides:

visitStatsCommand in class EsqlBaseParserBaseVisitor<Object>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitInlineStatsCommand

public PlanFactory visitInlineStatsCommand(EsqlBaseParser.InlineStatsCommandContext ctx)

Description copied from class: EsqlBaseParserBaseVisitor

Visit a parse tree produced by EsqlBaseParser.inlineStatsCommand().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.

Specified by:

visitInlineStatsCommand in interface EsqlBaseParserVisitor<Object>

Overrides:

visitInlineStatsCommand in class EsqlBaseParserBaseVisitor<Object>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitWhereCommand

public PlanFactory visitWhereCommand(EsqlBaseParser.WhereCommandContext ctx)

Description copied from class: EsqlBaseParserBaseVisitor

Visit a parse tree produced by EsqlBaseParser.whereCommand().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.

Specified by:

visitWhereCommand in interface EsqlBaseParserVisitor<Object>

Overrides:

visitWhereCommand in class EsqlBaseParserBaseVisitor<Object>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitLimitCommand

public PlanFactory visitLimitCommand(EsqlBaseParser.LimitCommandContext ctx)

Description copied from class: EsqlBaseParserBaseVisitor

Visit a parse tree produced by EsqlBaseParser.limitCommand().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.

Specified by:

visitLimitCommand in interface EsqlBaseParserVisitor<Object>

Overrides:

visitLimitCommand in class EsqlBaseParserBaseVisitor<Object>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitSortCommand

public PlanFactory visitSortCommand(EsqlBaseParser.SortCommandContext ctx)

Description copied from class: EsqlBaseParserBaseVisitor

Visit a parse tree produced by EsqlBaseParser.sortCommand().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.

Specified by:

visitSortCommand in interface EsqlBaseParserVisitor<Object>

Overrides:

visitSortCommand in class EsqlBaseParserBaseVisitor<Object>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitExplainCommand

public Explain visitExplainCommand(EsqlBaseParser.ExplainCommandContext ctx)

Description copied from class: EsqlBaseParserBaseVisitor

Visit a parse tree produced by EsqlBaseParser.explainCommand().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.

Specified by:

visitExplainCommand in interface EsqlBaseParserVisitor<Object>

Overrides:

visitExplainCommand in class EsqlBaseParserBaseVisitor<Object>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitDropCommand

public PlanFactory visitDropCommand(EsqlBaseParser.DropCommandContext ctx)

Description copied from class: EsqlBaseParserBaseVisitor

Visit a parse tree produced by EsqlBaseParser.dropCommand().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.

Specified by:

visitDropCommand in interface EsqlBaseParserVisitor<Object>

Overrides:

visitDropCommand in class EsqlBaseParserBaseVisitor<Object>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitRenameCommand

public PlanFactory visitRenameCommand(EsqlBaseParser.RenameCommandContext ctx)

Description copied from class: EsqlBaseParserBaseVisitor

Visit a parse tree produced by EsqlBaseParser.renameCommand().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.

Specified by:

visitRenameCommand in interface EsqlBaseParserVisitor<Object>

Overrides:

visitRenameCommand in class EsqlBaseParserBaseVisitor<Object>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitKeepCommand

public PlanFactory visitKeepCommand(EsqlBaseParser.KeepCommandContext ctx)

Description copied from class: EsqlBaseParserBaseVisitor

Visit a parse tree produced by EsqlBaseParser.keepCommand().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.

Specified by:

visitKeepCommand in interface EsqlBaseParserVisitor<Object>

Overrides:

visitKeepCommand in class EsqlBaseParserBaseVisitor<Object>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitShowInfo

public LogicalPlan visitShowInfo(EsqlBaseParser.ShowInfoContext ctx)

Description copied from class: EsqlBaseParserBaseVisitor

Visit a parse tree produced by the showInfo labeled alternative in EsqlBaseParser.showCommand().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.

Specified by:

visitShowInfo in interface EsqlBaseParserVisitor<Object>

Overrides:

visitShowInfo in class EsqlBaseParserBaseVisitor<Object>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitEnrichCommand

public PlanFactory visitEnrichCommand(EsqlBaseParser.EnrichCommandContext ctx)

Description copied from class: EsqlBaseParserBaseVisitor

Visit a parse tree produced by EsqlBaseParser.enrichCommand().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.

Specified by:

visitEnrichCommand in interface EsqlBaseParserVisitor<Object>

Overrides:

visitEnrichCommand in class EsqlBaseParserBaseVisitor<Object>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitChangePointCommand

public PlanFactory visitChangePointCommand(EsqlBaseParser.ChangePointCommandContext ctx)

Description copied from class: EsqlBaseParserBaseVisitor

Visit a parse tree produced by EsqlBaseParser.changePointCommand().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.

Specified by:

visitChangePointCommand in interface EsqlBaseParserVisitor<Object>

Overrides:

visitChangePointCommand in class EsqlBaseParserBaseVisitor<Object>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitTimeSeriesCommand

public LogicalPlan visitTimeSeriesCommand(EsqlBaseParser.TimeSeriesCommandContext ctx)

Description copied from class: EsqlBaseParserBaseVisitor

Visit a parse tree produced by EsqlBaseParser.timeSeriesCommand().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.

Specified by:

visitTimeSeriesCommand in interface EsqlBaseParserVisitor<Object>

Overrides:

visitTimeSeriesCommand in class EsqlBaseParserBaseVisitor<Object>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitLookupCommand

public PlanFactory visitLookupCommand(EsqlBaseParser.LookupCommandContext ctx)

Description copied from class: EsqlBaseParserBaseVisitor

Visit a parse tree produced by EsqlBaseParser.lookupCommand().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.

Specified by:

visitLookupCommand in interface EsqlBaseParserVisitor<Object>

Overrides:

visitLookupCommand in class EsqlBaseParserBaseVisitor<Object>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitJoinCommand

public PlanFactory visitJoinCommand(EsqlBaseParser.JoinCommandContext ctx)

Description copied from class: EsqlBaseParserBaseVisitor

Visit a parse tree produced by EsqlBaseParser.joinCommand().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.

Specified by:

visitJoinCommand in interface EsqlBaseParserVisitor<Object>

Overrides:

visitJoinCommand in class EsqlBaseParserBaseVisitor<Object>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitJoinCondition

public org.elasticsearch.xpack.esql.parser.LogicalPlanBuilder.JoinInfo visitJoinCondition(EsqlBaseParser.JoinConditionContext ctx)

Description copied from class: EsqlBaseParserBaseVisitor

Visit a parse tree produced by EsqlBaseParser.joinCondition().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.

Specified by:

visitJoinCondition in interface EsqlBaseParserVisitor<Object>

Overrides:

visitJoinCondition in class EsqlBaseParserBaseVisitor<Object>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitForkCommand

public PlanFactory visitForkCommand(EsqlBaseParser.ForkCommandContext ctx)

Description copied from class: EsqlBaseParserBaseVisitor

Visit a parse tree produced by EsqlBaseParser.forkCommand().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.

Specified by:

visitForkCommand in interface EsqlBaseParserVisitor<Object>

Overrides:

visitForkCommand in class EsqlBaseParserBaseVisitor<Object>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitForkSubQueries

public List<PlanFactory> visitForkSubQueries(EsqlBaseParser.ForkSubQueriesContext ctx)

Description copied from class: EsqlBaseParserBaseVisitor

Visit a parse tree produced by EsqlBaseParser.forkSubQueries().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.

Specified by:

visitForkSubQueries in interface EsqlBaseParserVisitor<Object>

Overrides:

visitForkSubQueries in class EsqlBaseParserBaseVisitor<Object>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitForkSubQuery

public PlanFactory visitForkSubQuery(EsqlBaseParser.ForkSubQueryContext ctx)

Description copied from class: EsqlBaseParserBaseVisitor

Visit a parse tree produced by EsqlBaseParser.forkSubQuery().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.

Specified by:

visitForkSubQuery in interface EsqlBaseParserVisitor<Object>

Overrides:

visitForkSubQuery in class EsqlBaseParserBaseVisitor<Object>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitCompositeForkSubQuery

public PlanFactory visitCompositeForkSubQuery(EsqlBaseParser.CompositeForkSubQueryContext ctx)

Description copied from class: EsqlBaseParserBaseVisitor

Visit a parse tree produced by the compositeForkSubQuery labeled alternative in EsqlBaseParser.forkSubQueryCommand().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.

Specified by:

visitCompositeForkSubQuery in interface EsqlBaseParserVisitor<Object>

Overrides:

visitCompositeForkSubQuery in class EsqlBaseParserBaseVisitor<Object>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitFuseCommand

public PlanFactory visitFuseCommand(EsqlBaseParser.FuseCommandContext ctx)

Description copied from class: EsqlBaseParserBaseVisitor

Visit a parse tree produced by EsqlBaseParser.fuseCommand().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.

Specified by:

visitFuseCommand in interface EsqlBaseParserVisitor<Object>

Overrides:

visitFuseCommand in class EsqlBaseParserBaseVisitor<Object>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitRerankCommand

public PlanFactory visitRerankCommand(EsqlBaseParser.RerankCommandContext ctx)

Description copied from class: EsqlBaseParserBaseVisitor

Visit a parse tree produced by EsqlBaseParser.rerankCommand().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.

Specified by:

visitRerankCommand in interface EsqlBaseParserVisitor<Object>

Overrides:

visitRerankCommand in class EsqlBaseParserBaseVisitor<Object>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitCompletionCommand

public PlanFactory visitCompletionCommand(EsqlBaseParser.CompletionCommandContext ctx)

Description copied from class: EsqlBaseParserBaseVisitor

Visit a parse tree produced by EsqlBaseParser.completionCommand().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.

Specified by:

visitCompletionCommand in interface EsqlBaseParserVisitor<Object>

Overrides:

visitCompletionCommand in class EsqlBaseParserBaseVisitor<Object>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitSampleCommand

public PlanFactory visitSampleCommand(EsqlBaseParser.SampleCommandContext ctx)

Description copied from class: EsqlBaseParserBaseVisitor

Visit a parse tree produced by EsqlBaseParser.sampleCommand().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.

Specified by:

visitSampleCommand in interface EsqlBaseParserVisitor<Object>

Overrides:

visitSampleCommand in class EsqlBaseParserBaseVisitor<Object>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitPromqlCommand

public LogicalPlan visitPromqlCommand(EsqlBaseParser.PromqlCommandContext ctx)

Description copied from class: EsqlBaseParserBaseVisitor

Visit a parse tree produced by EsqlBaseParser.promqlCommand().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.

Specified by:

visitPromqlCommand in interface EsqlBaseParserVisitor<Object>

Overrides:

visitPromqlCommand in class EsqlBaseParserBaseVisitor<Object>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitIdentifier

public String visitIdentifier(EsqlBaseParser.IdentifierContext ctx)

Description copied from class: EsqlBaseParserBaseVisitor

Visit a parse tree produced by EsqlBaseParser.identifier().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.

Specified by:

visitIdentifier in interface EsqlBaseParserVisitor<Object>

Overrides:

visitIdentifier in class EsqlBaseParserBaseVisitor<Object>

Parameters:

ctx - the parse tree

Returns:

the visitor result

unquoteIdentifier

protected static String unquoteIdentifier(org.antlr.v4.runtime.tree.TerminalNode quotedNode,
 org.antlr.v4.runtime.tree.TerminalNode unquotedNode)

unquoteIdString

protected static String unquoteIdString(String quotedString)

quoteIdString

protected static String quoteIdString(String unquotedString)

visitClusterString

public String visitClusterString(EsqlBaseParser.ClusterStringContext ctx)

Description copied from class: EsqlBaseParserBaseVisitor

Visit a parse tree produced by EsqlBaseParser.clusterString().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.

Specified by:

visitClusterString in interface EsqlBaseParserVisitor<Object>

Overrides:

visitClusterString in class EsqlBaseParserBaseVisitor<Object>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitIndexString

public String visitIndexString(EsqlBaseParser.IndexStringContext ctx)

Description copied from class: EsqlBaseParserBaseVisitor

Visit a parse tree produced by EsqlBaseParser.indexString().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.

Specified by:

visitIndexString in interface EsqlBaseParserVisitor<Object>

Overrides:

visitIndexString in class EsqlBaseParserBaseVisitor<Object>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitSelectorString

public String visitSelectorString(EsqlBaseParser.SelectorStringContext ctx)

Description copied from class: EsqlBaseParserBaseVisitor

Visit a parse tree produced by EsqlBaseParser.selectorString().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.

Specified by:

visitSelectorString in interface EsqlBaseParserVisitor<Object>

Overrides:

visitSelectorString in class EsqlBaseParserBaseVisitor<Object>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitIndexPattern

public String visitIndexPattern(List<EsqlBaseParser.IndexPatternContext> ctx)

validateClusterString

protected static void validateClusterString(String clusterString,
 EsqlBaseParser.IndexPatternContext ctx)

visit

public Object visit(org.antlr.v4.runtime.tree.ParseTree tree)

Specified by:

visit in interface org.antlr.v4.runtime.tree.ParseTreeVisitor<Object>

Overrides:

visit in class org.antlr.v4.runtime.tree.AbstractParseTreeVisitor<Object>

visitTerminal

public Source visitTerminal(org.antlr.v4.runtime.tree.TerminalNode node)

Specified by:

visitTerminal in interface org.antlr.v4.runtime.tree.ParseTreeVisitor<Object>

Overrides:

visitTerminal in class org.antlr.v4.runtime.tree.AbstractParseTreeVisitor<Object>