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

Class RecordQueryPlannerConfiguration.Builder

java.lang.Object

com.apple.foundationdb.record.query.plan.RecordQueryPlannerConfiguration.Builder

Enclosing class:

RecordQueryPlannerConfiguration

public static class RecordQueryPlannerConfiguration.Builder
extends Object

A builder for RecordQueryPlannerConfiguration.

Constructor Summary

Constructors

Constructor	Description
Builder()
Builder(RecordQueryPlannerConfiguration configuration)

Method Summary

Modifier and Type	Method	Description
RecordQueryPlannerConfiguration	build()
RecordQueryPlannerConfiguration.Builder	setAttemptFailedInJoinAsOr(boolean attemptFailedInJoinAsOr)
RecordQueryPlannerConfiguration.Builder	setCheckForDuplicateConditions(boolean checkForDuplicateConditions)
RecordQueryPlannerConfiguration.Builder	setComplexityThreshold(int complexityThreshold)
RecordQueryPlannerConfiguration.Builder	setDeferFetchAfterUnionAndIntersection(boolean deferFetchAfterUnionAndIntersection)
RecordQueryPlannerConfiguration.Builder	setIndexScanPreference(QueryPlanner.IndexScanPreference indexScanPreference)
RecordQueryPlannerConfiguration.Builder	setMaxTaskQueueSize(int maxTaskQueueSize)	Set the size limit of the Cascades planner task queue.
RecordQueryPlannerConfiguration.Builder	setMaxTotalTaskCount(int maxTotalTaskCount)	Set a limit on the number of tasks that can be executed as part of the Cascades planner planning.
RecordQueryPlannerConfiguration.Builder	setOptimizeForIndexFilters(boolean optimizeForIndexFilters)
RecordQueryPlannerConfiguration.Builder	setUseFullKeyForValueIndex(boolean useFullKeyForValueIndex)	Set whether the planner uses the entire key, including the primary key, for value indexes.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(@Nonnull
               RecordQueryPlannerConfiguration configuration)

Builder

public Builder()

Method Detail

setIndexScanPreference

public RecordQueryPlannerConfiguration.Builder setIndexScanPreference(@Nonnull
                                                                      QueryPlanner.IndexScanPreference indexScanPreference)

setAttemptFailedInJoinAsOr

public RecordQueryPlannerConfiguration.Builder setAttemptFailedInJoinAsOr(boolean attemptFailedInJoinAsOr)

setComplexityThreshold

public RecordQueryPlannerConfiguration.Builder setComplexityThreshold(int complexityThreshold)

setCheckForDuplicateConditions

public RecordQueryPlannerConfiguration.Builder setCheckForDuplicateConditions(boolean checkForDuplicateConditions)

setDeferFetchAfterUnionAndIntersection

public RecordQueryPlannerConfiguration.Builder setDeferFetchAfterUnionAndIntersection(boolean deferFetchAfterUnionAndIntersection)

setOptimizeForIndexFilters

public RecordQueryPlannerConfiguration.Builder setOptimizeForIndexFilters(boolean optimizeForIndexFilters)

setMaxTaskQueueSize

public RecordQueryPlannerConfiguration.Builder setMaxTaskQueueSize(int maxTaskQueueSize)

Set the size limit of the Cascades planner task queue. If the planner tries to add a task to the queue beyond the maximum size, planning will fail. Default value is 0, which means "unbound".

Parameters:

maxTaskQueueSize - the maximum size of the queue.

Returns:

this builder

setMaxTotalTaskCount

public RecordQueryPlannerConfiguration.Builder setMaxTotalTaskCount(int maxTotalTaskCount)

Set a limit on the number of tasks that can be executed as part of the Cascades planner planning. If the planner tries to execute a task after the maximum number was exceeded, planning will fail. Default value is 0, which means "unbound".

Parameters:

maxTotalTaskCount - the maximum number of tasks.

Returns:

this builder

setUseFullKeyForValueIndex

public RecordQueryPlannerConfiguration.Builder setUseFullKeyForValueIndex(boolean useFullKeyForValueIndex)

Set whether the planner uses the entire key, including the primary key, for value indexes.

Parameters:

useFullKeyForValueIndex - whether to include primary key in planning

Returns:

this builder

build

public RecordQueryPlannerConfiguration build()