Interface SyntheticRecordFromStoredRecordPlan
-
- All Superinterfaces:
PlanHashable
@API(INTERNAL) public interface SyntheticRecordFromStoredRecordPlan extends PlanHashable
A plan for deriving synthetic records from a given record. LikeSyntheticRecordPlan
, but with the additionalexecute
-time parameter of a seed record. While the former is used to generate all records to rebuild an index, this plan is used to generate affected records for a changed record to update just for those changes.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default <M extends Message>
RecordCursor<FDBSyntheticRecord>execute(FDBRecordStore store, FDBStoredRecord<M> record)
Execute this plan.<M extends Message>
RecordCursor<FDBSyntheticRecord>execute(FDBRecordStore store, FDBStoredRecord<M> record, byte[] continuation, ExecuteProperties executeProperties)
Execute this plan.Set<String>
getStoredRecordTypes()
Get the possible record types for the stored record to which this plan can be applied.Set<String>
getSyntheticRecordTypes()
Get the possible record types for the synthetic record generated by this plan.-
Methods inherited from interface com.apple.foundationdb.record.PlanHashable
planHash
-
-
-
-
Method Detail
-
getStoredRecordTypes
@Nonnull Set<String> getStoredRecordTypes()
Get the possible record types for the stored record to which this plan can be applied. If given a record whose type is not in this set, the plan may return an empty cursor or throw an exception.- Returns:
- the set of record type names
-
getSyntheticRecordTypes
@Nonnull Set<String> getSyntheticRecordTypes()
Get the possible record types for the synthetic record generated by this plan.- Returns:
- the set of record type names
-
execute
@Nonnull <M extends Message> RecordCursor<FDBSyntheticRecord> execute(@Nonnull FDBRecordStore store, @Nonnull FDBStoredRecord<M> record, @Nullable byte[] continuation, @Nonnull ExecuteProperties executeProperties)
Execute this plan.- Type Parameters:
M
- type of raw record- Parameters:
store
- record store against which to executerecord
- the stored record from which to derive synthetic records, such as by join queriescontinuation
- continuation from a previous execution of this same planexecuteProperties
- limits on execution- Returns:
- a cursor of synthetic records
-
execute
@Nonnull default <M extends Message> RecordCursor<FDBSyntheticRecord> execute(@Nonnull FDBRecordStore store, @Nonnull FDBStoredRecord<M> record)
Execute this plan.- Type Parameters:
M
- type of raw record- Parameters:
store
- record store against which to executerecord
- the stored record from which to derive synthetic records, such as by join queries- Returns:
- a cursor of synthetic records
-
-