Package org.elasticsearch.xpack.esql.session

Class Configuration

java.lang.Object

org.elasticsearch.xpack.esql.session.Configuration

All Implemented Interfaces:

Writeable

public class Configuration
extends Object
implements Writeable

Nested Class Summary

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 TransportVersion	ESQL_VIEW_QUERIES	Transport version for view queries support.
static final int	QUERY_COMPRESS_THRESHOLD_CHARS

Constructor Summary

Constructors

Constructor	Description
Configuration(ZoneId zi, Instant now, Locale locale, String username, String clusterName, QueryPragmas pragmas, int resultTruncationMaxSizeRegular, int resultTruncationDefaultSizeRegular, String query, boolean profile, Map<String,Map<String,Column>> tables, long queryStartTimeNanos, boolean allowPartialResults, int resultTruncationMaxSizeTimeseries, int resultTruncationDefaultSizeTimeseries, String projectRouting, ApproximationSettings approximationSettings, Map<String,String> viewQueries)
Configuration(ZoneId zi, Instant now, Locale locale, String username, String clusterName, QueryPragmas pragmas, int resultTruncationMaxSizeRegular, int resultTruncationDefaultSizeRegular, String query, boolean profile, Map<String,Map<String,Column>> tables, long queryStartTimeNanos, boolean allowPartialResults, int resultTruncationMaxSizeTimeseries, int resultTruncationDefaultSizeTimeseries, String projectRouting, ApproximationSettings approximationSettings, Map<String,String> viewQueries, boolean explainOnly)
Configuration(BlockStreamInput in)

Method Summary

Modifier and Type	Method	Description
long	absoluteStartedTimeInMillis()	Returns the current time in milliseconds from the time epoch for the execution of this request.
boolean	allowPartialResults()	Whether this request can return partial results instead of failing fast on failures
ApproximationSettings	approximationSettings()
String	clusterName()
boolean	equals(Object o)
boolean	explainOnly()	Whether this is an explain-only request.
int	hashCode()
Locale	locale()
FoldContext	newFoldContext()	Create a new FoldContext with the limit configured in the QueryPragmas.
Instant	now()
QueryPragmas	pragmas()
boolean	profile()	Enable profiling, sacrificing performance to return information about what operations are taking the most time.
String	projectRouting()
String	query()
long	queryStartTimeNanos()
static Configuration	readWithoutTables(StreamInput in)	Reads a Configuration that doesn't contain any tables().
int	resultTruncationDefaultSize(boolean isTimeseries)
int	resultTruncationMaxSize(boolean isTimeseries)
Map<String,Map<String,Column>>	tables()	Tables specified in the request.
String	toString()
String	username()
Map<String,String>	viewQueries()	Returns the map of view names to their query strings.
Configuration	withExplainOnly()	Returns a new Configuration with profile and explainOnly enabled.
Configuration	withoutTables()
Configuration	withViewQueries(Map<String,String> viewQueries)	Returns a new Configuration with the given view queries added.
void	writeTo(StreamOutput out)
ZoneId	zoneId()

Methods inherited from class java.lang.Object

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

Field Details

QUERY_COMPRESS_THRESHOLD_CHARS

public static final int QUERY_COMPRESS_THRESHOLD_CHARS

ESQL_VIEW_QUERIES

public static final TransportVersion ESQL_VIEW_QUERIES

Transport version for view queries support. This is needed to correctly serialize/deserialize Source objects that originated from views (which have positions relative to the view query, not the main query).

Constructor Details

Configuration

public Configuration(ZoneId zi,
 Instant now,
 Locale locale,
 String username,
 String clusterName,
 QueryPragmas pragmas,
 int resultTruncationMaxSizeRegular,
 int resultTruncationDefaultSizeRegular,
 @Nullable
 String query,
 boolean profile,
 Map<String,Map<String,Column>> tables,
 long queryStartTimeNanos,
 boolean allowPartialResults,
 int resultTruncationMaxSizeTimeseries,
 int resultTruncationDefaultSizeTimeseries,
 String projectRouting,
 ApproximationSettings approximationSettings,
 Map<String,String> viewQueries)

Configuration

public Configuration(BlockStreamInput in)
              throws IOException

Throws:

IOException

Configuration

public Configuration(ZoneId zi,
 Instant now,
 Locale locale,
 String username,
 String clusterName,
 QueryPragmas pragmas,
 int resultTruncationMaxSizeRegular,
 int resultTruncationDefaultSizeRegular,
 @Nullable
 String query,
 boolean profile,
 Map<String,Map<String,Column>> tables,
 long queryStartTimeNanos,
 boolean allowPartialResults,
 int resultTruncationMaxSizeTimeseries,
 int resultTruncationDefaultSizeTimeseries,
 String projectRouting,
 ApproximationSettings approximationSettings,
 Map<String,String> viewQueries,
 boolean explainOnly)

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

zoneId

public ZoneId zoneId()

now

public Instant now()

clusterName

public String clusterName()

username

public String username()

pragmas

public QueryPragmas pragmas()

resultTruncationMaxSize

public int resultTruncationMaxSize(boolean isTimeseries)

resultTruncationDefaultSize

public int resultTruncationDefaultSize(boolean isTimeseries)

locale

public Locale locale()

query

public String query()

absoluteStartedTimeInMillis

public long absoluteStartedTimeInMillis()

Returns the current time in milliseconds from the time epoch for the execution of this request. It ensures consistency by using the same value on all nodes involved in the search request.

queryStartTimeNanos

public long queryStartTimeNanos()

Returns:

Start time of the ESQL query in nanos

newFoldContext

public FoldContext newFoldContext()

Create a new FoldContext with the limit configured in the QueryPragmas.

tables

public Map<String,Map<String,Column>> tables()

Tables specified in the request.

withoutTables

public Configuration withoutTables()

profile

public boolean profile()

Enable profiling, sacrificing performance to return information about what operations are taking the most time.

allowPartialResults

public boolean allowPartialResults()

Whether this request can return partial results instead of failing fast on failures

explainOnly

public boolean explainOnly()

Whether this is an explain-only request. This flag is propagated to data nodes and could be used for future optimization to skip actual computation. Currently, the EXPLAIN command executes the query normally with profile=true.

withExplainOnly

public Configuration withExplainOnly()

Returns a new Configuration with profile and explainOnly enabled. Used for EXPLAIN queries that need to capture plan information.

projectRouting

public String projectRouting()

approximationSettings

public ApproximationSettings approximationSettings()

viewQueries

public Map<String,String> viewQueries()

Returns the map of view names to their query strings.

withViewQueries

public Configuration withViewQueries(Map<String,String> viewQueries)

Returns a new Configuration with the given view queries added.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

readWithoutTables

public static Configuration readWithoutTables(StreamInput in)
                                       throws IOException

Reads a Configuration that doesn't contain any tables().

Throws:

IOException