Package org.elasticsearch.xpack.esql.io.stream

Class PlanStreamInput

java.lang.Object

java.io.InputStream

org.elasticsearch.common.io.stream.StreamInput

org.elasticsearch.common.io.stream.FilterStreamInput

org.elasticsearch.common.io.stream.NamedWriteableAwareStreamInput

org.elasticsearch.xpack.esql.io.stream.PlanStreamInput

All Implemented Interfaces:

Closeable, AutoCloseable

public final class PlanStreamInput
extends NamedWriteableAwareStreamInput

A customized stream input used to deserialize ESQL physical plan fragments. Complements stream input with methods that read plan nodes, Attributes, Expressions, etc.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PlanStreamInput.NameIdMapper	A Mapper of stream named id, represented as a primitive long value, to NameId instance.

Field Summary

Fields inherited from class org.elasticsearch.common.io.stream.FilterStreamInput

delegate

Constructor Summary

Constructors

Constructor	Description
PlanStreamInput(StreamInput streamInput, NamedWriteableRegistry namedWriteableRegistry, Configuration configuration)
PlanStreamInput(StreamInput streamInput, NamedWriteableRegistry namedWriteableRegistry, Configuration configuration, PlanStreamInput.NameIdMapper idMapper)

Method Summary

Modifier and Type	Method	Description
void	close()
Configuration	configuration()
NameId	mapNameId(long l)	Translate a long into a NameId, mapping the same long into the same NameId each time.
<A extends Attribute> A	readAttributeWithCache(org.elasticsearch.core.CheckedFunction<StreamInput,A,IOException> constructor)	Reads an Attribute using the attribute cache.
Block	readCachedBlock()	Read a Block as part of the plan.
Block[]	readCachedBlockArray()	Read an array of Blocks as part of the plan.
String	readCachedString()	Reads a cached string, serialized with PlanStreamOutput.writeCachedString(String).
<A extends EsField> A	readEsFieldWithCache()
String	readOptionalCachedString()
String	sourceText()	The query sent by the user to build this plan.
String	sourceText(String viewName)	Returns the query text for the given view name, or the main query if viewName is null.

Methods inherited from class org.elasticsearch.common.io.stream.NamedWriteableAwareStreamInput

namedWriteableRegistry, readNamedWriteable, readNamedWriteable, readNamedWriteableCollectionAsList

Methods inherited from class org.elasticsearch.common.io.stream.FilterStreamInput

available, ensureCanReadBytes, getTransportVersion, read, read, readAllToReleasableBytesReference, readByte, readBytes, readInt, readLong, readReleasableBytesReference, readReleasableBytesReference, readShort, readSlicedBytesReference, readString, readVInt, readVLong, reset, setTransportVersion, supportReadAllToReleasableBytesReference

Methods inherited from class org.elasticsearch.common.io.stream.StreamInput

doReadString, readArray, readArraySize, readBigInteger, readBoolean, readByteArray, readBytesRef, readBytesRef, readBytesReference, readBytesReference, readBytesRefOrNullIfEmpty, readCollection, readCollectionAsImmutableList, readCollectionAsImmutableSet, readCollectionAsList, readCollectionAsSet, readDouble, readDoubleArray, readEnum, readEnumSet, readException, readFloat, readFloatArray, readFully, readGenericMap, readGenericValue, readGeoPoint, readImmutableMap, readImmutableMap, readImmutableOpenMap, readInstant, readIntArray, readLongArray, readMap, readMap, readMapOfLists, readMapValues, readMapValues, readOptional, readOptionalArray, readOptionalBoolean, readOptionalByteArray, readOptionalBytesReference, readOptionalCollectionAsList, readOptionalDouble, readOptionalEnum, readOptionalException, readOptionalFloat, readOptionalFloatArray, readOptionalImmutableMap, readOptionalInstant, readOptionalInt, readOptionalLong, readOptionalNamedWriteable, readOptionalNamedWriteableCollectionAsList, readOptionalSecureString, readOptionalString, readOptionalStringArray, readOptionalStringCollectionAsList, readOptionalText, readOptionalTimeValue, readOptionalVInt, readOptionalVLong, readOptionalWriteable, readOptionalZoneId, readOrderedMap, readSecureString, readSlicedBytesReference, readStringArray, readStringCollectionAsImmutableList, readStringCollectionAsList, readText, readTimeValue, readVIntArray, readVIntSlow, readVLongArray, readVLongSlow, readZLong, readZoneId, throwEOF, throwOnBrokenVInt, throwOnBrokenVLong, throwOnNullRead, tryReadStringFromBytes, wrap, wrap

Methods inherited from class java.io.InputStream

mark, markSupported, nullInputStream, read, readAllBytes, readNBytes, readNBytes, skip, skipNBytes, transferTo

Methods inherited from class java.lang.Object

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

Constructor Details

PlanStreamInput

public PlanStreamInput(StreamInput streamInput,
 NamedWriteableRegistry namedWriteableRegistry,
 Configuration configuration)

PlanStreamInput

public PlanStreamInput(StreamInput streamInput,
 NamedWriteableRegistry namedWriteableRegistry,
 Configuration configuration,
 PlanStreamInput.NameIdMapper idMapper)

Parameters:

idMapper - should always be null in production! Custom mappers are only used in tests to force ID values to be the same after serialization and deserialization, which is not the case when they are generated as usual.

Method Details

configuration

public Configuration configuration()
                            throws IOException

Throws:

IOException

readCachedBlock

public Block readCachedBlock()
                      throws IOException

Read a Block as part of the plan.

These Blocks are not tracked by BlockFactory and closing them does nothing so they should be small. We do make sure not to send duplicates, reusing blocks sent as part of the Configuration.tables() if possible, otherwise sending a Block inline.

Throws:

IOException

readCachedBlockArray

public Block[] readCachedBlockArray()
                             throws IOException

Read an array of Blocks as part of the plan.

These Blocks are not tracked by BlockFactory and closing them does nothing so they should be small. We do make sure not to send duplicates, reusing blocks sent as part of the Configuration.tables() if possible, otherwise sending a Block inline.

Throws:

IOException

sourceText

public String sourceText()

The query sent by the user to build this plan. This is used to rebuild Source without sending the query over the wire over and over and over again.

sourceText

public String sourceText(String viewName)

Returns the query text for the given view name, or the main query if viewName is null. This is used during Source deserialization to look up the correct query string based on where the Source originated from.

mapNameId

public NameId mapNameId(long l)

Translate a long into a NameId, mapping the same long into the same NameId each time. Each new long gets assigned a unique id to the node, but when the same id is sent in the stream we get the same result.

readAttributeWithCache

public <A extends Attribute> A readAttributeWithCache(org.elasticsearch.core.CheckedFunction<StreamInput,A,IOException> constructor)
                                               throws IOException

Reads an Attribute using the attribute cache.

Parameters:

constructor - the constructor needed to build the actual attribute when read from the wire

Returns:

An attribute; this will generally be the same type as the provided constructor

Throws:

IOException

readEsFieldWithCache

public <A extends EsField> A readEsFieldWithCache()
                                           throws IOException

Throws:

IOException

readCachedString

public String readCachedString()
                        throws IOException

Reads a cached string, serialized with PlanStreamOutput.writeCachedString(String).

Throws:

IOException

readOptionalCachedString

public String readOptionalCachedString()
                                throws IOException

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class FilterStreamInput

Throws:

IOException