Package org.elasticsearch.xpack.esql.parser

Class EsqlParser

java.lang.Object

org.elasticsearch.xpack.esql.parser.EsqlParser

public class EsqlParser
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MAX_LENGTH	Maximum number of characters in an ESQL query.

Constructor Summary

Constructors

Constructor	Description
EsqlParser(EsqlConfig config)

Method Summary

Modifier and Type	Method	Description
EsqlStatement	createStatement(String query)
EsqlStatement	createStatement(String query, QueryParams params)
EsqlStatement	parse(String query, QueryParams params, InferenceSettings inferenceSettings)	Parses the given query into an EsqlStatement.
LogicalPlan	parseQuery(String query)
LogicalPlan	parseQuery(String query, QueryParams params)
LogicalPlan	parseQuery(String query, QueryParams params, InferenceSettings inferenceSettings)
EsqlStatement	parseView(String query, QueryParams params, SettingsValidationContext settingsValidationCtx, InferenceSettings inferenceSettings, String viewName)	Parse a view query with the given view name.
EsqlStatement	unvalidatedStatement(String query, QueryParams params)

Methods inherited from class java.lang.Object

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

Field Details

MAX_LENGTH

public static final int MAX_LENGTH

Maximum number of characters in an ESQL query. Antlr may parse the entire query into tokens to make the choices, buffering the world. There's a lot we can do in the grammar to prevent that, but let's be paranoid and assume we'll fail at preventing antlr from slurping in the world. Instead, let's make sure that the world just isn't that big.

See Also:

• Constant Field Values

Constructor Details

EsqlParser

public EsqlParser(EsqlConfig config)

Method Details

parseQuery

public LogicalPlan parseQuery(String query)

parseQuery

public LogicalPlan parseQuery(String query,
 QueryParams params)

parseQuery

public LogicalPlan parseQuery(String query,
 QueryParams params,
 InferenceSettings inferenceSettings)

createStatement

public EsqlStatement createStatement(String query)

unvalidatedStatement

public EsqlStatement unvalidatedStatement(String query,
 QueryParams params)

createStatement

public EsqlStatement createStatement(String query,
 QueryParams params)

parse

public EsqlStatement parse(String query,
 QueryParams params,
 InferenceSettings inferenceSettings)

Parses the given query into an EsqlStatement. Note that query settings (accessible via EsqlStatement.settings()) are not validated by this method — the caller is responsible for performing any necessary validation before using them.

parseView

public EsqlStatement parseView(String query,
 QueryParams params,
 SettingsValidationContext settingsValidationCtx,
 InferenceSettings inferenceSettings,
 String viewName)

Parse a view query with the given view name. The view name is used to tag all Source objects so they can be correctly deserialized when the view positions exceed the outer query's length.

Unlike the top-level query, which is validated inside EsqlQueryRequest.parse(org.elasticsearch.xpack.esql.parser.EsqlParser, org.elasticsearch.xpack.esql.plan.SettingsValidationContext, org.elasticsearch.xpack.esql.inference.InferenceSettings), view bodies are parsed inside a callback that has no request object — so settings validation is performed here, where the SettingsValidationContext is available, rather than at the call site.