Module org.elasticsearch.compute

Package org.elasticsearch.compute.lucene

Interface ShardContext

All Superinterfaces:

RefCounted

public interface ShardContext
extends RefCounted

Context of each shard we're operating against.

Field Summary

Fields inherited from interface org.elasticsearch.core.RefCounted

ALWAYS_REFERENCED

Method Summary

Modifier and Type	Method	Description
BlockLoader	blockLoader(String name, boolean asUnsupportedSource, MappedFieldType.FieldExtractPreference fieldExtractPreference, BlockLoaderFunctionConfig blockLoaderFunctionConfig, Warnings warnings, ByteSizeValue blockLoaderSizeOrdinals, ByteSizeValue blockLoaderSizeScript)	Returns something to load values from this field into a Block.
Optional<SortAndFormats>	buildSort(List<SortBuilder<?>> sorts)	Build a "sort" configuration from an Elasticsearch style builder.
MappedFieldType	fieldType(String name)	Returns the MappedFieldType for the given field name.
int	index()	The index of this shard in the list of shards being processed.
SourceLoader	newSourceLoader(Set<String> sourcePaths)	Build something to load source _source.
org.apache.lucene.search.IndexSearcher	searcher()	Get IndexSearcher holding the actual data.
String	shardIdentifier()	A "name" for the shard that you can look up against other APIs like _cat/shards.
ShardSearchStats	stats()

Methods inherited from interface org.elasticsearch.core.RefCounted

decRef, hasReferences, incRef, mustIncRef, tryIncRef

Method Details

index

int index()

The index of this shard in the list of shards being processed.

searcher

org.apache.lucene.search.IndexSearcher searcher()

Get IndexSearcher holding the actual data.

buildSort

Optional<SortAndFormats> buildSort(List<SortBuilder<?>> sorts)
                            throws IOException

Build a "sort" configuration from an Elasticsearch style builder.

Throws:

IOException

shardIdentifier

String shardIdentifier()

A "name" for the shard that you can look up against other APIs like _cat/shards.

newSourceLoader

SourceLoader newSourceLoader(Set<String> sourcePaths)

Build something to load source _source.

blockLoader

BlockLoader blockLoader(String name,
 boolean asUnsupportedSource,
 MappedFieldType.FieldExtractPreference fieldExtractPreference,
 BlockLoaderFunctionConfig blockLoaderFunctionConfig,
 Warnings warnings,
 ByteSizeValue blockLoaderSizeOrdinals,
 ByteSizeValue blockLoaderSizeScript)

Returns something to load values from this field into a Block.

fieldType

MappedFieldType fieldType(String name)

Returns the MappedFieldType for the given field name. By default, this delegate to QueryRewriteContext.getFieldType(String)

stats

ShardSearchStats stats()