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

Interface SyntheticRecordPlan

All Superinterfaces:

PlanHashable

@API(INTERNAL)
public interface SyntheticRecordPlan
extends PlanHashable

A plan for generating synthetic records without an explicit starting point. This kind of plan is similar to RecordQueryPlan, in that it takes a store, continuation, and execute properties and produces a cursor of records. However, it is not run as part of ordinary query execution. In other words, while these plans in some sense represent SELECT * FROM synth_type, an actual query to get the same underlying records would be SELECT * FROM t1 JOIN t2 USING k.

Nested Class Summary

Nested classes/interfaces inherited from interface com.apple.foundationdb.record.PlanHashable

PlanHashable.PlanHashKind

Method Summary

Modifier and Type	Method	Description
default RecordCursor<FDBSyntheticRecord>	execute(FDBRecordStore store)	Execute this plan.
RecordCursor<FDBSyntheticRecord>	execute(FDBRecordStore store, byte[] continuation, ExecuteProperties executeProperties)	Execute this plan.

Methods inherited from interface com.apple.foundationdb.record.PlanHashable

planHash, planHash

Method Detail

execute

@Nonnull
RecordCursor<FDBSyntheticRecord> execute(@Nonnull
                                         FDBRecordStore store,
                                         @Nullable
                                         byte[] continuation,
                                         @Nonnull
                                         ExecuteProperties executeProperties)

Execute this plan.

Parameters:

store - record store against which to execute

continuation - continuation from a previous execution of this same plan

executeProperties - limits on execution

Returns:

a cursor of synthetic records

execute

@Nonnull
default RecordCursor<FDBSyntheticRecord> execute(@Nonnull
                                                 FDBRecordStore store)

Execute this plan.

Parameters:

store - record store against which to execute

Returns:

a cursor of synthetic records