RecordQueryPlannerConfiguration (fdb-record-layer-core 2.9.128.0 API)

java.lang.Object
- com.apple.foundationdb.record.query.plan.RecordQueryPlannerConfiguration

@API(MAINTAINED)
public class RecordQueryPlannerConfiguration
extends Object

A set of configuration options for the RecordQueryPlanner.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class RecordQueryPlannerConfiguration.Builder
A builder for RecordQueryPlannerConfiguration.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`RecordQueryPlannerConfiguration.Builder`	`asBuilder()`
`static RecordQueryPlannerConfiguration.Builder`	`builder()`
`QueryPlanner.IndexScanPreference`	`getIndexScanPreference()`	Get whether `RecordQueryIndexPlan` is preferred over `RecordQueryScanPlan` even when it does not satisfy any additional conditions.
`boolean`	`shouldAttemptFailedInJoinAsOr()`	Get whether the query planner should attempt to transform IN predicates that can't be implemented using a `RecordQueryInJoinPlan` into an equivalent OR of equality predicates, which might be plannable as a union.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getIndexScanPreference
```
@Nonnull
public QueryPlanner.IndexScanPreference getIndexScanPreference()
```
    Get 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.
    
    Returns:
    
    the index scan preference
  - shouldAttemptFailedInJoinAsOr
```
public boolean shouldAttemptFailedInJoinAsOr()
```
    Get whether the query planner should attempt to transform IN predicates that can't be implemented using a RecordQueryInJoinPlan into an equivalent OR of equality predicates, which might be plannable as a union.
    
    Returns:
    
    whether the planner will transform IN predicates into ORs when they can't be planned as in-joins
  - asBuilder
```
@Nonnull
public RecordQueryPlannerConfiguration.Builder asBuilder()
```
  - builder
```
@Nonnull
public static RecordQueryPlannerConfiguration.Builder builder()
```