com.orientechnologies.orient.core.sql

Class OCommandExecutorSQLResultsetAbstract

java.lang.Object

com.orientechnologies.common.parser.OBaseParser

com.orientechnologies.orient.core.command.OCommandExecutorAbstract

com.orientechnologies.orient.core.sql.OCommandExecutorSQLAbstract

com.orientechnologies.orient.core.sql.OCommandExecutorSQLResultsetAbstract

All Implemented Interfaces:

OCommandDistributedReplicateRequest, OCommandExecutor, OIterableRecordSource, Iterable<OIdentifiable>

Direct Known Subclasses:

OCommandExecutorSQLEarlyResultsetAbstract, OCommandExecutorSQLSelect, OCommandExecutorSQLTraverse

public abstract class OCommandExecutorSQLResultsetAbstract
extends OCommandExecutorSQLAbstract
implements OCommandDistributedReplicateRequest, Iterable<OIdentifiable>, OIterableRecordSource

Executes a TRAVERSE crossing records. Returns a List containing all the traversed records that match the WHERE condition.

SYNTAX: TRAVERSE * FROM WHERE

In the command context you've access to the variable $depth containing the depth level from the root node. This is useful to limit the traverse up to a level. For example to consider from the first depth level (0 is root node) to the third use: TRAVERSE children FROM #5:23 WHERE $depth BETWEEN 1 AND 3. To filter traversed records use it combined with a SELECT statement:

