Package org.elasticsearch.xpack.esql.expression.function.scalar.string

Class Chunk

java.lang.Object

org.elasticsearch.xpack.esql.core.tree.Node<Expression>

org.elasticsearch.xpack.esql.core.expression.Expression

org.elasticsearch.xpack.esql.core.expression.function.Function

org.elasticsearch.xpack.esql.core.expression.function.scalar.ScalarFunction

org.elasticsearch.xpack.esql.expression.function.scalar.EsqlScalarFunction

org.elasticsearch.xpack.esql.expression.function.scalar.string.Chunk

All Implemented Interfaces:

NamedWriteable, Writeable, Resolvable, EvaluatorMapper, OptionalArgument

public class Chunk
extends EsqlScalarFunction
implements OptionalArgument

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.xpack.esql.core.expression.Expression

Expression.TypeResolution

Nested classes/interfaces inherited from interface org.elasticsearch.xpack.esql.evaluator.mapper.EvaluatorMapper

EvaluatorMapper.ToEvaluator

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 Map<String,DataType>	ALLOWED_OPTIONS
static final int	DEFAULT_CHUNK_SIZE
static final int	DEFAULT_NUM_CHUNKS
static final NamedWriteableRegistry.Entry	ENTRY

Fields inherited from class org.elasticsearch.xpack.esql.core.expression.function.scalar.ScalarFunction

MAX_BYTES_REF_RESULT_SIZE

Fields inherited from class org.elasticsearch.xpack.esql.core.tree.Node

TO_STRING_MAX_WIDTH

Constructor Summary

Constructors

Constructor	Description
Chunk(StreamInput in)
Chunk(Source source, Expression field, Expression options)

Method Summary

Modifier and Type	Method	Description
static List<String>	chunkText(String content, ChunkingSettings chunkingSettings, int numChunks)
DataType	dataType()
boolean	equals(Object o)
boolean	foldable()
String	getWriteableName()
int	hashCode()
protected NodeInfo<? extends Expression>	info()
Expression	replaceChildren(List<Expression> newChildren)
protected Expression.TypeResolution	resolveType()
EvalOperator.ExpressionEvaluator.Factory	toEvaluator(EvaluatorMapper.ToEvaluator toEvaluator)	Convert this into an EvalOperator.ExpressionEvaluator.
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.xpack.esql.expression.function.scalar.EsqlScalarFunction

fold

Methods inherited from class org.elasticsearch.xpack.esql.core.expression.function.Function

arguments, functionName, nodeString, nullable

Methods inherited from class org.elasticsearch.xpack.esql.core.expression.Expression

canonical, canonicalize, childrenResolved, propertiesToString, references, resolved, semanticEquals, semanticHash, toString, typeResolved

Methods inherited from class org.elasticsearch.xpack.esql.core.tree.Node

anyMatch, children, collect, collectFirstChildren, collectLeaves, doCollectFirst, forEachDown, forEachDown, forEachDownMayReturnEarly, forEachProperty, forEachPropertyDown, forEachPropertyOnly, forEachPropertyUp, forEachUp, forEachUp, nodeName, nodeProperties, replaceChildrenSameSize, source, sourceLocation, sourceText, transformChildren, transformDown, transformDown, transformDown, transformNodeProps, transformPropertiesDown, transformPropertiesOnly, transformPropertiesUp, transformUp, transformUp, transformUp

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xpack.esql.evaluator.mapper.EvaluatorMapper

fold

Field Details

ENTRY

public static final NamedWriteableRegistry.Entry ENTRY

DEFAULT_NUM_CHUNKS

public static final int DEFAULT_NUM_CHUNKS

See Also:

• Constant Field Values

DEFAULT_CHUNK_SIZE

public static final int DEFAULT_CHUNK_SIZE

See Also:

• Constant Field Values

ALLOWED_OPTIONS

public static final Map<String,DataType> ALLOWED_OPTIONS

Constructor Details

Chunk

public Chunk(Source source,
 Expression field,
 Expression options)

Chunk

public Chunk(StreamInput in)
      throws IOException

Throws:

IOException

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

getWriteableName

public String getWriteableName()

Specified by:

getWriteableName in interface NamedWriteable

dataType

public DataType dataType()

Specified by:

dataType in class Expression

resolveType

protected Expression.TypeResolution resolveType()

Overrides:

resolveType in class Expression

foldable

public boolean foldable()

Overrides:

foldable in class Expression

replaceChildren

public Expression replaceChildren(List<Expression> newChildren)

Specified by:

replaceChildren in class Node<Expression>

info

protected NodeInfo<? extends Expression> info()

Specified by:

info in class Node<Expression>

chunkText

public static List<String> chunkText(String content,
 ChunkingSettings chunkingSettings,
 int numChunks)

equals

public boolean equals(Object o)

Overrides:

equals in class Function

hashCode

public int hashCode()

Overrides:

hashCode in class Function

toEvaluator

public EvalOperator.ExpressionEvaluator.Factory toEvaluator(EvaluatorMapper.ToEvaluator toEvaluator)

Description copied from interface: EvaluatorMapper

Convert this into an EvalOperator.ExpressionEvaluator.

Note for implementors: If you are implementing this function, you should call the passed-in lambda on your children, after doing any other manipulation (casting, etc.) necessary.

Note for Callers: If you are attempting to call this method, and you have an Expression and a Layout, you likely want to call EvalMapper.toEvaluator(org.elasticsearch.xpack.esql.core.expression.FoldContext, org.elasticsearch.xpack.esql.core.expression.Expression, org.elasticsearch.xpack.esql.planner.Layout) instead. On the other hand, if you already have something that looks like the parameter for this method, you should call this method with that function.

Build an EvalOperator.ExpressionEvaluator.Factory for the tree of expressions rooted at this node. This is only guaranteed to return a sensible evaluator if this node has a valid type. If this node is a subclass of Expression then "valid type" means that Expression.typeResolved() returns a non-error resolution. If Expression.typeResolved() returns an error then this method may throw. Or return an evaluator that produces garbage. Or return an evaluator that throws when run.

Specified by:

toEvaluator in interface EvaluatorMapper