com.apple.foundationdb.record.query.plan

Class RecordQueryPlanner

java.lang.Object

com.apple.foundationdb.record.query.plan.RecordQueryPlanner

All Implemented Interfaces:

QueryPlanner

@API(value=STABLE)
public class RecordQueryPlanner
extends Object
implements QueryPlanner

The query planner. Query planning means converting a RecordQuery to a RecordQueryPlan. The plan can use secondary indexes defined in a RecordMetaData to execute the query efficiently.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	RecordQueryPlanner.ScoredPlan

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

QueryPlanner.IndexScanPreference

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_COMPLEXITY_THRESHOLD A limit on the complexity of the plans generated by the planner.

Constructor Summary

Constructors

Constructor and Description
RecordQueryPlanner(RecordMetaData metaData, RecordStoreState recordStoreState)
RecordQueryPlanner(RecordMetaData metaData, RecordStoreState recordStoreState, PlannableIndexTypes indexTypes, StoreTimer timer)
RecordQueryPlanner(RecordMetaData metaData, RecordStoreState recordStoreState, PlannableIndexTypes indexTypes, StoreTimer timer, int complexityThreshold)
RecordQueryPlanner(RecordMetaData metaData, RecordStoreState recordStoreState, StoreTimer timer)
RecordQueryPlanner(RecordMetaData metaData, RecordStoreState recordStoreState, StoreTimer timer, int complexityThreshold)

Method Summary

Modifier and Type	Method and Description
RecordQueryPlannerConfiguration	getConfiguration()
QueryPlanner.IndexScanPreference	getIndexScanPreference() Get whether RecordQueryIndexPlan is preferred over RecordQueryScanPlan even when it does not satisfy any additional conditions.
RecordQueryPlan	plan(RecordQuery query) Create a plan to get the results of the provided query.
RecordQueryPlan	planCoveringAggregateIndex(RecordQuery query, Index index, KeyExpression indexExpr)
RecordQueryPlan	planCoveringAggregateIndex(RecordQuery query, String indexName)
void	setConfiguration(RecordQueryPlannerConfiguration configuration) Set the RecordQueryPlannerConfiguration for this planner.
void	setIndexScanPreference(QueryPlanner.IndexScanPreference indexScanPreference) Set whether RecordQueryIndexPlan is preferred over RecordQueryScanPlan even when it does not satisfy any additional conditions.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_COMPLEXITY_THRESHOLD

public static final int DEFAULT_COMPLEXITY_THRESHOLD

A limit on the complexity of the plans generated by the planner. If the planner generates a query plan that exceeds this complexity, an exception will be thrown. See RecordQueryPlan.getComplexity() for a description of plan complexity.

See Also:

Constant Field Values

Constructor Detail

RecordQueryPlanner

public RecordQueryPlanner(@Nonnull
                          RecordMetaData metaData,
                          @Nonnull
                          RecordStoreState recordStoreState)

RecordQueryPlanner

public RecordQueryPlanner(@Nonnull
                          RecordMetaData metaData,
                          @Nonnull
                          RecordStoreState recordStoreState,
                          @Nullable
                          StoreTimer timer)

RecordQueryPlanner

public RecordQueryPlanner(@Nonnull
                          RecordMetaData metaData,
                          @Nonnull
                          RecordStoreState recordStoreState,
                          @Nonnull
                          PlannableIndexTypes indexTypes,
                          @Nullable
                          StoreTimer timer)

RecordQueryPlanner

public RecordQueryPlanner(@Nonnull
                          RecordMetaData metaData,
                          @Nonnull
                          RecordStoreState recordStoreState,
                          @Nullable
                          StoreTimer timer,
                          int complexityThreshold)

RecordQueryPlanner

public RecordQueryPlanner(@Nonnull
                          RecordMetaData metaData,
                          @Nonnull
                          RecordStoreState recordStoreState,
                          @Nonnull
                          PlannableIndexTypes indexTypes,
                          @Nullable
                          StoreTimer timer,
                          int complexityThreshold)

Method Detail

getIndexScanPreference

@Nonnull
public QueryPlanner.IndexScanPreference getIndexScanPreference()

Get whether RecordQueryIndexPlan is preferred over RecordQueryScanPlan even when it does not satisfy any additional conditions.

Returns:

whether to prefer index scan over record scan

setIndexScanPreference

public void setIndexScanPreference(@Nonnull
                                   QueryPlanner.IndexScanPreference indexScanPreference)

Set whether RecordQueryIndexPlan is preferred over RecordQueryScanPlan even when it does not satisfy any additional conditions. Scanning without an index is more efficient, but will have to skip over unrelated record types. For that reason, it is safer to use an index, except when there is only one record type. If the meta-data has more than one record type but the record store does not, this can be overridden. If a RecordQueryPlannerConfiguration is already set using setConfiguration(RecordQueryPlannerConfiguration) (RecordQueryPlannerConfiguration)} it will be retained, but the IndexScanPreference for the configuration will be replaced with the given preference.

Specified by:

setIndexScanPreference in interface QueryPlanner

Parameters:

indexScanPreference - whether to prefer index scan over record scan

setConfiguration

public void setConfiguration(@Nonnull
                             RecordQueryPlannerConfiguration configuration)

Set the RecordQueryPlannerConfiguration for this planner. If an QueryPlanner.IndexScanPreference is already set using QueryPlanner.setIndexScanPreference(IndexScanPreference) then it will be ignored.

Parameters:

configuration - a configuration object for this planner

getConfiguration

@Nonnull
public RecordQueryPlannerConfiguration getConfiguration()

plan

@Nonnull
public RecordQueryPlan plan(@Nonnull
                                     RecordQuery query)

Create a plan to get the results of the provided query.

Specified by:

plan in interface QueryPlanner

Parameters:

query - a query for records on this planner's metadata

Returns:

a plan that will return the results of the provided query when executed

Throws:

RecordCoreException - if there is no index that matches the sort in the provided query

planCoveringAggregateIndex

@Nullable
public RecordQueryPlan planCoveringAggregateIndex(@Nonnull
                                                            RecordQuery query,
                                                            @Nonnull
                                                            String indexName)

planCoveringAggregateIndex

@Nullable
public RecordQueryPlan planCoveringAggregateIndex(@Nonnull
                                                            RecordQuery query,
                                                            @Nonnull
                                                            Index index,
                                                            @Nonnull
                                                            KeyExpression indexExpr)