com.apple.foundationdb.record.metadata

Class IndexOptions

java.lang.Object

com.apple.foundationdb.record.metadata.IndexOptions

@API(value=MAINTAINED)
public class IndexOptions
extends Object

The standard options for use with Index. An option key is just a string, so that new ones can be defined outside the Record Layer core.

See Also:

Index.getOptions()

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALLOWED_FOR_QUERY_OPTION If "false", the index is not considered for use in queries, even if enabled, unless requested explicitly.
static Map<String,String>	EMPTY_OPTIONS No options.
static Map<String,String>	NOT_ALLOWED_FOR_QUERY_OPTIONS Options to set to disable ALLOWED_FOR_QUERY_OPTION.
static String	RANK_NLEVELS The number of levels in the IndexTypes.RANK skip list RankedSet.
static String	TEXT_ADD_AGGRESSIVE_CONFLICT_RANGES_OPTION If "true", a IndexTypes.TEXT index will add a conflict range for the whole index to keep the commit size down at the expense of more conflicts.
static String	TEXT_OMIT_POSITIONS_OPTION If "true", a IndexTypes.TEXT index will not store position numbers for tokens.
static String	TEXT_TOKENIZER_NAME_OPTION The name of the TextTokenizer to use with a IndexTypes.TEXT index.
static String	TEXT_TOKENIZER_VERSION_OPTION The version of the TextTokenizer to use with a IndexTypes.TEXT index.
static String	UNIQUE_OPTION If "true", index throws RecordIndexUniquenessViolation on attempts to store duplicate values.
static Map<String,String>	UNIQUE_OPTIONS Options to set to enable UNIQUE_OPTION.

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_OPTIONS

public static final Map<String,String> EMPTY_OPTIONS

No options. The default for a new Index.

UNIQUE_OPTION

public static final String UNIQUE_OPTION

If "true", index throws RecordIndexUniquenessViolation on attempts to store duplicate values.

See Also:

Constant Field Values

UNIQUE_OPTIONS

public static final Map<String,String> UNIQUE_OPTIONS

Options to set to enable UNIQUE_OPTION.

ALLOWED_FOR_QUERY_OPTION

public static final String ALLOWED_FOR_QUERY_OPTION

If "false", the index is not considered for use in queries, even if enabled, unless requested explicitly.

See Also:

RecordQuery.Builder.setAllowedIndexes(java.util.Collection<java.lang.String>), Constant Field Values

NOT_ALLOWED_FOR_QUERY_OPTIONS

public static final Map<String,String> NOT_ALLOWED_FOR_QUERY_OPTIONS

Options to set to disable ALLOWED_FOR_QUERY_OPTION.

TEXT_TOKENIZER_NAME_OPTION

public static final String TEXT_TOKENIZER_NAME_OPTION

The name of the TextTokenizer to use with a IndexTypes.TEXT index.

See Also:

Constant Field Values

TEXT_TOKENIZER_VERSION_OPTION

public static final String TEXT_TOKENIZER_VERSION_OPTION

The version of the TextTokenizer to use with a IndexTypes.TEXT index.

See Also:

Constant Field Values

TEXT_ADD_AGGRESSIVE_CONFLICT_RANGES_OPTION

@API(value=EXPERIMENTAL)
public static final String TEXT_ADD_AGGRESSIVE_CONFLICT_RANGES_OPTION

If "true", a IndexTypes.TEXT index will add a conflict range for the whole index to keep the commit size down at the expense of more conflicts.

See Also:

Constant Field Values

TEXT_OMIT_POSITIONS_OPTION

public static final String TEXT_OMIT_POSITIONS_OPTION

If "true", a IndexTypes.TEXT index will not store position numbers for tokens. It will only be possible to determine that an indexed field contains the token someplace.

See Also:

Constant Field Values

RANK_NLEVELS

public static final String RANK_NLEVELS

The number of levels in the IndexTypes.RANK skip list RankedSet. The default is RankedSet.DEFAULT_LEVELS = 6.

See Also:

Constant Field Values