Package com.orientechnologies.orient.core.sql

Class OCommandExecutorSQLSelect

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

com.orientechnologies.orient.core.sql.OCommandExecutorSQLSelect

All Implemented Interfaces:

OCommandDistributedReplicateRequest, OCommandExecutor, OIterableRecordSource, OTemporaryRidGenerator, Iterable<OIdentifiable>

Direct Known Subclasses:

OCommandExecutorSQLLiveSelect

public class OCommandExecutorSQLSelect
extends OCommandExecutorSQLResultsetAbstract
implements OTemporaryRidGenerator

Executes the SQL SELECT statement. the parse() method compiles the query and builds the meta information needed by the execute(). If the query contains the ORDER BY clause, the results are temporary collected internally, then ordered and finally returned all together to the listener.

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	Description
static final String	KEYWORD_ASC
static final String	KEYWORD_BY
static final String	KEYWORD_DESC
static final String	KEYWORD_FETCHPLAN
static final String	KEYWORD_FOREACH
static final String	KEYWORD_GROUP
static final String	KEYWORD_NOCACHE
static final String	KEYWORD_ORDER
static final String	KEYWORD_SELECT
static final String	KEYWORD_UNWIND

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

compiledFilter, KEYWORD_FROM_2FIND, KEYWORD_LET_2FIND, lazyIteration, let, parsedTarget, request, resultCount, serialTempRID, skip, target, 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_DISTRIBUTED, 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	Description
OCommandExecutorSQLSelect()

Method Summary

Modifier and Type	Method	Description
protected boolean	addResult(OIdentifiable iRecord, OCommandContext iContext)
protected boolean	assignTarget(Map<Object,Object> iArgs)	Assign the right TARGET if found.
protected Map<String,Object>	createProjectionFromDefinition()
Object	execute(Map<Object,Object> iArgs)	Execute the requested command parsed previously.
protected void	executeSearch(Map<Object,Object> iArgs)
protected boolean	executeSearchRecord(OIdentifiable id, OCommandContext iContext, boolean callHooks)
protected int	extractProjectionNameSubstringEndPosition(String projection)
String	getFetchPlan()
Set<String>	getInvolvedClusters()	Determine clusters that are used in select operation
Map<String,String>	getProjectionDefinition()
protected ORuntimeResult	getProjectionGroup(Object fieldValue, OCommandContext iContext)
Map<String,Object>	getProjections()
OCommandDistributedReplicateRequest.QUORUM_TYPE	getQuorumType()	Returns the quorum type for the command: NONE: no quorum READ: configured Read quorum WRITE: configured Write quorum ALL: all nodes
String	getSyntax()
int	getTemporaryRIDCounter(OCommandContext iContext)	Returns the temporary RID counter assuring it's unique per query tree.
protected boolean	handleResult(OIdentifiable iRecord, OCommandContext iContext)	Handles the record in result.
boolean	hasGroupBy()
void	initContext()
boolean	isAnyFunctionAggregates()
protected boolean	isUseCache()
Iterator<OIdentifiable>	iterator()
Iterator<OIdentifiable>	iterator(Map<Object,Object> iArgs)
protected boolean	optimizeExecution()
OCommandExecutorSQLSelect	parse(OCommandRequest iRequest)	Compile the filter conditions only the first time.
protected boolean	parseFetchplan(String w)	Parses the fetchplan keyword if found.
protected void	parseGroupBy()
protected boolean	parseNoCache(String w)	Parses the NOCACHE keyword if found.
protected void	parseOrderBy()
protected int	parseProjections()
protected void	parseUnwind()
protected void	reportTip(String iMessage)	Report the tip to the profiler and collect it in context to be reported by tools like Studio
protected void	revertProfiler(OCommandContext iContext, OIndex index, List<Object> keyParams, OIndexDefinition indexDefinition)
protected void	revertSubclassesProfiler(OCommandContext iContext, int num)
protected void	searchInClasses()
void	setFetchLimit(int fetchLimit)
void	setFetchPlan(String fetchPlan)
void	setGroupByFields(List<String> groupByFields)
void	setNoCache(boolean noCache)
void	setOrderedFields(List<OPair<String,String>> orderedFields)
void	setParallel(boolean parallel)
void	setProjectionDefinition(Map<String,String> projectionDefinition)
void	setProjections(Map<String,Object> projections)

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

