org.hibernate.search.elasticsearch.cfg.ElasticsearchEnvironment Maven / Gradle / Ivy
Show all versions of hibernate-search-elasticsearch Show documentation
/*
* Hibernate Search, full-text search for your domain model
*
* License: GNU Lesser General Public License (LGPL), version 2.1 or later
* See the lgpl.txt file in the root directory or .
*/
package org.hibernate.search.elasticsearch.cfg;
/**
* Configuration properties for Elasticsearch,
*
* @author Gunnar Morling
*/
public final class ElasticsearchEnvironment {
/**
* Default values for the different settings if no values are given.
*/
public static final class Defaults {
public static final String SERVER_URI = "http://localhost:9200";
public static final IndexSchemaManagementStrategy INDEX_SCHEMA_MANAGEMENT_STRATEGY = IndexSchemaManagementStrategy.CREATE;
public static final int INDEX_MANAGEMENT_WAIT_TIMEOUT = 10_000;
public static final String REQUIRED_INDEX_STATUS = "green";
public static final boolean REFRESH_AFTER_WRITE = false;
public static final int SCROLL_BACKTRACKING_WINDOW_SIZE = 10_000;
public static final int SCROLL_FETCH_SIZE = 1_000;
public static final int SCROLL_TIMEOUT = 60;
}
/**
* Property for specifying the host name of the Elasticsearch server to connect to. Only a single server (which may
* be part of a cluster) is supported at this point.
*
* An URI such as http://myeshost.com:9200 is expected.
*
* Defaults to {@link Defaults#SERVER_URI}.
*
* Can only be given globally (e.g.
* {@code 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.
*
*/
public static final String SERVER_URI = "elasticsearch.host";
/**
* Property for specifying the strategy for maintaining the Elasticsearch index.
*
* The name of one of the {@link IndexSchemaManagementStrategy} constants is expected, e.g. MERGE.
*
* Can be given globally (e.g. {@code hibernate.search.default.elasticsearch.index_schema_management_strategy=MERGE}) or
* for specific indexes (e.g. {@code hibernate.search.someindex.elasticsearch.index_schema_management_strategy=RECREATE}).
*/
public static final String INDEX_SCHEMA_MANAGEMENT_STRATEGY = "elasticsearch.index_schema_management_strategy";
/**
* 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 {@link Defaults#INDEX_MANAGEMENT_WAIT_TIMEOUT} ms.
*
* Can be given globally (e.g. {@code hibernate.search.default.elasticsearch.index_management_wait_timeout=5000}) or
* for specific indexes (e.g. {@code hibernate.search.someindex.elasticsearch.index_management_wait_timeout=2000}).
*/
public static final String INDEX_MANAGEMENT_WAIT_TIMEOUT = "elasticsearch.index_management_wait_timeout";
/**
* 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 {@link Defaults#REQUIRED_INDEX_STATUS}.
*
* Can be given globally (e.g. {@code hibernate.search.default.elasticsearch.required_index_status=green}) or for
* specific indexes (e.g. {@code hibernate.search.someindex.elasticsearch.required_index_status=yellow}).
*/
public static final String REQUIRED_INDEX_STATUS = "elasticsearch.required_index_status";
/**
* 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 {@link Defaults#REFRESH_AFTER_WRITE}.
*
* Can be given globally (e.g. {@code hibernate.search.default.elasticsearch.refresh_after_write=false}) or for
* specific indexes (e.g. {@code hibernate.search.someindex.elasticsearch.refresh_after_write=true}).
*/
public static final String REFRESH_AFTER_WRITE = "elasticsearch.refresh_after_write";
/**
* 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 {@link Defaults#SCROLL_BACKTRACKING_WINDOW_SIZE}.
*
* Can only be given globally (e.g.
* {@code hibernate.search.elasticsearch.scroll_backtracking_window_size=10000}).
*/
public static final String SCROLL_BACKTRACKING_WINDOW_SIZE = "elasticsearch.scroll_backtracking_window_size";
/**
* Property for specifying the the number of results fetched by each Elasticsearch call when scrolling.
*
* A strictly positive value is expected.
*
* Defaults to {@link Defaults#SCROLL_FETCH_SIZE}.
*
* Can only be given globally (e.g.
* {@code hibernate.search.elasticsearch.scroll_fetch_size=1000}).
*/
public static final String SCROLL_FETCH_SIZE = "elasticsearch.scroll_fetch_size";
/**
* Property for specifying the maximum duration {@code ScrollableResults} will be usable if no
* other results are fetched from Elasticsearch, in seconds.
*
* A strictly positive value is expected.
*
* Defaults to {@link Defaults#SCROLL_TIMEOUT}.
*
* Can only be given globally (e.g.
* {@code hibernate.search.elasticsearch.scroll_timeout=60}).
*/
public static final String SCROLL_TIMEOUT = "elasticsearch.scroll_timeout";
private ElasticsearchEnvironment() {
}
}