Package com.apple.foundationdb.record.query.plan.plans

Class RecordQueryIndexPlan

java.lang.Object

com.apple.foundationdb.record.query.plan.plans.RecordQueryIndexPlan

All Implemented Interfaces:

PlanHashable, QueryPlan<FDBQueriedRecord<Message>>, RecordQueryPlan, RecordQueryPlanWithComparisons, RecordQueryPlanWithIndex, RecordQueryPlanWithNoChildren, Bindable, Correlated<RelationalExpression>, PlannerGraphRewritable, RelationalExpression

@API(INTERNAL)
public class RecordQueryIndexPlan
extends Object
implements RecordQueryPlanWithNoChildren, RecordQueryPlanWithComparisons, RecordQueryPlanWithIndex, PlannerGraphRewritable

A query plan that outputs records pointed to by entries in a secondary index within some range.

Nested Class Summary

Nested classes/interfaces inherited from interface com.apple.foundationdb.record.query.plan.temp.Correlated

Correlated.BoundEquivalence

Nested classes/interfaces inherited from interface com.apple.foundationdb.record.PlanHashable

PlanHashable.PlanHashKind

Nested classes/interfaces inherited from interface com.apple.foundationdb.record.query.plan.temp.RelationalExpression

RelationalExpression.CombineFunction<R,S>, RelationalExpression.CombinePredicate

Field Summary

Fields

Modifier and Type	Field	Description
protected ScanComparisons	comparisons
protected String	indexName
protected boolean	reverse
protected IndexScanType	scanType
protected boolean	strictlySorted

Fields inherited from interface com.apple.foundationdb.record.query.plan.plans.QueryPlan

UNKNOWN_MAX_CARDINALITY

Constructor Summary

Constructors

Constructor	Description
RecordQueryIndexPlan(String indexName, IndexScanType scanType, ScanComparisons comparisons, boolean reverse)
RecordQueryIndexPlan(String indexName, IndexScanType scanType, ScanComparisons comparisons, boolean reverse, boolean strictlySorted)

Method Summary

Modifier and Type	Method	Description
protected void	appendScanDetails(StringBuilder str)
PlannerGraph	createIndexPlannerGraph(RecordQueryPlan identity, NodeInfo nodeInfo, List<String> additionalDetails, Map<String,Attribute> additionalAttributeMap)	Create a planner graph for better visualization of a query index plan.
boolean	equals(Object other)
boolean	equalsWithoutChildren(RelationalExpression otherExpression, AliasMap equivalencesMap)
<M extends Message> RecordCursor<IndexEntry>	executeEntries(FDBRecordStoreBase<M> store, EvaluationContext context, byte[] continuation, ExecuteProperties executeProperties)
AvailableFields	getAvailableFields()
ScanComparisons	getComparisons()
int	getComplexity()	Returns an integer representing the "complexity" of the generated plan.
Set<CorrelationIdentifier>	getCorrelatedTo()	Returns the set of CorrelationIdentifiers this entity is correlated to.
String	getIndexName()	Gets the name of the index used by this plan.
IndexScanType	getScanType()
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()
int	hashCodeWithoutChildren()
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.
boolean	isStrictlySorted()	Indicates whether the ordering of records from this plan is fully accounted for by its requested sort.
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	maxCardinality(RecordMetaData metaData)	Indicates how many records this plan could possibly return.
int	planHash(PlanHashable.PlanHashKind hashKind)	Return a hash similar to hashCode, but with the additional guarantee that is is stable across JVMs.
RecordQueryIndexPlan	rebase(AliasMap translationMap)	Rebases this and all other objects this objects is composed of using a given translation map.
RecordQueryIndexPlan	strictlySorted()	Return a copy of this plan that has the QueryPlan.isStrictlySorted() property.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.apple.foundationdb.record.PlanHashable

planHash

Methods inherited from interface com.apple.foundationdb.record.query.plan.plans.QueryPlan

execute, execute

Methods inherited from interface com.apple.foundationdb.record.query.plan.plans.RecordQueryPlan

accept, execute, execute, execute, getQueryPlanChildren, structuralEquals, structuralEquals, structuralHashCode

Methods inherited from interface com.apple.foundationdb.record.query.plan.plans.RecordQueryPlanWithIndex

execute, rewritePlannerGraph

Methods inherited from interface com.apple.foundationdb.record.query.plan.plans.RecordQueryPlanWithNoChildren

getChildren, getQuantifiers

Methods inherited from interface com.apple.foundationdb.record.query.plan.temp.RelationalExpression

