org.hibernate.search.elasticsearch.cfg

Class ElasticsearchEnvironment

java.lang.Object

org.hibernate.search.elasticsearch.cfg.ElasticsearchEnvironment

public final class ElasticsearchEnvironment
extends Object

Configuration properties for Elasticsearch,

Author:

Gunnar Morling

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ElasticsearchEnvironment.Defaults Default values for the different settings if no values are given.

Field Summary

Fields

Modifier and Type	Field and Description
static String	INDEX_MANAGEMENT_WAIT_TIMEOUT Property for specifying the timeout for index management operations (index creation etc.) in milli-seconds.
static String	INDEX_SCHEMA_MANAGEMENT_STRATEGY Property for specifying the strategy for maintaining the Elasticsearch index.
static String	REFRESH_AFTER_WRITE Property for specifying whether an explicit index refresh should be issued after a set of operations targeting a given index has been executed or not.
static String	REQUIRED_INDEX_STATUS Property for specifying the status an index must at least have in order for Hibernate Search to work with it.
static String	SCROLL_BACKTRACKING_WINDOW_SIZE Property for specifying the the minimum number of previous results kept in memory at any time when scrolling.
static String	SCROLL_FETCH_SIZE Property for specifying the the number of results fetched by each Elasticsearch call when scrolling.
static String	SCROLL_TIMEOUT Property for specifying the maximum duration ScrollableResults will be usable if no other results are fetched from Elasticsearch, in seconds.
static String	SERVER_URI Property for specifying the host names and HTTP ports of the Elasticsearch servers to connect to.

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

SERVER_URI

public static final String SERVER_URI

Property for specifying the host names and HTTP ports of the Elasticsearch servers to connect to.

URIs such as http://myeshost.com:9200 are expected, separated by whitespace characters.

Defaults to ElasticsearchEnvironment.Defaults.SERVER_URI.

Multiple servers may be specified for load-balancing: requests will be assigned to each host in turns. Failover is not supported yet.

Can only be given globally (e.g. hibernate.search.default.elasticsearch.host=http://myeshost.com:9200), i.e. only a single Elasticsearch cluster is supported for all the indexed entities. This limitation will be removed in a future version of Hibernate Search.

See Also:

Constant Field Values

INDEX_SCHEMA_MANAGEMENT_STRATEGY

public static final String INDEX_SCHEMA_MANAGEMENT_STRATEGY

Property for specifying the strategy for maintaining the Elasticsearch index.

The name of one of the IndexSchemaManagementStrategy constants is expected, e.g. MERGE.

Can be given globally (e.g. hibernate.search.default.elasticsearch.index_schema_management_strategy=MERGE) or for specific indexes (e.g. hibernate.search.someindex.elasticsearch.index_schema_management_strategy=RECREATE).

See Also:

Constant Field Values

INDEX_MANAGEMENT_WAIT_TIMEOUT

public static final String INDEX_MANAGEMENT_WAIT_TIMEOUT

Property for specifying the timeout for index management operations (index creation etc.) in milli-seconds.

A numeric value such as 1000 is expected.

Defaults to ElasticsearchEnvironment.Defaults.INDEX_MANAGEMENT_WAIT_TIMEOUT ms.

Can be given globally (e.g. hibernate.search.default.elasticsearch.index_management_wait_timeout=5000) or for specific indexes (e.g. hibernate.search.someindex.elasticsearch.index_management_wait_timeout=2000).

See Also:

Constant Field Values

REQUIRED_INDEX_STATUS

public static final String REQUIRED_INDEX_STATUS

Property for specifying the status an index must at least have in order for Hibernate Search to work with it.

One of 'green', 'yellow' or 'red' is expected.

Defaults to ElasticsearchEnvironment.Defaults.REQUIRED_INDEX_STATUS.

Can be given globally (e.g. hibernate.search.default.elasticsearch.required_index_status=green) or for specific indexes (e.g. hibernate.search.someindex.elasticsearch.required_index_status=yellow).

See Also:

Constant Field Values

REFRESH_AFTER_WRITE

public static final String REFRESH_AFTER_WRITE

Property for specifying whether an explicit index refresh should be issued after a set of operations targeting a given index has been executed or not.

A boolean value (true, false) is expected.

Defaults to ElasticsearchEnvironment.Defaults.REFRESH_AFTER_WRITE.

Can be given globally (e.g. hibernate.search.default.elasticsearch.refresh_after_write=false) or for specific indexes (e.g. hibernate.search.someindex.elasticsearch.refresh_after_write=true).

See Also:

Constant Field Values

SCROLL_BACKTRACKING_WINDOW_SIZE

public static final String SCROLL_BACKTRACKING_WINDOW_SIZE

Property for specifying the the minimum number of previous results kept in memory at any time when scrolling.

This determines the number of positions one will be able to scroll backward (backtracking) without starting over the scrolling.

A strictly positive value is expected.

Defaults to ElasticsearchEnvironment.Defaults.SCROLL_BACKTRACKING_WINDOW_SIZE.

Can only be given globally (e.g. hibernate.search.elasticsearch.scroll_backtracking_window_size=10000).

See Also:

Constant Field Values

SCROLL_FETCH_SIZE

public static final String SCROLL_FETCH_SIZE

Property for specifying the the number of results fetched by each Elasticsearch call when scrolling.

A strictly positive value is expected.

Defaults to ElasticsearchEnvironment.Defaults.SCROLL_FETCH_SIZE.

Can only be given globally (e.g. hibernate.search.elasticsearch.scroll_fetch_size=1000).

See Also:

Constant Field Values

SCROLL_TIMEOUT

public static final String SCROLL_TIMEOUT

Property for specifying the maximum duration ScrollableResults will be usable if no other results are fetched from Elasticsearch, in seconds.

A strictly positive value is expected.

Defaults to ElasticsearchEnvironment.Defaults.SCROLL_TIMEOUT.

Can only be given globally (e.g. hibernate.search.elasticsearch.scroll_timeout=60).

See Also:

Constant Field Values