Module org.elasticsearch.server

Package org.elasticsearch.index.mapper

Interface MappedFieldType.BlockLoaderContext

Enclosing class:

MappedFieldType

public static interface MappedFieldType.BlockLoaderContext

Arguments for MappedFieldType.blockLoader(org.elasticsearch.index.mapper.MappedFieldType.BlockLoaderContext).

Field Summary

Fields

Modifier and Type	Field	Description
static final ByteSizeValue	DEFAULT_ORDINALS_BYTE_SIZE
static final ByteSizeValue	DEFAULT_SCRIPT_BYTE_SIZE

Method Summary

Modifier and Type	Method	Description
BlockLoaderFunctionConfig	blockLoaderFunctionConfig()
MappedFieldType.FieldExtractPreference	fieldExtractPreference()	How the field should be extracted into the BlockLoader.
FieldNamesFieldMapper.FieldNamesFieldType	fieldNames()	The _field_names field mapper, mostly used to check if it is enabled.
String	indexName()	The name of the index.
IndexSettings	indexSettings()	The index settings of the index
SearchLookup	lookup()	SearchLookup used for building scripts.
MappingLookup	mappingLookup()	MappingLookup for the queried index.
ByteSizeValue	ordinalsByteSize()	Number of bytes reserved for each ordinals BlockLoader.Reader.
String	parentField(String field)	If field is a leaf multi-field return the path to the parent field.
ByteSizeValue	scriptByteSize()	Number of bytes reserved for each script BlockLoader.Reader.
Set<String>	sourcePaths(String name)	Find the paths in _source that contain values for the field named name.
Warnings	warnings()	Warnings collector for the block loader.

Field Details

DEFAULT_ORDINALS_BYTE_SIZE

static final ByteSizeValue DEFAULT_ORDINALS_BYTE_SIZE

DEFAULT_SCRIPT_BYTE_SIZE

static final ByteSizeValue DEFAULT_SCRIPT_BYTE_SIZE

Method Details

indexName

String indexName()

The name of the index.

indexSettings

IndexSettings indexSettings()

The index settings of the index

fieldExtractPreference

MappedFieldType.FieldExtractPreference fieldExtractPreference()

How the field should be extracted into the BlockLoader. The default is MappedFieldType.FieldExtractPreference.NONE, which means that the field type can choose where to load the field from. However, in some cases, the caller may have a preference. For example, when loading a spatial field for usage in STATS, it is preferable to load from doc-values.

lookup

SearchLookup lookup()

SearchLookup used for building scripts.

sourcePaths

Set<String> sourcePaths(String name)

Find the paths in _source that contain values for the field named name.

parentField

String parentField(String field)

If field is a leaf multi-field return the path to the parent field. Otherwise, return null.

fieldNames

FieldNamesFieldMapper.FieldNamesFieldType fieldNames()

The _field_names field mapper, mostly used to check if it is enabled.

mappingLookup

MappingLookup mappingLookup()

MappingLookup for the queried index.

blockLoaderFunctionConfig

@Nullable
BlockLoaderFunctionConfig blockLoaderFunctionConfig()

warnings

@Nullable
Warnings warnings()

Warnings collector for the block loader. May be null if warnings are not supported.

ordinalsByteSize

ByteSizeValue ordinalsByteSize()

Number of bytes reserved for each ordinals BlockLoader.Reader.

scriptByteSize

ByteSizeValue scriptByteSize()

Number of bytes reserved for each script BlockLoader.Reader.