acceptPropertyVisitor, adjustMatch, bindIdentities, bindTo, canCorrelate, compensate, enumerateUnboundCorrelatedTo, exactlySubsumedBy, findMatches, getResultValues, hasIncompatibleBoundQuantifiers, hasUnboundQuantifiers, match, match, semanticEquals, semanticEquals, semanticHashCode, show, subsumedBy

Field Detail

indexName

@Nonnull
protected final String indexName

scanType

@Nonnull
protected final IndexScanType scanType

comparisons

@Nonnull
protected final ScanComparisons comparisons

reverse

protected final boolean reverse

strictlySorted

protected final boolean strictlySorted

Constructor Detail

RecordQueryIndexPlan

public RecordQueryIndexPlan(@Nonnull
                            String indexName,
                            @Nonnull
                            IndexScanType scanType,
                            @Nonnull
                            ScanComparisons comparisons,
                            boolean reverse,
                            boolean strictlySorted)

RecordQueryIndexPlan

public RecordQueryIndexPlan(@Nonnull
                            String indexName,
                            @Nonnull
                            IndexScanType scanType,
                            @Nonnull
                            ScanComparisons comparisons,
                            boolean reverse)

Method Detail

executeEntries

@Nonnull
public <M extends Message> RecordCursor<IndexEntry> executeEntries(@Nonnull
                                                                   FDBRecordStoreBase<M> store,
                                                                   @Nonnull
                                                                   EvaluationContext context,
                                                                   @Nullable
                                                                   byte[] continuation,
                                                                   @Nonnull
                                                                   ExecuteProperties executeProperties)

Specified by:

executeEntries in interface RecordQueryPlanWithIndex

getIndexName

@Nonnull
public String getIndexName()

Description copied from interface: RecordQueryPlanWithIndex

Gets the name of the index used by this plan.

Specified by:

getIndexName in interface RecordQueryPlanWithIndex

Returns:

the name of the index used by this plan

getComparisons

@Nonnull
public ScanComparisons getComparisons()

Specified by:

getComparisons in interface RecordQueryPlanWithComparisons

getScanType

@Nonnull
public IndexScanType getScanType()

Specified by:

getScanType in interface RecordQueryPlanWithIndex

isReverse

public boolean isReverse()

Description copied from interface: QueryPlan

Indicates whether this plan will return values in "reverse" order from the natural order of results of this plan. The return value is true if the plan returns elements in descending order and false if the elements are returned in ascending order.

Specified by:

isReverse in interface QueryPlan<FDBQueriedRecord<Message>>

Returns:

true if this plan returns elements in reverse order

hasRecordScan

public boolean hasRecordScan()

Description copied from interface: QueryPlan

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. A plan may only scan over a subset of all records. Someone might not use any secondary indexes explicitly, but they might make use of the primary key index. For example, if they had a compound primary key, and they issued a query for all records that had some value for the first element of their primary key, the planner will produce a plan which scans over a subset of all records.

Specified by:

hasRecordScan in interface QueryPlan<FDBQueriedRecord<Message>>

Returns:

true if this plan (or one of its components) scans at least a subset of the records directly

hasFullRecordScan

public boolean hasFullRecordScan()

Description copied from interface: QueryPlan

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. See hasRecordScan for the comparison between two methods.

Specified by:

hasFullRecordScan in interface QueryPlan<FDBQueriedRecord<Message>>

Returns:

true if this plan (or one of its components) must perform a scan over all records in the store directly

hasIndexScan

public boolean hasIndexScan(@Nonnull
                            String indexName)

Description copied from interface: QueryPlan

Indicates whether this plan scans the given index.

Specified by:

hasIndexScan in interface QueryPlan<FDBQueriedRecord<Message>>

Parameters:

indexName - the name of the index to check for

Returns:

true if this plan (or one of its children) scans the given index

getUsedIndexes

@Nonnull
public Set<String> getUsedIndexes()

Description copied from interface: QueryPlan

Returns a set of names of the indexes used by this plan (and its sub-plans).

Specified by:

getUsedIndexes in interface QueryPlan<FDBQueriedRecord<Message>>

Returns:

an set of indexes used by this plan

maxCardinality

public int maxCardinality(@Nonnull
                          RecordMetaData metaData)

Description copied from interface: QueryPlan

Indicates how many records this plan could possibly return.

Specified by:

maxCardinality in interface QueryPlan<FDBQueriedRecord<Message>>

Parameters:

metaData - meta-data to use to determine things like index uniqueness

Returns:

the maximum number of records or QueryPlan.UNKNOWN_MAX_CARDINALITY if not known

isStrictlySorted

public boolean isStrictlySorted()

Description copied from interface: QueryPlan

Indicates whether the ordering of records from this plan is fully accounted for by its requested sort. That is, each new record will have a different value for that sort key.

Specified by:

isStrictlySorted in interface QueryPlan<FDBQueriedRecord<Message>>

