Package com.orientechnologies.orient.core.sql

Class OCommandExecutorSQLExplain

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.OCommandExecutorSQLDelegate

com.orientechnologies.orient.core.sql.OCommandExecutorSQLExplain

All Implemented Interfaces:

OCommandDistributedReplicateRequest, OCommandExecutor

public class OCommandExecutorSQLExplain
extends OCommandExecutorSQLDelegate

Explains the execution of a command returning profiling information.

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_EXPLAIN

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

delegate

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
OCommandExecutorSQLExplain()

Method Summary

Modifier and Type	Method	Description
Object	execute(Map<Object,Object> iArgs)	Execute the requested command parsed previously.
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.
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
boolean	isCacheable()	Returns true if the command results can be cached.
OCommandExecutorSQLExplain	parse(OCommandRequest iCommand)	Parse the request.

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

getContext, getDelegate, getDistributedTimeout, getFetchPlan, getInvolvedClusters, getSyntax, isIdempotent, toString

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

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 com.orientechnologies.orient.core.command.OCommandDistributedReplicateRequest

getUndoCommand, isDistributedExecutingOnLocalNodeFirst

Field Details

KEYWORD_EXPLAIN

public static final String KEYWORD_EXPLAIN

See Also:

• Constant Field Values

Constructor Details

OCommandExecutorSQLExplain

public OCommandExecutorSQLExplain()

Method Details

parse

public OCommandExecutorSQLExplain parse(OCommandRequest iCommand)

Description copied from interface: OCommandExecutor

Parse the request. Once parsed the command can be executed multiple times by using the execute() method.

Specified by:

parse in interface OCommandExecutor

Overrides:

parse in class OCommandExecutorSQLDelegate

Parameters:

iCommand - Command request implementation.

Returns:

See Also:

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

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

Overrides:

execute in class OCommandExecutorSQLDelegate

Parameters:

iArgs - Optional variable arguments to pass to the command.

Returns:

See Also:

• OCommandExecutor.parse(OCommandRequest)

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

Overrides:

getQuorumType in class OCommandExecutorSQLDelegate

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

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 OCommandExecutorSQLDelegate