Package org.elasticsearch.index.mapper

Class LookupRuntimeFieldType

java.lang.Object

org.elasticsearch.index.mapper.MappedFieldType

org.elasticsearch.index.mapper.LookupRuntimeFieldType

public final class LookupRuntimeFieldType
extends MappedFieldType

A runtime field that retrieves fields from related indices.

 {
     "type": "lookup",
     "target_index": "an_external_index",
     "input_field": "ip_address",
     "target_field": "host_ip",
     "fetch_fields": [
         "field-1",
         "field-2"
     ]
 }
 

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.index.mapper.MappedFieldType

MappedFieldType.CollapseType, MappedFieldType.Relation

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONTENT_TYPE
static final RuntimeField.Parser	PARSER

Method Summary

Modifier and Type	Method	Description
org.apache.lucene.search.Query	termQuery(Object value, SearchExecutionContext context)	Generates a query that will only match documents that contain the given value.
String	typeName()	Returns the name of this type, as would be specified in mapping properties
ValueFetcher	valueFetcher(SearchExecutionContext context, String format)	Create a helper class to fetch field values during the FetchFieldsPhase.

Methods inherited from class org.elasticsearch.index.mapper.MappedFieldType

checkNoFormat, checkNoTimeZone, collapseType, distanceFeatureQuery, docValueFormat, eagerGlobalOrdinals, existsQuery, extractTerm, failIfNoDocValues, failIfNotIndexed, failIfNotIndexedNorDocValuesFallback, familyTypeName, fielddataBuilder, fuzzyIntervals, fuzzyQuery, getMetricType, getTerms, getTextSearchInfo, hasDocValues, isAggregatable, isDimension, isFieldWithinQuery, isIndexed, isSearchable, isStored, mayExistInIndex, meta, multiPhraseQuery, name, normalizedWildcardQuery, phrasePrefixQuery, phraseQuery, pointReaderIfPossible, prefixIntervals, prefixQuery, prefixQuery, rangeQuery, regexpQuery, spanPrefixQuery, termIntervals, termQueryCaseInsensitive, termsQuery, validateMatchedRoutingPath, valueForDisplay, wildcardIntervals, wildcardQuery, wildcardQuery

Methods inherited from class java.lang.Object

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

Field Details

PARSER

public static final RuntimeField.Parser PARSER

CONTENT_TYPE

public static final String CONTENT_TYPE

See Also:

• Constant Field Values

Method Details

valueFetcher

public ValueFetcher valueFetcher(SearchExecutionContext context,
 String format)

Description copied from class: MappedFieldType

Create a helper class to fetch field values during the FetchFieldsPhase. New field types must implement this method in order to support the search 'fields' option. Except for metadata fields, field types should not throw UnsupportedOperationException since this could cause a search retrieving multiple fields (like "fields": ["*"]) to fail.

Specified by:

valueFetcher in class MappedFieldType

typeName

public String typeName()

Description copied from class: MappedFieldType

Returns the name of this type, as would be specified in mapping properties

Specified by:

typeName in class MappedFieldType

termQuery

public org.apache.lucene.search.Query termQuery(Object value,
 SearchExecutionContext context)

Description copied from class: MappedFieldType

Generates a query that will only match documents that contain the given value. The default implementation returns a TermQuery over the value bytes

Specified by:

termQuery in class MappedFieldType