Returns:

true if this plan is fully sorted according to the query definition

strictlySorted

public RecordQueryIndexPlan strictlySorted()

Description copied from interface: QueryPlan

Return a copy of this plan that has the QueryPlan.isStrictlySorted() property.

Specified by:

strictlySorted in interface QueryPlan<FDBQueriedRecord<Message>>

Returns:

a copy of this plan

hasLoadBykeys

public boolean hasLoadBykeys()

Description copied from interface: QueryPlan

Indicates whether this plan (or one of its components) loads records by their primary key.

Specified by:

hasLoadBykeys in interface QueryPlan<FDBQueriedRecord<Message>>

Returns:

true if this plan (or one of its components) loads records by their primary key

getCorrelatedTo

@Nonnull
public Set<CorrelationIdentifier> getCorrelatedTo()

Description copied from interface: Correlated

Returns the set of CorrelationIdentifiers this entity is correlated to. This means that without a process that binds these correlations to values, the RelationalExpression (or others that implement this interface) cannot even in principle produce a meaningful result. As often times entities that implement this interface use composition and effectively describe trees or DAGs, this method should be the set union of the CorrelationIdentifiers this object is correlated to as well as all children, constituent parts, etc.

Specified by:

getCorrelatedTo in interface Correlated<RelationalExpression>

Returns:

the set of CorrelationIdentifiers this entity is correlated to

rebase

@Nonnull
public RecordQueryIndexPlan rebase(@Nonnull
                                   AliasMap translationMap)

Description copied from interface: Correlated

Rebases this and all other objects this objects is composed of using a given translation map.

Specified by:

rebase in interface Correlated<RelationalExpression>

Parameters:

translationMap - a map defining a translation from CorrelationIdentifiers ids to CorrelationIdentifiers ids'. After the rebase, every correlation to an id contained ids that is contained or referred to directly or indirectly by this must have been transformed to use the mapped counterpart of id id' in ids'. IDs not contained in the translation map must remain unmodified by the rebase operation.

Returns:

a new entity that has been rebased

getAvailableFields

@Nonnull
public AvailableFields getAvailableFields()

Specified by:

getAvailableFields in interface RecordQueryPlan

equalsWithoutChildren

public boolean equalsWithoutChildren(@Nonnull
                                     RelationalExpression otherExpression,
                                     @Nonnull
                                     AliasMap equivalencesMap)

Specified by:

equalsWithoutChildren in interface RelationalExpression

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

hashCodeWithoutChildren

public int hashCodeWithoutChildren()

Specified by:

hashCodeWithoutChildren in interface RelationalExpression

planHash

public int planHash(@Nonnull
                    PlanHashable.PlanHashKind hashKind)

Description copied from interface: PlanHashable

Return a hash similar to hashCode, but with the additional guarantee that is is stable across JVMs.

Specified by:

planHash in interface PlanHashable

Parameters:

hashKind - the "kind" of hash to calculate. Each kind of hash has a particular logic with regards to included and excluded items.

Returns:

a stable hash code

toString

@Nonnull
public String toString()

Overrides:

toString in class Object

logPlanStructure

public void logPlanStructure(StoreTimer timer)

Description copied from interface: QueryPlan

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. index scan vs. full scan).

Specified by:

logPlanStructure in interface QueryPlan<FDBQueriedRecord<Message>>

Parameters:

timer - the counters to increment

appendScanDetails

protected void appendScanDetails(StringBuilder str)

getComplexity

public int getComplexity()

Description copied from interface: QueryPlan

Returns an integer representing the "complexity" of the generated plan. Currently, this should simply be the number of plans in the plan tree with this plan as the root (i.e. the number of descendants of this plan, including itself).

Specified by:

getComplexity in interface QueryPlan<FDBQueriedRecord<Message>>

Returns:

the complexity of this plan

createIndexPlannerGraph

@Nonnull
public PlannerGraph createIndexPlannerGraph(@Nonnull
                                            RecordQueryPlan identity,
                                            @Nonnull
                                            NodeInfo nodeInfo,
                                            @Nonnull
                                            List<String> additionalDetails,
                                            @Nonnull
                                            Map<String,Attribute> additionalAttributeMap)

Create a planner graph for better visualization of a query index plan.

Specified by:

createIndexPlannerGraph in interface RecordQueryPlanWithIndex

Parameters:

identity - identity of the node representing the index scan, may be this or some other plan object

nodeInfo - node info to determine the actul flavor of index scan

additionalDetails - additional details to be kept with the index scan node

additionalAttributeMap - additional attributes to be kept with the index scan node

Returns:

the rewritten planner graph that models the index as a separate node that is connected to the actual index scan plan node.