@API(value=MAINTAINED) public class RecordQueryTextIndexPlan extends Object implements RecordQueryPlanWithIndex
Constructor and Description |
---|
RecordQueryTextIndexPlan(String indexName,
TextScan textScan,
boolean reverse) |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object o) |
boolean |
equalsWithoutChildren(PlannerExpression otherExpression) |
<M extends Message> |
executeEntries(FDBRecordStoreBase<M> store,
EvaluationContext context,
byte[] continuation,
ExecuteProperties executeProperties) |
List<RecordQueryPlan> |
getChildren()
Returns the (zero or more)
RecordQueryPlan children of this plan. |
int |
getComplexity()
Returns an integer representing the "complexity" of the generated plan.
|
String |
getIndexName()
Gets the name of the index used by this plan.
|
Iterator<? extends ExpressionRef<? extends PlannerExpression>> |
getPlannerExpressionChildren()
Return an iterator of references to the children of this planner expression.
|
IndexScanType |
getScanType() |
TextScan |
getTextScan() |
Set<String> |
getUsedIndexes()
Returns a set of names of the indexes used by this plan (and its sub-plans).
|
boolean |
hasFullRecordScan()
Indicates whether this plan (or one of its components) must perform a scan over all records in the store directly
rather than going through a secondary index.
|
int |
hashCode() |
boolean |
hasIndexScan(String indexName)
Indicates whether this plan scans the given index.
|
boolean |
hasLoadBykeys()
Indicates whether this plan (or one of its components) loads records by their primary key.
|
boolean |
hasRecordScan()
Indicates whether this plan (or one of its components) scans at least a subset of the record range directly
rather than going through a secondary index.
|
boolean |
isReverse()
Indicates whether this plan will return values in "reverse" order from the
natural order of results of this plan.
|
void |
logPlanStructure(StoreTimer timer)
Adds one to an appropriate
StoreTimer counter for each plan and subplan of this plan, allowing tracking
of which plans are being chosen (e.g. |
int |
planHash()
Return a hash similar to
hashCode , but with the additional guarantee that is is stable across JVMs. |
String |
toString() |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
execute
asNestedWith, asUnnestedWith, execute, execute, execute, getQueryPlanChildren
execute, execute
combineHashes, iterablePlanHash, objectPlanHash, objectsPlanHash, planHash, planHash, planHashUnordered, stringHashUnordered
fromRecordQuery
acceptPropertyVisitor, bindTo
@Nonnull public <M extends Message> RecordCursor<IndexEntry> executeEntries(@Nonnull FDBRecordStoreBase<M> store, @Nonnull EvaluationContext context, @Nullable byte[] continuation, @Nonnull ExecuteProperties executeProperties)
executeEntries
in interface RecordQueryPlanWithIndex
@Nonnull public String getIndexName()
RecordQueryPlanWithIndex
getIndexName
in interface RecordQueryPlanWithIndex
@Nonnull public IndexScanType getScanType()
getScanType
in interface RecordQueryPlanWithIndex
public boolean isReverse()
QueryPlan
true
if the plan
returns elements in descending order and false
if the elements are
returned in ascending order.isReverse
in interface QueryPlan<FDBQueriedRecord<Message>>
true
if this plan returns elements in reverse orderpublic boolean hasRecordScan()
QueryPlan
hasRecordScan
in interface QueryPlan<FDBQueriedRecord<Message>>
true
if this plan (or one of its components) scans at least a subset of the records directlypublic boolean hasFullRecordScan()
QueryPlan
hasRecordScan
for the comparison between two methods.hasFullRecordScan
in interface QueryPlan<FDBQueriedRecord<Message>>
true
if this plan (or one of its components) must perform a scan over all records in the
store directlypublic boolean hasIndexScan(@Nonnull String indexName)
QueryPlan
hasIndexScan
in interface QueryPlan<FDBQueriedRecord<Message>>
indexName
- the name of the index to check fortrue
if this plan (or one of its children) scans the given index@Nonnull public Set<String> getUsedIndexes()
QueryPlan
getUsedIndexes
in interface QueryPlan<FDBQueriedRecord<Message>>
public boolean hasLoadBykeys()
QueryPlan
hasLoadBykeys
in interface QueryPlan<FDBQueriedRecord<Message>>
true
if this plan (or one of its components) loads records by their primary keypublic void logPlanStructure(StoreTimer timer)
QueryPlan
StoreTimer
counter for each plan and subplan of this plan, allowing tracking
of which plans are being chosen (e.g. index scan vs. full scan).logPlanStructure
in interface QueryPlan<FDBQueriedRecord<Message>>
timer
- the counters to incrementpublic int getComplexity()
QueryPlan
getComplexity
in interface QueryPlan<FDBQueriedRecord<Message>>
@Nonnull public List<RecordQueryPlan> getChildren()
RecordQueryPlan
RecordQueryPlan
children of this plan.
Warning: This part of the API is undergoing active development. At some point in the future,
the return type of this method will change to allow it to return a list of generic QueryPlan
s.
At current, every RecordQueryPlan
can only have other RecordQueryPlan
s as children.
However, this is not guaranteed to be the case in the future. This method has been marked as
API.Status#UNSTABLE
as of version 2.5.
getChildren
in interface RecordQueryPlan
@API(value=EXPERIMENTAL) public boolean equalsWithoutChildren(@Nonnull PlannerExpression otherExpression)
equalsWithoutChildren
in interface PlannerExpression
public int planHash()
PlanHashable
hashCode
, but with the additional guarantee that is is stable across JVMs.planHash
in interface PlanHashable
@Nonnull @API(value=EXPERIMENTAL) public Iterator<? extends ExpressionRef<? extends PlannerExpression>> getPlannerExpressionChildren()
PlannerExpression
Collections.emptyIterator()
is returned. The returned iterator should
be treated as an immutable object and may throw an exception if Iterator.remove()
is called.
The iterator must return its elements in a consistent order.getPlannerExpressionChildren
in interface PlannerExpression