applyLimitAndSkip, assignLetClauses, evaluateRecord, filter, getDistributedExecutionMode, getDistributedResultManagement, getRange, getResult, getResultInstance, getTarget, isCacheable, isIdempotent, isLazyIteration, mergeResults, optimize, optimizeBranch, optimizeFunction, parseLet, parseLimit, parseSkip, pushResult, searchInClasses, searchInClasses, searchInClusters, setCompiledFilter, setLazyIteration, setParsedTarget, setRequest, setTarget

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, getLimit, getParameters, getProgressListener, getSecurityOperationType, getUndoCommand, init, involveSchema, isDistributedExecutingOnLocalNodeFirst, isLocalExecution, setContext, setLimit, setProgressListener, toString

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

getLastWordLength, 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 java.lang.Iterable

forEach, spliterator

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

getDistributedTimeout, getUndoCommand, isDistributedExecutingOnLocalNodeFirst

Field Details

KEYWORD_SELECT

public static final String KEYWORD_SELECT

See Also:

• Constant Field Values

KEYWORD_ASC

public static final String KEYWORD_ASC

See Also:

• Constant Field Values

KEYWORD_DESC

public static final String KEYWORD_DESC

See Also:

• Constant Field Values

KEYWORD_ORDER

public static final String KEYWORD_ORDER

See Also:

• Constant Field Values

KEYWORD_BY

public static final String KEYWORD_BY

See Also:

• Constant Field Values

KEYWORD_GROUP

public static final String KEYWORD_GROUP

See Also:

• Constant Field Values

KEYWORD_UNWIND

public static final String KEYWORD_UNWIND

See Also:

• Constant Field Values

KEYWORD_FETCHPLAN

public static final String KEYWORD_FETCHPLAN

See Also:

• Constant Field Values

KEYWORD_NOCACHE

public static final String KEYWORD_NOCACHE

See Also:

• Constant Field Values

KEYWORD_FOREACH

public static final String KEYWORD_FOREACH

See Also:

• Constant Field Values

Constructor Details

OCommandExecutorSQLSelect

public OCommandExecutorSQLSelect()

Method Details

hasGroupBy

public boolean hasGroupBy()

isUseCache

protected boolean isUseCache()

Overrides:

isUseCache in class OCommandExecutorSQLResultsetAbstract

parse

public OCommandExecutorSQLSelect parse(OCommandRequest iRequest)

Compile the filter conditions only the first time.

Specified by:

parse in interface OCommandExecutor

Overrides:

parse in class OCommandExecutorSQLResultsetAbstract

Parameters:

iRequest - Command request implementation.

Returns:

See Also:

• #execute(Map<Object, Object>...)

getInvolvedClusters

public Set<String> getInvolvedClusters()

Determine clusters that are used in select operation

Specified by:

getInvolvedClusters in interface OCommandExecutor

Overrides:

getInvolvedClusters in class OCommandExecutorAbstract

Returns:

set of involved cluster names

isAnyFunctionAggregates

public boolean isAnyFunctionAggregates()

Returns:

ture if any of the sql functions perform aggregation, false otherwise

iterator

public Iterator<OIdentifiable> iterator()

Specified by:

iterator in interface Iterable<OIdentifiable>

iterator

public Iterator<OIdentifiable> iterator(Map<Object,Object> iArgs)

Specified by:

iterator in interface OIterableRecordSource

execute

public Object execute(Map<Object,Object> iArgs)

Description copied from interface: OCommandExecutor

Execute the requested command parsed previously.

Specified by:

execute in interface OCommandExecutor

Parameters:

iArgs - Optional variable arguments to pass to the command.

Returns:

See Also:

• OCommandExecutor.parse(OCommandRequest)

getProjections

public Map<String,Object> getProjections()

