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

Query planner classes.

A RecordQueryPlanner transforms a logical RecordQuery into an executable RecordQueryPlan, which can be run against a record store

Interface Summary

Interface	Description
QueryPlanner	A common interface for classes that can plan a RecordQuery into a RecordQueryPlan.

Class Summary

Class	Description
AvailableFields	Represents a subset of the fields available in a stream of records, including partial records.
AvailableFields.FieldData	A pair of a tuple source (key or value) and an index within that tuple source.
IndexKeyValueToPartialRecord	Construct a record from a covering index.
IndexKeyValueToPartialRecord.Builder	A builder for IndexKeyValueToPartialRecord.
PlannableIndexTypes	A wrapper class to identify groups of that behave the same way from the perspective of the planner.
PlanOrderingKey	The keys that order the results from a plan.
QueryPlanInfo	This class holds some additional information regarding the query plan that can be attached to the plan itself, without impacting its structure.
QueryPlanInfo.QueryPlanInfoKey<T>	An implementation of a type-safe Enum.
QueryPlanInfoKeys	Container for QueryPlanInfo.QueryPlanInfoKey static instances used in the planner.
QueryPlanResult	The result of planning a query.
RecordQueryPlanner	The query planner.
RecordQueryPlanner.ScoredPlan
RecordQueryPlannerConfiguration	A set of configuration options for the RecordQueryPlanner.
RecordQueryPlannerConfiguration.Builder	A builder for RecordQueryPlannerConfiguration.
ScanComparisons	A set of Comparisons.Comparison for scanning an index.
ScanComparisons.Builder	A builder for ScanComparisons.
TextScan	Encapsulate the information necessary to scan a text-based index.

Enum Summary

Enum	Description
IndexKeyValueToPartialRecord.TupleSource	Which side of the IndexEntry to take a field from.
QueryPlanner.IndexScanPreference	Preference between index scan and record scan.
ScanComparisons.ComparisonType	The type of a comparison.

Exception Summary

Exception	Description
RecordQueryPlanComplexityException	Exception thrown when a query plan is more complex than the configured limit.