Interface IndexQueryabilityFilter
-
- Functional Interface:
- This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
@API(EXPERIMENTAL) @FunctionalInterface public interface IndexQueryabilityFilter
A filter used to determine whether an index should be considered when planning queries.
-
-
Field Summary
Fields Modifier and Type Field Description static IndexQueryabilityFilter
DEFAULT
The default index queryability filter which uses all indexes except those with theIndexOptions.ALLOWED_FOR_QUERY_OPTION
set tofalse
.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description boolean
isQueryable(Index index)
Return whether the given index should be considered by the query planner.
-
-
-
Field Detail
-
DEFAULT
static final IndexQueryabilityFilter DEFAULT
The default index queryability filter which uses all indexes except those with theIndexOptions.ALLOWED_FOR_QUERY_OPTION
set tofalse
.
-
-
Method Detail
-
isQueryable
boolean isQueryable(@Nonnull Index index)
Return whether the given index should be considered by the query planner. Note that the planner is not required to use an index for whichisQueryable()
istrue
.- Parameters:
index
- an index- Returns:
- whether the given index should be considered by the planner
-
-