Interface IndexMaintenanceFilter
-
@API(MAINTAINED) public interface IndexMaintenanceFilter
A hook for suppressing secondary indexing of some records.- See Also:
FDBRecordStore.indexMaintenanceFilter
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
IndexMaintenanceFilter.IndexValues
Whether to maintain a subset of the indexable values for the given record.
-
Field Summary
Fields Modifier and Type Field Description static IndexMaintenanceFilter
NO_NULLS
Do not putnull
values into the index.static IndexMaintenanceFilter
NORMAL
All records should be added to the index.
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description IndexMaintenanceFilter.IndexValues
maintainIndex(Index index, MessageOrBuilder record)
default boolean
maintainIndexValue(Index index, MessageOrBuilder record, IndexEntry indexEntry)
Get whether a specific index entry should be maintained.
-
-
-
Field Detail
-
NORMAL
static final IndexMaintenanceFilter NORMAL
All records should be added to the index. This is the default behavior.
-
NO_NULLS
static final IndexMaintenanceFilter NO_NULLS
Do not putnull
values into the index.
-
-
Method Detail
-
maintainIndex
IndexMaintenanceFilter.IndexValues maintainIndex(@Nonnull Index index, @Nonnull MessageOrBuilder record)
-
maintainIndexValue
default boolean maintainIndexValue(@Nonnull Index index, @Nonnull MessageOrBuilder record, @Nonnull IndexEntry indexEntry)
Get whether a specific index entry should be maintained. Only called ifSOME
was returned frommaintainIndex(com.apple.foundationdb.record.metadata.Index, com.google.protobuf.MessageOrBuilder)
.- Parameters:
index
- index to checkrecord
- record that led to the index entryindexEntry
- potential entry in the index- Returns:
true
if the given entry should be maintained in the given index
-
-