com.orientechnologies.orient.core.sql.executor

Interface OExecutionStepInternal

All Superinterfaces:

OExecutionStep

All Known Implementing Classes:

AbstractExecutionStep, AbstractTraverseStep, AbstractUnrollStep, AccumulatingTimeoutStep, AggregateProjectionCalculationStep, BatchStep, BreadthFirstTraverseStep, CartesianProductStep, CastToEdgeStep, CastToVertexStep, CheckClassTypeStep, CheckClusterTypeStep, CheckRecordTypeStep, CheckSafeDeleteStep, ConvertToResultInternalStep, ConvertToUpdatableResultStep, CopyDocumentStep, CopyRecordContentBeforeUpdateStep, CountFromClassStep, CountFromIndexStep, CountFromIndexWithKeyStep, CountStep, CreateEdgesStep, CreateRecordStep, DeleteFromIndexStep, DeleteStep, DepthFirstTraverseStep, DistinctExecutionStep, DistributedExecutionStep, EmptyDataGeneratorStep, EmptyStep, ExpandStep, FetchEdgesFromToVerticesStep, FetchEdgesToVerticesStep, FetchFromClassExecutionStep, FetchFromClusterExecutionStep, FetchFromClustersExecutionStep, FetchFromDatabaseMetadataStep, FetchFromIndexedFunctionStep, FetchFromIndexStep, FetchFromIndexValuesStep, FetchFromRidsStep, FetchFromStorageMetadataStep, FetchFromVariableStep, FetchTemporaryFromTxStep, FilterByClassStep, FilterByClustersStep, FilterNotMatchPatternStep, FilterStep, FindReferencesStep, ForEachStep, GetValueFromIndexEntryStep, GlobalLetExpressionStep, GlobalLetQueryStep, GuaranteeEmptyCountStep, IfStep, InsertIntoIndexStep, InsertValuesStep, LetExpressionStep, LetQueryStep, LimitExecutionStep, LockRecordStep, MatchFirstStep, MatchPrefetchStep, MatchStep, MoveVertexStep, OptionalMatchStep, OrderByStep, ParallelExecStep, ProjectionCalculationStep, RemoveEdgePointersStep, RemoveEmptyOptionalsStep, RetryStep, ReturnMatchElementsStep, ReturnMatchPathElementsStep, ReturnMatchPathsStep, ReturnMatchPatternsStep, ReturnStep, SaveElementStep, ScriptLineStep, SetDocumentClassStep, SkipExecutionStep, SubQueryStep, TimeoutStep, UnwindStep, UnwrapPreviousValueStep, UpdateContentStep, UpdateEdgePointersStep, UpdateMergeStep, UpdateRemoveStep, UpdateSetStep, UpsertStep, WhileMatchStep, WhileStep

public interface OExecutionStepInternal
extends OExecutionStep

Execution Steps are the building blocks of a query execution plan

Typically an execution plan is made of a chain of steps. The execution is pull-based, meaning that the result set that the client iterates is conceptually the one returned by last step of the execution plan

At each `next()` invocation, the step typically fetches a record from the previous (upstream) step, does its elaboration (eg. for a filtering step, it can discard the record and fetch another one if it doesn't match the conditions) and returns the elaborated step

The invocation of syncPull(ctx, nResults) has to return a result set of at most nResults records. If the upstream (the previous steps) return more records, they have to be returned by next call of syncPull(). The returned result set can have less than nResults records ONLY if current step cannot produce any more records (eg. the upstream does not have any more records)

Author:

Luigi Dell'Aquila l.dellaquila - at - orientdb.com

Method Summary

Modifier and Type	Method and Description
static void	basicDeserialize(OResult serialized, OExecutionStepInternal step)
static OResultInternal	basicSerialize(OExecutionStepInternal step)
default boolean	canBeCached()
void	close()
default OExecutionStep	copy(OCommandContext ctx)
default void	deserialize(OResult fromResult)
default String	getDescription()
static String	getIndent(int depth, int indent)
default String	getName()
default List<OExecutionPlan>	getSubExecutionPlans()
default List<OExecutionStep>	getSubSteps()
default String	getTargetNode()
default String	getType()
default String	prettyPrint(int depth, int indent)
default void	reset()
void	sendTimeout()
default OResult	serialize()
void	setNext(OExecutionStepInternal step)
void	setPrevious(OExecutionStepInternal step)
OResultSet	syncPull(OCommandContext ctx, int nRecords)

Methods inherited from interface com.orientechnologies.orient.core.sql.executor.OExecutionStep

getCost, toResult

Method Detail

syncPull

OResultSet syncPull(OCommandContext ctx,
                    int nRecords)
             throws OTimeoutException

Throws:

OTimeoutException

sendTimeout

void sendTimeout()

setPrevious

void setPrevious(OExecutionStepInternal step)

setNext

void setNext(OExecutionStepInternal step)

close

void close()

getIndent

static String getIndent(int depth,
                        int indent)

prettyPrint

default String prettyPrint(int depth,
                           int indent)

getName

default String getName()

Specified by:

getName in interface OExecutionStep

getType

default String getType()

Specified by:

getType in interface OExecutionStep

getDescription

default String getDescription()

Specified by:

getDescription in interface OExecutionStep

getTargetNode

default String getTargetNode()

Specified by:

getTargetNode in interface OExecutionStep

getSubSteps

default List<OExecutionStep> getSubSteps()

Specified by:

getSubSteps in interface OExecutionStep

getSubExecutionPlans

default List<OExecutionPlan> getSubExecutionPlans()

reset

default void reset()

serialize

default OResult serialize()

deserialize

default void deserialize(OResult fromResult)

basicSerialize

static OResultInternal basicSerialize(OExecutionStepInternal step)

basicDeserialize

static void basicDeserialize(OResult serialized,
                             OExecutionStepInternal step)
                      throws ClassNotFoundException,
                             IllegalAccessException,
                             InstantiationException

Throws:

ClassNotFoundException

IllegalAccessException

InstantiationException

copy

default OExecutionStep copy(OCommandContext ctx)

canBeCached

default boolean canBeCached()