public interface Indexing
Dataset
.Modifier and Type | Method and Description |
---|---|
<T extends java.lang.Comparable<T>> |
createIndex(CellDefinition<T> cellDefinition,
IndexSettings settings)
Trigger creation of a new index using the given settings over cells of the
given definition.
|
void |
destroyIndex(Index<?> index)
Destroy an index.
|
java.util.Collection<Index<?>> |
getAllIndexes()
Return the current set of indexes.
|
java.util.Collection<Index<?>> |
getLiveIndexes()
Return the current set of live indexes.
|
<T extends java.lang.Comparable<T>> Operation<Index<T>> createIndex(CellDefinition<T> cellDefinition, IndexSettings settings)
The returned Operation
completes normally when the index becomes live,
and is available for use by the system. Exceptional completion is observed
through the Future.get()
methods -- get
throws an
ExecutionException
if the index creation failed.
The cause
from this exception indicates
the reason for the failure. If the arguments to createIndex
prevent
the index from being created, the cause is an IllegalArgumentException
;
if the dataset state prevents the index from being created, the cause is an
IllegalStateException
.
T
- JDK type of the cells to be indexedcellDefinition
- definition of the cells to indexsettings
- index type definitionOperation
representing the creation of the indexvoid destroyIndex(Index<?> index) throws StoreIndexNotFoundException
index
- index to destroyStoreIndexNotFoundException
- if the index does not existjava.util.Collection<Index<?>> getLiveIndexes()
Indexes that have been created, but are not yet live will not be returned.
java.util.Collection<Index<?>> getAllIndexes()