Top Description Fields Constructors Methods
org.h2.command.dml

public Class Explain

extends Prepared
Class Inheritance
Imports
java.util.HashSet, .Map, .Map.Entry, .TreeMap, org.h2.command.CommandInterface, .Prepared, org.h2.engine.Database, .DbObject, .SessionLocal, org.h2.expression.Expression, .ExpressionColumn, org.h2.mvstore.db.Store, org.h2.result.LocalResult, .ResultInterface, org.h2.table.Column, org.h2.util.HasSQL, org.h2.value.TypeInfo, .ValueVarchar
This class represents the statement EXPLAIN

Field Summary

Modifier and TypeField and Description
private Prepared
command

Hides org.h2.command.Prepared.command.

private boolean
executeCommand

private LocalResult
result

Inherited from org.h2.command.Prepared:
createparametersprepareAlwayssessionsqlStatementsqlTokens

Constructor Summary

AccessConstructor and Description
public
Explain(SessionLocal session)

Method Summary

Modifier and TypeMethod and Description
private void
add(String text)

protected void
checkParameters()

Overrides org.h2.command.Prepared.checkParameters.

Check if all parameters have been set.

public void
collectDependencies(HashSet<DbObject>
collection of dependencies to populate
dependencies)

Overrides org.h2.command.Prepared.collectDependencies.

Find and collect all DbObjects, this Prepared depends on.

public Prepared
getCommand()

public int
getType()

Implements abstract org.h2.command.Prepared.getType.

Get the command type as defined in CommandInterface

public boolean
isQuery()

Overrides org.h2.command.Prepared.isQuery.

Check if this object is a query.

public boolean
isReadOnly()

Overrides org.h2.command.Prepared.isReadOnly.

Check if this command is read only.

public boolean
isTransactional()

Implements abstract org.h2.command.Prepared.isTransactional.

Check if this command is transactional.

public void
prepare()

Overrides org.h2.command.Prepared.prepare.

Prepare this statement.

public ResultInterface
query(long
the maximum number of rows to return
maxrows)

Overrides org.h2.command.Prepared.query.

Execute the query.

public ResultInterface
queryMeta()

Implements abstract org.h2.command.Prepared.queryMeta.

Get an empty result set containing the meta data.

public void
setCommand(Prepared command)

public void
setExecuteCommand(boolean executeCommand)

Inherited from org.h2.command.Prepared:
checkCanceledgetCurrentRowNumbergetDatabasegetObjectIdgetParametersgetPersistedObjectIdgetPlanSQLgetPlanSQLgetSessiongetSimpleSQLgetSQLgetSQLTokensisCacheableisRetryableisWithParamValuesneedRecompilesetCommandsetCurrentRowNumbersetParameterListsetPersistedObjectIdsetPrepareAlwayssetRowsetSessionsetSQLsetWithParamValuestoStringupdate

Field Detail

commandback to summary
private Prepared command

Hides org.h2.command.Prepared.command.

executeCommandback to summary
private boolean executeCommand
resultback to summary
private LocalResult result

Constructor Detail

Explainback to summary
public Explain(SessionLocal session)

Method Detail

addback to summary
private void add(String text)
checkParametersback to summary
protected void checkParameters()

Overrides org.h2.command.Prepared.checkParameters.

Doc from org.h2.command.Prepared.checkParameters.

Check if all parameters have been set.

Annotations
@Override
collectDependenciesback to summary
public void collectDependencies(HashSet<DbObject> dependencies)

Overrides org.h2.command.Prepared.collectDependencies.

Doc from org.h2.command.Prepared.collectDependencies.

Find and collect all DbObjects, this Prepared depends on.

Parameters
dependencies:HashSet<DbObject>

collection of dependencies to populate

Annotations
@Override
getCommandback to summary
public Prepared getCommand()
getTypeback to summary
public int getType()

Implements abstract org.h2.command.Prepared.getType.

Doc from org.h2.command.Prepared.getType.

Get the command type as defined in CommandInterface

Returns:int

the statement type

Annotations
@Override
isQueryback to summary
public boolean isQuery()

Overrides org.h2.command.Prepared.isQuery.

Doc from org.h2.command.Prepared.isQuery.

Check if this object is a query.

Returns:boolean

true if it is

Annotations
@Override
isReadOnlyback to summary
public boolean isReadOnly()

Overrides org.h2.command.Prepared.isReadOnly.

Doc from org.h2.command.Prepared.isReadOnly.

Check if this command is read only.

Returns:boolean

true if it is

Annotations
@Override
isTransactionalback to summary
public boolean isTransactional()

Implements abstract org.h2.command.Prepared.isTransactional.

Doc from org.h2.command.Prepared.isTransactional.

Check if this command is transactional. If it is not, then it forces the current transaction to commit.

Returns:boolean

true if it is

Annotations
@Override
prepareback to summary
public void prepare()

Overrides org.h2.command.Prepared.prepare.

Doc from org.h2.command.Prepared.prepare.

Prepare this statement.

Annotations
@Override
queryback to summary
public ResultInterface query(long maxrows)

Overrides org.h2.command.Prepared.query.

Doc from org.h2.command.Prepared.query.

Execute the query.

Parameters
maxrows:long

the maximum number of rows to return

Returns:ResultInterface

the result set

Annotations
@Override
queryMetaback to summary
public ResultInterface queryMeta()

Implements abstract org.h2.command.Prepared.queryMeta.

Doc from org.h2.command.Prepared.queryMeta.

Get an empty result set containing the meta data.

Returns:ResultInterface

the result set

Annotations
@Override
setCommandback to summary
public void setCommand(Prepared command)
setExecuteCommandback to summary
public void setExecuteCommand(boolean executeCommand)