Package org.elasticsearch.xpack.esql.datasources.spi

Class SourceOperatorContext.Builder

java.lang.Object

org.elasticsearch.xpack.esql.datasources.spi.SourceOperatorContext.Builder

Enclosing class:

SourceOperatorContext

public static class SourceOperatorContext.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SourceOperatorContext.Builder	attributes(List<Attribute> attributes)
SourceOperatorContext.Builder	batchSize(int batchSize)
SourceOperatorContext	build()
SourceOperatorContext.Builder	config(Map<String,Object> config)
SourceOperatorContext.Builder	datasetName(String datasetName)	Registered dataset identifier (from FROM <dataset>), or null for inline EXTERNAL.
SourceOperatorContext.Builder	declaredReadSpec(DeclaredReadSpec declaredReadSpec)	The declared mapping's read-instructions (renames, _id.path), or DeclaredReadSpec.NONE.
SourceOperatorContext.Builder	deferredExtraction(boolean deferredExtraction)	Whether the plan pairs this source with an ExternalFieldExtractExec consuming deferred-encoded columns.
SourceOperatorContext.Builder	executor(Executor executor)
SourceOperatorContext.Builder	fileList(FileList fileList)
SourceOperatorContext.Builder	fileReadExecutor(Executor fileReadExecutor)	Optional executor for file (and similar) background reads.
SourceOperatorContext.Builder	maxBufferSize(int maxBufferSize)
SourceOperatorContext.Builder	maxConcurrentOpenSegments(int maxConcurrentOpenSegments)
SourceOperatorContext.Builder	maxRecordBytes(int maxRecordBytes)
SourceOperatorContext.Builder	parallelism(int parallelism)
SourceOperatorContext.Builder	parsingParallelism(int parsingParallelism)
SourceOperatorContext.Builder	partitionColumnNames(Set<String> partitionColumnNames)
SourceOperatorContext.Builder	path(StoragePath path)
SourceOperatorContext.Builder	projectedColumns(List<String> projectedColumns)
SourceOperatorContext.Builder	pushedExpressions(List<Expression> pushedExpressions)
SourceOperatorContext.Builder	pushedFilter(Object pushedFilter)
SourceOperatorContext.Builder	rowLimit(int rowLimit)
SourceOperatorContext.Builder	schemaMap(Map<StoragePath,SchemaReconciliation.FileSchemaInfo> schemaMap)	Per-file planner-resolved schema info, populated by the resolver and threaded through ExternalSourceExec.
SourceOperatorContext.Builder	sliceQueue(ExternalSliceQueue sliceQueue)
SourceOperatorContext.Builder	sourceMetadata(Map<String,Object> sourceMetadata)
SourceOperatorContext.Builder	sourceType(String sourceType)
SourceOperatorContext.Builder	split(ExternalSplit split)

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

sourceType

public SourceOperatorContext.Builder sourceType(String sourceType)

path

public SourceOperatorContext.Builder path(StoragePath path)

projectedColumns

public SourceOperatorContext.Builder projectedColumns(List<String> projectedColumns)

attributes

public SourceOperatorContext.Builder attributes(List<Attribute> attributes)

batchSize

public SourceOperatorContext.Builder batchSize(int batchSize)

maxBufferSize

public SourceOperatorContext.Builder maxBufferSize(int maxBufferSize)

rowLimit

public SourceOperatorContext.Builder rowLimit(int rowLimit)

executor

public SourceOperatorContext.Builder executor(Executor executor)

fileReadExecutor

public SourceOperatorContext.Builder fileReadExecutor(Executor fileReadExecutor)

Optional executor for file (and similar) background reads. When set (e.g. to generic), async reads and slice-queue drain run here instead of on executor, so producers blocked in buffer backpressure do not starve the esql_worker drivers that consume the buffer.

config

public SourceOperatorContext.Builder config(Map<String,Object> config)

sourceMetadata

public SourceOperatorContext.Builder sourceMetadata(Map<String,Object> sourceMetadata)

pushedFilter

public SourceOperatorContext.Builder pushedFilter(Object pushedFilter)

pushedExpressions

public SourceOperatorContext.Builder pushedExpressions(List<Expression> pushedExpressions)

fileList

public SourceOperatorContext.Builder fileList(FileList fileList)

schemaMap

public SourceOperatorContext.Builder schemaMap(Map<StoragePath,SchemaReconciliation.FileSchemaInfo> schemaMap)

Per-file planner-resolved schema info, populated by the resolver and threaded through ExternalSourceExec. Always present for resolved sources (single-file gets a one-entry identity map; multi-file gets the reconciliation result). Empty map for legacy/unresolved paths.

split

public SourceOperatorContext.Builder split(ExternalSplit split)

partitionColumnNames

public SourceOperatorContext.Builder partitionColumnNames(Set<String> partitionColumnNames)

sliceQueue

public SourceOperatorContext.Builder sliceQueue(ExternalSliceQueue sliceQueue)

parsingParallelism

public SourceOperatorContext.Builder parsingParallelism(int parsingParallelism)

maxConcurrentOpenSegments

public SourceOperatorContext.Builder maxConcurrentOpenSegments(int maxConcurrentOpenSegments)

maxRecordBytes

public SourceOperatorContext.Builder maxRecordBytes(int maxRecordBytes)

parallelism

public SourceOperatorContext.Builder parallelism(int parallelism)

datasetName

public SourceOperatorContext.Builder datasetName(@Nullable
 String datasetName)

Registered dataset identifier (from FROM <dataset>), or null for inline EXTERNAL. Consumed by the operator factory's per-file _index synthesizer so the column carries the user-facing dataset name rather than the resource path.

deferredExtraction

public SourceOperatorContext.Builder deferredExtraction(boolean deferredExtraction)

Whether the plan pairs this source with an ExternalFieldExtractExec consuming deferred-encoded columns. The operator factory keys deferred extraction off this flag, not off _rowPosition presence in the projection — the latter is also produced for plain _id composition with no extract operator downstream.

declaredReadSpec

public SourceOperatorContext.Builder declaredReadSpec(DeclaredReadSpec declaredReadSpec)

The declared mapping's read-instructions (renames, _id.path), or DeclaredReadSpec.NONE. Consumed by FileSourceFactory: renames physicalize reader-facing names, _id.path stamps _id from that column.

build

public SourceOperatorContext build()