getSyntax

public String getSyntax()

Specified by:

getSyntax in interface OCommandExecutor

Overrides:

getSyntax in class OBaseParser

getFetchPlan

public String getFetchPlan()

Specified by:

getFetchPlan in interface OCommandExecutor

Overrides:

getFetchPlan in class OCommandExecutorAbstract

executeSearch

protected void executeSearch(Map<Object,Object> iArgs)

assignTarget

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

Description copied from class: OCommandExecutorSQLResultsetAbstract

Assign the right TARGET if found.

Overrides:

assignTarget in class OCommandExecutorSQLResultsetAbstract

Parameters:

iArgs - Parameters to bind

Returns:

true if the target has been recognized, otherwise false

executeSearchRecord

protected boolean executeSearchRecord(OIdentifiable id,
 OCommandContext iContext,
 boolean callHooks)

handleResult

protected boolean handleResult(OIdentifiable iRecord,
 OCommandContext iContext)

Handles the record in result.

Overrides:

handleResult in class OCommandExecutorSQLResultsetAbstract

Parameters:

iRecord - Record to handle

Returns:

false if limit has been reached, otherwise true

getTemporaryRIDCounter

public int getTemporaryRIDCounter(OCommandContext iContext)

Returns the temporary RID counter assuring it's unique per query tree.

Specified by:

getTemporaryRIDCounter in interface OTemporaryRidGenerator

Returns:

Serial as integer

addResult

protected boolean addResult(OIdentifiable iRecord,
 OCommandContext iContext)

reportTip

protected void reportTip(String iMessage)

Report the tip to the profiler and collect it in context to be reported by tools like Studio

getProjectionGroup

protected ORuntimeResult getProjectionGroup(Object fieldValue,
 OCommandContext iContext)

parseGroupBy

protected void parseGroupBy()

parseUnwind

protected void parseUnwind()

parseOrderBy

protected void parseOrderBy()

searchInClasses

protected void searchInClasses()

Overrides:

searchInClasses in class OCommandExecutorSQLResultsetAbstract

parseProjections

protected int parseProjections()

createProjectionFromDefinition

protected Map<String,Object> createProjectionFromDefinition()

extractProjectionNameSubstringEndPosition

protected int extractProjectionNameSubstringEndPosition(String projection)

parseFetchplan

protected boolean parseFetchplan(String w)
                          throws OCommandSQLParsingException

Parses the fetchplan keyword if found.

Throws:

OCommandSQLParsingException

optimizeExecution

protected boolean optimizeExecution()

revertSubclassesProfiler

protected void revertSubclassesProfiler(OCommandContext iContext,
 int num)

revertProfiler

protected void revertProfiler(OCommandContext iContext,
 OIndex index,
 List<Object> keyParams,
 OIndexDefinition indexDefinition)

parseNoCache

protected boolean parseNoCache(String w)
                        throws OCommandSQLParsingException

Parses the NOCACHE keyword if found.

Throws:

OCommandSQLParsingException

initContext

public void initContext()

setProjections

public void setProjections(Map<String,Object> projections)

getProjectionDefinition

public Map<String,String> getProjectionDefinition()

setProjectionDefinition

public void setProjectionDefinition(Map<String,String> projectionDefinition)

setOrderedFields

public void setOrderedFields(List<OPair<String,String>> orderedFields)

setGroupByFields

public void setGroupByFields(List<String> groupByFields)

setFetchLimit

public void setFetchLimit(int fetchLimit)

setFetchPlan

public void setFetchPlan(String fetchPlan)

setParallel

public void setParallel(boolean parallel)

setNoCache

public void setNoCache(boolean noCache)

getQuorumType

public OCommandDistributedReplicateRequest.QUORUM_TYPE getQuorumType()

Description copied from interface: OCommandDistributedReplicateRequest

Returns the quorum type for the command:

• NONE: no quorum
• READ: configured Read quorum
• WRITE: configured Write quorum
• ALL: all nodes

Specified by:

getQuorumType in interface OCommandDistributedReplicateRequest