org.hibernate.search.backend.lucene.cfg

Class LuceneIndexSettings

java.lang.Object

org.hibernate.search.backend.lucene.cfg.LuceneIndexSettings

public final class LuceneIndexSettings
extends Object

Configuration properties for Lucene indexes.

Constants in this class are to be appended to a prefix to form a property key; see IndexSettings for details.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LuceneIndexSettings.Defaults Default values for the different settings if no values are given.
static class	LuceneIndexSettings.ShardingRadicals Configuration property keys for sharding, without the prefix.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SHARDING_NUMBER_OF_SHARDS The number of shards to create for the index, i.e.
static String	SHARDING_PREFIX The prefix for sharding-related property keys.
static String	SHARDING_SHARD_IDENTIFIERS The list of shard identifiers to accept for the index.
static String	SHARDING_STRATEGY The sharding strategy, deciding the number of shards, their identifiers, and how to translate a routing key into a shard identifier.

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

SHARDING_PREFIX

public static final String SHARDING_PREFIX

The prefix for sharding-related property keys.

See Also:

Constant Field Values

SHARDING_STRATEGY

public static final String SHARDING_STRATEGY

The sharding strategy, deciding the number of shards, their identifiers, and how to translate a routing key into a shard identifier.

Expects a String, such as "hash". See the reference documentation for a list of available values.

Defaults to LuceneIndexSettings.Defaults.SHARDING_STRATEGY (no sharding).

See Also:

Constant Field Values

SHARDING_NUMBER_OF_SHARDS

public static final String SHARDING_NUMBER_OF_SHARDS

The number of shards to create for the index, i.e. the number of "physical" indexes, each holding a part of the index data.

Only available for the "hash" sharding strategy.

Expects a strictly positive Integer value, such as 4, or a String that can be parsed into such Integer value.

No default: this property must be set when using the "hash" sharding strategy.

See Also:

Constant Field Values

SHARDING_SHARD_IDENTIFIERS

public static final String SHARDING_SHARD_IDENTIFIERS

The list of shard identifiers to accept for the index.

Only available for the "explicit" sharding strategy.

Expects either a String containing multiple shard identifiers separated by commas (','), or a Collection<String> containing such shard identifiers.

No default: this property must be set when using the "explicit" sharding strategy.

See Also:

Constant Field Values