Package org.elasticsearch.xpack.esql.formatter.arrow

Class BlockArrowFormatter

java.lang.Object

org.elasticsearch.xpack.esql.formatter.arrow.BlockArrowFormatter

Direct Known Subclasses:

BlockArrowFormatter.AsBoolean, BlockArrowFormatter.AsDateRange, BlockArrowFormatter.AsFloat64, BlockArrowFormatter.AsInt32, BlockArrowFormatter.AsInt64, BlockArrowFormatter.AsNull, BlockArrowFormatter.BytesReFormatter

public abstract class BlockArrowFormatter
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BlockArrowFormatter.AsBoolean	Conversion of Boolean blocks
static class	BlockArrowFormatter.AsDateRange	Conversion of LongRangeBlocks (DATE_RANGE) to an Arrow struct with "from" and "to" timestamp[ms] fields.
static class	BlockArrowFormatter.AsFloat64	Conversion of Double blocks
static class	BlockArrowFormatter.AsInt32	Conversion of Int blocks
static class	BlockArrowFormatter.AsInt64	Conversion of Long blocks
static class	BlockArrowFormatter.AsNull
static class	BlockArrowFormatter.AsVarBinary
static class	BlockArrowFormatter.AsVarChar
static interface	BlockArrowFormatter.BufWriter
static class	BlockArrowFormatter.BytesReFormatter	Conversion of ByteRef blocks
static class	BlockArrowFormatter.TransformedBytesRef	Conversion of ByteRefs where each value is itself converted to a different format.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ESQL_TYPE_METADATA

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BlockArrowFormatter(DataType esqlType, org.apache.arrow.vector.types.Types.MinorType minorType)

Method Summary

Modifier and Type	Method	Description
void	addFieldNodes(Block block, boolean multivalued, List<org.apache.arrow.vector.ipc.message.ArrowFieldNode> nodes)	Add Arrow field nodes for this block.
org.apache.arrow.vector.types.pojo.Field	arrowField(String name)
abstract void	convert(Block block, boolean multivalued, List<org.apache.arrow.memory.ArrowBuf> bufs, List<BlockArrowFormatter.BufWriter> bufWriters)	Convert a block into Arrow buffers.
protected int	nullValuesCount(Block block)

Methods inherited from class java.lang.Object

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

Field Details

ESQL_TYPE_METADATA

public static final String ESQL_TYPE_METADATA

See Also:

• Constant Field Values

Constructor Details

BlockArrowFormatter

protected BlockArrowFormatter(DataType esqlType,
 org.apache.arrow.vector.types.Types.MinorType minorType)

Method Details

arrowField

public org.apache.arrow.vector.types.pojo.Field arrowField(String name)

nullValuesCount

protected int nullValuesCount(Block block)

addFieldNodes

public void addFieldNodes(Block block,
 boolean multivalued,
 List<org.apache.arrow.vector.ipc.message.ArrowFieldNode> nodes)

Add Arrow field nodes for this block. Must be called before convert(org.elasticsearch.compute.data.Block, boolean, java.util.List<org.apache.arrow.memory.ArrowBuf>, java.util.List<org.elasticsearch.xpack.esql.formatter.arrow.BlockArrowFormatter.BufWriter>). Override for nested types that contribute multiple nodes (e.g., struct).

convert

public abstract void convert(Block block,
 boolean multivalued,
 List<org.apache.arrow.memory.ArrowBuf> bufs,
 List<BlockArrowFormatter.BufWriter> bufWriters)

Convert a block into Arrow buffers.

Parameters:

block - the ESQL block

multivalued - is this column multivalued? This block may not, but some blocks in that column are.

bufs - arrow buffers, used to track sizes

bufWriters - buffer writers, that will do the actual work of writing the data