Package org.elasticsearch.xpack.esql.action

Class EsqlQueryResponse

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportResponse

org.elasticsearch.action.ActionResponse

org.elasticsearch.xpack.core.esql.action.EsqlQueryResponse

org.elasticsearch.xpack.esql.action.EsqlQueryResponse

All Implemented Interfaces:

Closeable, AutoCloseable, Writeable, ChunkedToXContent, ChunkedToXContentObject, RefCounted, Releasable

public class EsqlQueryResponse
extends EsqlQueryResponse
implements ChunkedToXContentObject, Releasable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	EsqlQueryResponse.Profile

Nested classes/interfaces inherited from class org.elasticsearch.action.ActionResponse

ActionResponse.Empty

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 String	DROP_NULL_COLUMNS_OPTION

Fields inherited from interface org.elasticsearch.common.xcontent.ChunkedToXContent

EMPTY

Fields inherited from interface org.elasticsearch.core.RefCounted

ALWAYS_REFERENCED

Constructor Summary

Constructors

Constructor	Description
EsqlQueryResponse(List<ColumnInfoImpl> columns, List<Page> pages, long documentsFound, long valuesLoaded, long rowsEmitted, long bytesRead, long readNanos, long cpuNanos, EsqlQueryResponse.Profile profile, boolean columnar, String asyncExecutionId, boolean isRunning, boolean isAsync, ZoneId zoneId, long startTimeMillis, long expirationTimeMillis, EsqlExecutionInfo executionInfo)
EsqlQueryResponse(List<ColumnInfoImpl> columns, List<Page> pages, long documentsFound, long valuesLoaded, EsqlQueryResponse.Profile profile, boolean columnar, boolean isAsync, ZoneId zoneId, long startTimeMillis, long expirationTimeMillis, EsqlExecutionInfo executionInfo)
EsqlQueryResponse(List<ColumnInfoImpl> columns, List<Page> pages, long documentsFound, long valuesLoaded, EsqlQueryResponse.Profile profile, boolean columnar, String asyncExecutionId, boolean isRunning, boolean isAsync, ZoneId zoneId, long startTimeMillis, long expirationTimeMillis, EsqlExecutionInfo executionInfo)

Method Summary

Modifier and Type	Method	Description
Optional<String>	asyncExecutionId()
long	bytesRead()
void	close()
Iterator<Object>	column(int columnIndex)
boolean	columnar()
List<ColumnInfoImpl>	columns()
long	cpuNanos()
boolean	decRef()
long	documentsFound()
boolean	equals(Object o)
EsqlExecutionInfo	getExecutionInfo()
long	getRowCount()
int	hashCode()
boolean	hasReferences()
void	incRef()
boolean	isAsync()
boolean	isPartial()
boolean	isRunning()
boolean[]	nullColumns()
List<Page>	pages()
EsqlQueryResponse.Profile	profile()
static Writeable.Reader<EsqlQueryResponse>	reader(BlockFactory blockFactory)	Build a reader for the response.
long	readNanos()
EsqlResponse	responseInternal()
Iterable<Iterable<Object>>	rows()
long	rowsEmitted()
String	toString()
Iterator<? extends ToXContent>	toXContentChunked(ToXContent.Params params)
boolean	tryIncRef()
Iterator<Iterator<Object>>	values()
long	valuesLoaded()
void	writeTo(StreamOutput out)
ZoneId	zoneId()

Methods inherited from class org.elasticsearch.xpack.core.esql.action.EsqlQueryResponse

response

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.common.xcontent.ChunkedToXContent

toXContentChunked, toXContentChunkedV8

Methods inherited from interface org.elasticsearch.common.xcontent.ChunkedToXContentObject

isFragment

Methods inherited from interface org.elasticsearch.core.RefCounted

mustIncRef

Field Details

DROP_NULL_COLUMNS_OPTION

public static final String DROP_NULL_COLUMNS_OPTION

See Also:

• Constant Field Values

Constructor Details

EsqlQueryResponse

public EsqlQueryResponse(List<ColumnInfoImpl> columns,
 List<Page> pages,
 long documentsFound,
 long valuesLoaded,
 long rowsEmitted,
 long bytesRead,
 long readNanos,
 long cpuNanos,
 @Nullable
 EsqlQueryResponse.Profile profile,
 boolean columnar,
 @Nullable
 String asyncExecutionId,
 boolean isRunning,
 boolean isAsync,
 ZoneId zoneId,
 long startTimeMillis,
 long expirationTimeMillis,
 EsqlExecutionInfo executionInfo)

EsqlQueryResponse

public EsqlQueryResponse(List<ColumnInfoImpl> columns,
 List<Page> pages,
 long documentsFound,
 long valuesLoaded,
 @Nullable
 EsqlQueryResponse.Profile profile,
 boolean columnar,
 @Nullable
 String asyncExecutionId,
 boolean isRunning,
 boolean isAsync,
 ZoneId zoneId,
 long startTimeMillis,
 long expirationTimeMillis,
 EsqlExecutionInfo executionInfo)

EsqlQueryResponse

public EsqlQueryResponse(List<ColumnInfoImpl> columns,
 List<Page> pages,
 long documentsFound,
 long valuesLoaded,
 @Nullable
 EsqlQueryResponse.Profile profile,
 boolean columnar,
 boolean isAsync,
 ZoneId zoneId,
 long startTimeMillis,
 long expirationTimeMillis,
 EsqlExecutionInfo executionInfo)

Method Details

reader

public static Writeable.Reader<EsqlQueryResponse> reader(BlockFactory blockFactory)

Build a reader for the response.

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

columns

public List<ColumnInfoImpl> columns()

pages

public List<Page> pages()

values

public Iterator<Iterator<Object>> values()

rows

public Iterable<Iterable<Object>> rows()

column

public Iterator<Object> column(int columnIndex)

rowsEmitted

public long rowsEmitted()

Returns:

the number of "documents" we got back from lucene, as input into the compute engine. Note that in this context, we think of things like the result of LuceneMaxOperator as single documents.

bytesRead

public long bytesRead()

readNanos

public long readNanos()

cpuNanos

public long cpuNanos()

documentsFound

public long documentsFound()

valuesLoaded

public long valuesLoaded()

profile

public EsqlQueryResponse.Profile profile()

columnar

public boolean columnar()

asyncExecutionId

public Optional<String> asyncExecutionId()

isRunning

public boolean isRunning()

isAsync

public boolean isAsync()

zoneId

public ZoneId zoneId()

isPartial

public boolean isPartial()

getExecutionInfo

public EsqlExecutionInfo getExecutionInfo()

toXContentChunked

public Iterator<? extends ToXContent> toXContentChunked(ToXContent.Params params)

Specified by:

toXContentChunked in interface ChunkedToXContent

nullColumns

public boolean[] nullColumns()

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

incRef

public void incRef()

Specified by:

incRef in interface RefCounted

Overrides:

incRef in class TransportMessage

tryIncRef

public boolean tryIncRef()

Specified by:

tryIncRef in interface RefCounted

Overrides:

tryIncRef in class TransportMessage

decRef

public boolean decRef()

Specified by:

decRef in interface RefCounted

Overrides:

decRef in class TransportMessage

hasReferences

public boolean hasReferences()

Specified by:

hasReferences in interface RefCounted

Overrides:

hasReferences in class TransportMessage

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface Releasable

Overrides:

close in class EsqlQueryResponse

responseInternal

public EsqlResponse responseInternal()

Specified by:

responseInternal in class EsqlQueryResponse

getRowCount

public long getRowCount()