SELECT FROM (TRAVERSE children FROM #5:23 WHERE $depth BETWEEN 1 AND 3) WHERE city.name = 'Rome'

Author:

Luca Garulli (l.garulli--(at)--orientdb.com)

Nested Class Summary

Nested classes/interfaces inherited from interface com.orientechnologies.orient.core.command.OCommandDistributedReplicateRequest

OCommandDistributedReplicateRequest.DISTRIBUTED_EXECUTION_MODE, OCommandDistributedReplicateRequest.DISTRIBUTED_RESULT_MGMT, OCommandDistributedReplicateRequest.QUORUM_TYPE

Field Summary

Fields

Modifier and Type	Field and Description
protected OSQLFilter	compiledFilter
protected static String	KEYWORD_FROM_2FIND
protected static String	KEYWORD_LET_2FIND
protected boolean	lazyIteration
protected Map<String,Object>	let
protected OSQLTarget	parsedTarget
protected OSQLAsynchQuery<ODocument>	request
protected int	resultCount
protected AtomicInteger	serialTempRID
protected int	skip
protected Iterator<? extends OIdentifiable>	target
protected Iterable<OIdentifiable>	tempResult

Fields inherited from class com.orientechnologies.orient.core.sql.OCommandExecutorSQLAbstract

CLASS_PREFIX, CLUSTER_PREFIX, DEFAULT_PARAM_USER, DICTIONARY_PREFIX, INDEX_PREFIX, INDEX_VALUES_ASC_PREFIX, INDEX_VALUES_DESC_PREFIX, INDEX_VALUES_PREFIX, KEYWORD_FROM, KEYWORD_KEY, KEYWORD_LET, KEYWORD_LIMIT, KEYWORD_LOCK, KEYWORD_OFFSET, KEYWORD_RETURN, KEYWORD_RID, KEYWORD_SKIP, KEYWORD_TIMEOUT, KEYWORD_UNSAFE, KEYWORD_WHERE, METADATA_DATABASE, METADATA_INDEXMGR, METADATA_PREFIX, METADATA_SCHEMA, METADATA_STORAGE, preParsedStatement, timeoutMs, timeoutStrategy

Fields inherited from class com.orientechnologies.orient.core.command.OCommandExecutorAbstract

context, limit, parameters, progressListener

Fields inherited from class com.orientechnologies.common.parser.OBaseParser

parserText, parserTextUpperCase

Constructor Summary

Constructors

Constructor and Description
OCommandExecutorSQLResultsetAbstract()

Method Summary

Modifier and Type	Method and Description
protected void	applyLimitAndSkip()
protected void	assignLetClauses(ORecord iRecord)
protected boolean	assignTarget(Map<Object,Object> iArgs) Assign the right TARGET if found.
protected boolean	evaluateRecord(ORecord iRecord, OCommandContext iContext)
protected boolean	filter(ORecord iRecord, OCommandContext iContext)
OCommandDistributedReplicateRequest.DISTRIBUTED_EXECUTION_MODE	getDistributedExecutionMode() The command is replicated
OCommandDistributedReplicateRequest.DISTRIBUTED_RESULT_MGMT	getDistributedResultManagement() Returns how to manage the distributed result between: CHECK_FOR_EQUALS: all results must be the same MERGE: merges results.
protected ORID[]	getRange()
protected Object	getResult()
protected Object	getResultInstance()
Iterator<? extends OIdentifiable>	getTarget()
protected boolean	handleResult(OIdentifiable iRecord, OCommandContext iContext)
boolean	isCacheable() Returns true if the command results can be cached.
boolean	isIdempotent() Returns true if the command doesn't change the database, otherwise false.
boolean	isLazyIteration()
protected boolean	isUseCache()
Object	mergeResults(Map<String,Object> results)
protected void	optimize() Optimizes the condition tree.
protected void	optimizeBranch(OSQLFilterCondition iParentCondition, OSQLFilterCondition iCondition)
protected Object	optimizeFunction(OSQLFunctionRuntime function) Check function arguments and pre calculate it if possible
OCommandExecutorSQLResultsetAbstract	parse(OCommandRequest iRequest) Compile the filter conditions only the first time.
protected void	parseLet()
protected int	parseLimit(String w) Parses the limit keyword if found.
protected int	parseSkip(String w) Parses the skip keyword if found.
protected boolean	pushResult(Object rec)
protected void	searchInClasses()
protected void	searchInClasses(boolean iAscendentOrder)
protected Iterator<? extends OIdentifiable>	searchInClasses(OClass iCls, boolean iPolymorphic, boolean iAscendentOrder)
protected void	searchInClusters()
void	setCompiledFilter(OSQLFilter compiledFilter)
void	setLazyIteration(boolean lazyIteration)
void	setParsedTarget(OSQLTarget parsedTarget)
void	setRequest(OSQLAsynchQuery<ODocument> request)
void	setTarget(Iterator<? extends OIdentifiable> target)

Methods inherited from class com.orientechnologies.orient.core.sql.OCommandExecutorSQLAbstract

bindDefaultContextVariables, checkClusterAccess, decodeClassName, getInvolvedClustersOfClasses, getInvolvedClustersOfClusters, getInvolvedClustersOfIndex, parseLock, parseTimeout, preParse, throwParsingException, throwParsingException, throwSyntaxErrorException

Methods inherited from class com.orientechnologies.orient.core.command.OCommandExecutorAbstract

checkInterruption, checkInterruption, getContext, getDatabase, getDistributedTimeout, getFetchPlan, getInvolvedClusters, getLimit, getParameters, getProgressListener, getSecurityOperationType, getUndoCommand, init, involveSchema, isDistributedExecutingOnLocalNodeFirst, isLocalExecution, setContext, setLimit, setProgressListener, toString, upperCase

Methods inherited from class com.orientechnologies.common.parser.OBaseParser

getLastWordLength, getSyntax, getWordStatic, nextWord, nextWord, parseOptionalWord, parserGetCurrentChar, parserGetCurrentPosition, parserGetLastSeparator, parserGetLastWord, parserGetPreviousPosition, parserGoBack, parserIsEnded, parserMoveCurrentPosition, parserNextChars, parserNextWord, parserNextWord, parserNextWord, parserOptionalKeyword, parserOptionalWord, parserRequiredKeyword, parserRequiredWord, parserRequiredWord, parserRequiredWord, parserSetCurrentPosition, parserSetEndOfText, parserSetLastSeparator, parserSkipWhiteSpaces

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.orientechnologies.orient.core.command.OCommandDistributedReplicateRequest

getDistributedTimeout, getQuorumType, getUndoCommand, isDistributedExecutingOnLocalNodeFirst

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface com.orientechnologies.orient.core.sql.OIterableRecordSource

iterator

Methods inherited from interface com.orientechnologies.orient.core.command.OCommandExecutor

execute, getSyntax

Field Detail

KEYWORD_FROM_2FIND

protected static final String KEYWORD_FROM_2FIND

See Also:

Constant Field Values

KEYWORD_LET_2FIND

protected static final String KEYWORD_LET_2FIND

See Also:

Constant Field Values

request

protected OSQLAsynchQuery<ODocument> request

parsedTarget

protected OSQLTarget parsedTarget

compiledFilter

protected OSQLFilter compiledFilter

let

protected Map<String,Object> let

target

protected Iterator<? extends OIdentifiable> target

tempResult

protected Iterable<OIdentifiable> tempResult

resultCount

protected int resultCount

serialTempRID

protected AtomicInteger serialTempRID

skip

protected int skip

lazyIteration

protected boolean lazyIteration

Constructor Detail

OCommandExecutorSQLResultsetAbstract

public OCommandExecutorSQLResultsetAbstract()

Method Detail

parse

public OCommandExecutorSQLResultsetAbstract parse(OCommandRequest iRequest)

Compile the filter conditions only the first time.

Specified by:

parse in interface OCommandExecutor

Parameters:

iRequest - Command request implementation.

Returns:

See Also:

#execute(Map...)

isIdempotent

public boolean isIdempotent()

Description copied from interface: OCommandExecutor

Returns true if the command doesn't change the database, otherwise false.

Specified by:

isIdempotent in interface OCommandExecutor

Overrides:

isIdempotent in class OCommandExecutorSQLAbstract

isLazyIteration

public boolean isLazyIteration()

setLazyIteration

public void setLazyIteration(boolean lazyIteration)

getDistributedExecutionMode

public OCommandDistributedReplicateRequest.DISTRIBUTED_EXECUTION_MODE getDistributedExecutionMode()

Description copied from class: OCommandExecutorSQLAbstract

The command is replicated

Specified by:

getDistributedExecutionMode in interface OCommandDistributedReplicateRequest

Overrides:

getDistributedExecutionMode in class OCommandExecutorSQLAbstract

getDistributedResultManagement

public OCommandDistributedReplicateRequest.DISTRIBUTED_RESULT_MGMT getDistributedResultManagement()

Description copied from interface: OCommandDistributedReplicateRequest

Returns how to manage the distributed result between:

• CHECK_FOR_EQUALS: all results must be the same
• MERGE: merges results. This is typically used on sharding

Specified by:

getDistributedResultManagement in interface OCommandDistributedReplicateRequest

Overrides:

getDistributedResultManagement in class OCommandExecutorAbstract

assignTarget

protected boolean assignTarget(Map<Object,Object> iArgs)

Assign the right TARGET if found.

Parameters:

iArgs - Parameters to bind

Returns:

true if the target has been recognized, otherwise false

getResultInstance

protected Object getResultInstance()

getResult

protected Object getResult()

pushResult

protected boolean pushResult(Object rec)

handleResult

protected boolean handleResult(OIdentifiable iRecord,
                               OCommandContext iContext)

parseLet

protected void parseLet()

parseLimit

protected int parseLimit(String w)
                  throws OCommandSQLParsingException

Parses the limit keyword if found.

Parameters:

w -

Returns:

the limit found as integer, or -1 if no limit is found. -1 means no limits.

Throws:

OCommandSQLParsingException - if no valid limit has been found

parseSkip

protected int parseSkip(String w)
                 throws OCommandSQLParsingException

Parses the skip keyword if found.

Parameters:

w -

Returns:

the skip found as integer, or -1 if no skip is found. -1 means no skip.

Throws:

OCommandSQLParsingException - if no valid skip has been found

filter

protected boolean filter(ORecord iRecord,
                         OCommandContext iContext)

evaluateRecord

protected boolean evaluateRecord(ORecord iRecord,
                                 OCommandContext iContext)

assignLetClauses

protected void assignLetClauses(ORecord iRecord)

searchInClasses

protected void searchInClasses()

searchInClasses

protected void searchInClasses(boolean iAscendentOrder)

searchInClasses

protected Iterator<? extends OIdentifiable> searchInClasses(OClass iCls,
                                                            boolean iPolymorphic,
                                                            boolean iAscendentOrder)

isUseCache

protected boolean isUseCache()

searchInClusters

protected void searchInClusters()

applyLimitAndSkip

protected void applyLimitAndSkip()

optimize

protected void optimize()

Optimizes the condition tree.

optimizeFunction

protected Object optimizeFunction(OSQLFunctionRuntime function)

Check function arguments and pre calculate it if possible

Parameters:

function -

Returns:

optimized function, same function if no change

optimizeBranch

protected void optimizeBranch(OSQLFilterCondition iParentCondition,
                              OSQLFilterCondition iCondition)

getRange

protected ORID[] getRange()

getTarget

public Iterator<? extends OIdentifiable> getTarget()

setTarget

public void setTarget(Iterator<? extends OIdentifiable> target)

setRequest

public void setRequest(OSQLAsynchQuery<ODocument> request)

setParsedTarget

public void setParsedTarget(OSQLTarget parsedTarget)

setCompiledFilter

public void setCompiledFilter(OSQLFilter compiledFilter)

isCacheable

public boolean isCacheable()

Description copied from interface: OCommandExecutor

Returns true if the command results can be cached.

Specified by:

isCacheable in interface OCommandExecutor

Overrides:

isCacheable in class OCommandExecutorAbstract

mergeResults

public Object mergeResults(Map<String,Object> results)
                    throws Exception

Specified by:

mergeResults in interface OCommandExecutor

Overrides:

mergeResults in class OCommandExecutorAbstract

Throws:

Exception