Package org.elasticsearch.action.search

Enum Class SearchType

java.lang.Object

java.lang.Enum<SearchType>

org.elasticsearch.action.search.SearchType

All Implemented Interfaces:

Serializable, Comparable<SearchType>, Constable

public enum SearchType
extends Enum<SearchType>

Search type represent the manner at which the search operation is executed.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DFS_QUERY_THEN_FETCH	Same as QUERY_THEN_FETCH, except for an initial scatter phase which goes and computes the distributed term frequencies for more accurate scoring.
QUERY_THEN_FETCH	The query is executed against all shards, but only enough information is returned (not the document content).

Field Summary

Fields

Modifier and Type	Field	Description
static final SearchType[]	CURRENTLY_SUPPORTED	Non-deprecated types
static final SearchType	DEFAULT	The default search type (QUERY_THEN_FETCH.

Method Summary

Modifier and Type	Method	Description
static SearchType	fromId(byte id)	Constructs search type based on the internal id.
static SearchType	fromString(String searchType)	The a string representation search type to execute, defaults to DEFAULT.
byte	id()	The internal id of the type.
static SearchType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SearchType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

DFS_QUERY_THEN_FETCH

public static final SearchType DFS_QUERY_THEN_FETCH

Same as QUERY_THEN_FETCH, except for an initial scatter phase which goes and computes the distributed term frequencies for more accurate scoring.

QUERY_THEN_FETCH

public static final SearchType QUERY_THEN_FETCH

The query is executed against all shards, but only enough information is returned (not the document content). The results are then sorted and ranked, and based on it, only the relevant shards are asked for the actual document content. The return number of hits is exactly as specified in size, since they are the only ones that are fetched. This is very handy when the index has a lot of shards (not replicas, shard id groups).

Field Details

DEFAULT

public static final SearchType DEFAULT

The default search type (QUERY_THEN_FETCH.

CURRENTLY_SUPPORTED

public static final SearchType[] CURRENTLY_SUPPORTED

Non-deprecated types

Method Details

values

public static SearchType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static SearchType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

id

public byte id()

The internal id of the type.

fromId

public static SearchType fromId(byte id)

Constructs search type based on the internal id.

fromString

public static SearchType fromString(String searchType)

The a string representation search type to execute, defaults to DEFAULT. Can be one of "dfs_query_then_fetch" or "query_then_fetch".