io.redisearch.client

Class Client.IndexOptions

java.lang.Object

io.redisearch.client.Client.IndexOptions

Enclosing class:

Client

public static class Client.IndexOptions
extends Object

IndexOptions encapsulates flags for index creation and should be given to the client on index creation

Since:

2.0

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_FLAGS
static int	KEEP_FIELD_FLAGS If set (default), we keep flags per index record telling us what fields the term appeared on, and allowing us to filter results by field
static int	KEEP_TERM_FREQUENCIES With each document:term record, store how often the term appears within the document.
static int	USE_TERM_OFFSETS Set this to tell the index not to save term offset vectors.

Constructor Summary

Constructors

Constructor and Description
IndexOptions(int flags) Default constructor

Method Summary

Modifier and Type	Method and Description
static Client.IndexOptions	Default() Deprecated. use defaultOptions() instead
static Client.IndexOptions	defaultOptions() The default indexing options - use term offsets and keep fields flags
IndexDefinition	getDefinition()
void	serializeRedisArgs(List<String> args)
Client.IndexOptions	setDefinition(IndexDefinition definition)
Client.IndexOptions	setNoStopwords() Set the index to contain no stopwords, overriding the default list
Client.IndexOptions	SetNoStopwords() Deprecated. Use setNoStopwords() instead
Client.IndexOptions	setStopwords(String... stopwords) Set a custom stopword list
Client.IndexOptions	SetStopwords(String... stopwords) Deprecated. use setStopwords(String...) instead
Client.IndexOptions	setTemporary(long expire) Temporary

Methods inherited from class java.lang.Object

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

Field Detail

USE_TERM_OFFSETS

public static final int USE_TERM_OFFSETS

Set this to tell the index not to save term offset vectors. This reduces memory consumption but does not allow performing exact matches, and reduces overall relevance of multi-term queries

See Also:

Constant Field Values

KEEP_FIELD_FLAGS

public static final int KEEP_FIELD_FLAGS

If set (default), we keep flags per index record telling us what fields the term appeared on, and allowing us to filter results by field

See Also:

Constant Field Values

KEEP_TERM_FREQUENCIES

public static final int KEEP_TERM_FREQUENCIES

With each document:term record, store how often the term appears within the document. This can be used for sorting documents by their relevance to the given term.

See Also:

Constant Field Values

DEFAULT_FLAGS

public static final int DEFAULT_FLAGS

See Also:

Constant Field Values

Constructor Detail

IndexOptions

public IndexOptions(int flags)

Default constructor

Parameters:

flags - flag mask

Method Detail

defaultOptions

public static Client.IndexOptions defaultOptions()

The default indexing options - use term offsets and keep fields flags

Default

@Deprecated
public static Client.IndexOptions Default()

Deprecated. use defaultOptions() instead

The default indexing options - use term offsets and keep fields flags

setStopwords

public Client.IndexOptions setStopwords(String... stopwords)

Set a custom stopword list

Parameters:

stopwords - the list of stopwords

Returns:

the options object itself, for builder-style construction

SetStopwords

@Deprecated
public Client.IndexOptions SetStopwords(String... stopwords)

Deprecated. use setStopwords(String...) instead

Set a custom stopword list

Parameters:

stopwords - the list of stopwords

Returns:

the options object itself, for builder-style construction

setNoStopwords

public Client.IndexOptions setNoStopwords()

Set the index to contain no stopwords, overriding the default list

Returns:

the options object itself, for builder-style constructions

SetNoStopwords

@Deprecated
public Client.IndexOptions SetNoStopwords()

Deprecated. Use setNoStopwords() instead

Set the index to contain no stopwords, overriding the default list

Returns:

the options object itself, for builder-style constructions

setTemporary

public Client.IndexOptions setTemporary(long expire)

Temporary

Parameters:

expire -

Returns:

IndexOptions

getDefinition

public IndexDefinition getDefinition()

setDefinition

public Client.IndexOptions setDefinition(IndexDefinition definition)

serializeRedisArgs

public void serializeRedisArgs(List<String> args)