Class IndexOptions
- java.lang.Object
-
- com.apple.foundationdb.record.metadata.IndexOptions
-
@API(MAINTAINED) public class IndexOptions extends Object
The standard options for use withIndex
. 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 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 String
BITMAP_VALUE_ENTRY_SIZE_OPTION
Size of each position bitmap forIndexTypes.BITMAP_VALUE
indexes.static Map<String,String>
EMPTY_OPTIONS
No options.static Map<String,String>
NOT_ALLOWED_FOR_QUERY_OPTIONS
Options to set to disableALLOWED_FOR_QUERY_OPTION
.static String
RANK_COUNT_DUPLICATES
Whether duplicate keys count separtely in theIndexTypes.RANK
skip listRankedSet
.static String
RANK_HASH_FUNCTION
The hash function to use in theIndexTypes.RANK
skip listRankedSet
.static String
RANK_NLEVELS
The number of levels in theIndexTypes.RANK
skip listRankedSet
.static String
TEXT_ADD_AGGRESSIVE_CONFLICT_RANGES_OPTION
If"true"
, aIndexTypes.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"
, aIndexTypes.TEXT
index will not store position numbers for tokens.static String
TEXT_TOKENIZER_NAME_OPTION
The name of theTextTokenizer
to use with aIndexTypes.TEXT
index.static String
TEXT_TOKENIZER_VERSION_OPTION
The version of theTextTokenizer
to use with aIndexTypes.TEXT
index.static String
UNIQUE_OPTION
If"true"
, index throwsRecordIndexUniquenessViolation
on attempts to store duplicate values.static Map<String,String>
UNIQUE_OPTIONS
Options to set to enableUNIQUE_OPTION
.
-
-
-
Field Detail
-
EMPTY_OPTIONS
public static final Map<String,String> EMPTY_OPTIONS
No options. The default for a newIndex
.
-
UNIQUE_OPTION
public static final String UNIQUE_OPTION
If"true"
, index throwsRecordIndexUniquenessViolation
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 enableUNIQUE_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.
-
NOT_ALLOWED_FOR_QUERY_OPTIONS
public static final Map<String,String> NOT_ALLOWED_FOR_QUERY_OPTIONS
Options to set to disableALLOWED_FOR_QUERY_OPTION
.
-
TEXT_TOKENIZER_NAME_OPTION
public static final String TEXT_TOKENIZER_NAME_OPTION
The name of theTextTokenizer
to use with aIndexTypes.TEXT
index.- See Also:
- Constant Field Values
-
TEXT_TOKENIZER_VERSION_OPTION
public static final String TEXT_TOKENIZER_VERSION_OPTION
The version of theTextTokenizer
to use with aIndexTypes.TEXT
index.- See Also:
- Constant Field Values
-
TEXT_ADD_AGGRESSIVE_CONFLICT_RANGES_OPTION
@API(EXPERIMENTAL) public static final String TEXT_ADD_AGGRESSIVE_CONFLICT_RANGES_OPTION
If"true"
, aIndexTypes.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"
, aIndexTypes.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 theIndexTypes.RANK
skip listRankedSet
. The default isRankedSet.DEFAULT_LEVELS
= 6.- See Also:
- Constant Field Values
-
RANK_HASH_FUNCTION
public static final String RANK_HASH_FUNCTION
The hash function to use in theIndexTypes.RANK
skip listRankedSet
. The default isRankedSet.DEFAULT_HASH_FUNCTION
.- See Also:
- Constant Field Values
-
RANK_COUNT_DUPLICATES
public static final String RANK_COUNT_DUPLICATES
Whether duplicate keys count separtely in theIndexTypes.RANK
skip listRankedSet
. The default isfalse
.- See Also:
- Constant Field Values
-
BITMAP_VALUE_ENTRY_SIZE_OPTION
public static final String BITMAP_VALUE_ENTRY_SIZE_OPTION
Size of each position bitmap forIndexTypes.BITMAP_VALUE
indexes. The default is10,000
.- See Also:
- Constant Field Values
-
-