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

Class RecordQueryUnionPlanBase

java.lang.Object

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

All Implemented Interfaces:

PlanHashable, QueryPlan<FDBQueriedRecord<Message>>, RecordQueryPlan, RecordQueryPlanWithChildren, Bindable, Correlated<RelationalExpression>, PlannerGraphRewritable, RelationalExpressionWithChildren, RelationalExpression

Direct Known Subclasses:

RecordQueryUnionPlan, RecordQueryUnorderedUnionPlan

@API(INTERNAL)
public abstract class RecordQueryUnionPlanBase
extends Object
implements RecordQueryPlanWithChildren

Common base class for plans that perform stream union operations.

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
static org.slf4j.Logger	LOGGER
protected static String	UNION

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

UNKNOWN_MAX_CARDINALITY

Constructor Summary

Constructors

Constructor	Description
RecordQueryUnionPlanBase(RecordQueryPlan left, RecordQueryPlan right, boolean reverse)
RecordQueryUnionPlanBase(List<Quantifier.Physical> quantifiers, boolean reverse)

Method Summary

Modifier and Type	Method	Description
protected int	basePlanHash(PlanHashable.PlanHashKind hashKind, ObjectPlanHash baseHash, Object... hashables)	Base implementation of PlanHashable.planHash(com.apple.foundationdb.record.PlanHashable.PlanHashKind).
boolean	equals(Object other)
boolean	equalsWithoutChildren(RelationalExpression otherExpression, AliasMap equivalencesMap)
<M extends Message> RecordCursor<FDBQueriedRecord<M>>	execute(FDBRecordStoreBase<M> store, EvaluationContext context, byte[] continuation, ExecuteProperties executeProperties)	Execute this query plan.
AvailableFields	getAvailableFields()
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.
List<? extends Quantifier>	getQuantifiers()	Return an iterator of references to the children of this planner expression.
int	getRelationalChildCount()
int	hashCode()
int	hashCodeWithoutChildren()
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.
QueryPlan<FDBQueriedRecord<Message>>	strictlySorted()	Return a copy of this plan that has the QueryPlan.isStrictlySorted() property.
String	toString()
abstract RecordQueryUnionPlanBase	withChildren(List<RecordQueryPlan> newChildren)

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, planHash

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

rewritePlannerGraph

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

execute, execute, maxCardinality

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.RecordQueryPlanWithChildren

getUsedIndexes, hasFullRecordScan, hasIndexScan, hasLoadBykeys, hasRecordScan

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

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

getCorrelatedTo, getCorrelatedToWithoutChildren, rebase, rebaseWithRebasedQuantifiers

Field Detail

LOGGER

public static final org.slf4j.Logger LOGGER

UNION

protected static final String UNION

See Also:

Constant Field Values

Constructor Detail

RecordQueryUnionPlanBase

public RecordQueryUnionPlanBase(@Nonnull
                                RecordQueryPlan left,
                                @Nonnull
                                RecordQueryPlan right,
                                boolean reverse)

RecordQueryUnionPlanBase

public RecordQueryUnionPlanBase(@Nonnull
                                List<Quantifier.Physical> quantifiers,
                                boolean reverse)

Method Detail

execute

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

Description copied from interface: RecordQueryPlan

Execute this query plan.

Specified by:

execute in interface RecordQueryPlan

Type Parameters:

M - type used to represent stored records

Parameters:

store - record store from which to fetch records

context - evaluation context containing parameter bindings

continuation - continuation from a previous execution of this same plan

executeProperties - limits on execution

Returns:

a cursor of records that match the query criteria

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

getChildren

@Nonnull
public List<RecordQueryPlan> getChildren()

Description copied from interface: RecordQueryPlan

Returns the (zero or more) 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 QueryPlans. At current, every RecordQueryPlan can only have other RecordQueryPlans 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.

Specified by:

getChildren in interface RecordQueryPlan

Returns:

the child plans

getQuantifiers

@Nonnull
public List<? extends Quantifier> getQuantifiers()

Description copied from interface: RelationalExpression

Return an iterator of references to the children of this planner expression. The iterators returned by different calls are guaranteed to be independent (i.e., advancing one will not advance another). However, they might point to the same object, as when 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.

Specified by:

getQuantifiers in interface RelationalExpression

Returns:

an iterator of references to the children of this planner expression

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

basePlanHash

protected int basePlanHash(@Nonnull
                           PlanHashable.PlanHashKind hashKind,
                           ObjectPlanHash baseHash,
                           Object... hashables)

Base implementation of PlanHashable.planHash(com.apple.foundationdb.record.PlanHashable.PlanHashKind). This implementation makes each concrete subclass implement its own version of PlanHashable.planHash(com.apple.foundationdb.record.PlanHashable.PlanHashKind) so that they are guided to add their own class modifier (See ObjectPlanHash). This implementation is meant to give subclasses common functionality for their own implementation.

Parameters:

hashKind - the plan hash kind to use

baseHash - the subclass' base hash (concrete identifier)

hashables - the rest of the subclass' hashable parameters (if any)

Returns:

the plan hash value calculated

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

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

getRelationalChildCount

public int getRelationalChildCount()

Specified by:

getRelationalChildCount in interface RelationalExpressionWithChildren

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 QueryPlan<FDBQueriedRecord<Message>> 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

withChildren

@Nonnull
public abstract RecordQueryUnionPlanBase withChildren(@Nonnull
                                                      List<RecordQueryPlan> newChildren)