io.manbang.ebatis.core.annotation

注释类型 SearchScroll

@Documented
 @Target(value=METHOD)
 @Retention(value=RUNTIME)
public @interface SearchScroll

Scroll API Retrieves the next batch of results for a scrolling search.

从以下版本开始:

2020/6/8 9:24

作者:

章多亮

可选元素概要

可选元素

限定符和类型	可选元素和说明
String	analyzer
boolean	clearScroll Search context are automatically removed when the scroll timeout has been exceeded.
FunctionScore[]	functionScore
String	initialKeepAlive specify the scroll parameter in the query string, which tells Elasticsearch how long it should keep the “search context” alive
String	keepAlive If no scroll value is set for the SearchScrollRequest, the search context will expire once the initial scroll time expired (ie, the scroll time set in the initial search request).
String	preference
QueryType	queryType
org.elasticsearch.action.search.SearchType	searchType

元素详细资料

clearScroll

public abstract boolean clearScroll

Search context are automatically removed when the scroll timeout has been exceeded. However keeping scrolls open has a cost, as discussed in the previous section so scrolls should be explicitly cleared as soon as the scroll is not being used anymore using the clear-scroll API

返回:

if you want to clear scroll, pls return true

默认值:

false

initialKeepAlive

public abstract String initialKeepAlive

specify the scroll parameter in the query string, which tells Elasticsearch how long it should keep the “search context” alive

返回:

initial search request timeout value

另请参阅:

TimeValue

默认值:

"1m"

keepAlive

public abstract String keepAlive

If no scroll value is set for the SearchScrollRequest, the search context will expire once the initial scroll time expired (ie, the scroll time set in the initial search request).

返回:

scroll request timeout value

另请参阅:

TimeValue

默认值:

"1m"

queryType

public abstract QueryType queryType

默认值:

io.manbang.ebatis.core.annotation.QueryType.AUTO

searchType

public abstract org.elasticsearch.action.search.SearchType searchType

默认值:

org.elasticsearch.action.search.SearchType.QUERY_THEN_FETCH

preference

public abstract String preference

默认值:

""

analyzer

public abstract String analyzer

默认值:

""

functionScore

public abstract FunctionScore[] functionScore

默认值:

{}