org.h2.command.dml
Class ExplainPlan

java.lang.Object
  extended by org.h2.command.Prepared
      extended by org.h2.command.dml.ExplainPlan

public class ExplainPlan
extends Prepared

This class represents the statement EXPLAIN


Field Summary
 
Fields inherited from class org.h2.command.Prepared
headPos, parameters, prepareAlways, session, sqlStatement
 
Constructor Summary
ExplainPlan(Session session)
           
 
Method Summary
 boolean isQuery()
          Check if this object is a query.
 boolean isReadOnly()
          Check if this command is read only.
 boolean isTransactional()
          Check if this command is transactional.
 void prepare()
          Prepare this statement.
 LocalResult query(int maxrows)
          Execute the query.
 LocalResult queryMeta()
          Get an empty result set containing the meta data.
 void setCommand(Prepared command)
           
 
Methods inherited from class org.h2.command.Prepared
checkCanceled, checkParameters, getCurrentObjectId, getCurrentRowNumber, getObjectId, getParameters, getPlanSQL, getSQL, getSQL, getSQL, needRecompile, setCommand, setCurrentRowNumber, setHeadPos, setObjectId, setParameterList, setPrepareAlways, setRow, setSession, setSQL, toString, update
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ExplainPlan

public ExplainPlan(Session session)
Method Detail

setCommand

public void setCommand(Prepared command)

prepare

public void prepare()
             throws java.sql.SQLException
Description copied from class: Prepared
Prepare this statement.

Overrides:
prepare in class Prepared
Throws:
java.sql.SQLException

queryMeta

public LocalResult queryMeta()
                      throws java.sql.SQLException
Description copied from class: Prepared
Get an empty result set containing the meta data.

Specified by:
queryMeta in class Prepared
Returns:
an empty result set
Throws:
java.sql.SQLException

query

public LocalResult query(int maxrows)
                  throws java.sql.SQLException
Description copied from class: Prepared
Execute the query.

Overrides:
query in class Prepared
Parameters:
maxrows - the maximum number of rows to return
Returns:
the result set
Throws:
java.sql.SQLException - if it is not a query

isQuery

public boolean isQuery()
Description copied from class: Prepared
Check if this object is a query.

Overrides:
isQuery in class Prepared
Returns:
true if it is

isTransactional

public boolean isTransactional()
Description copied from class: Prepared
Check if this command is transactional. If it is not, then it forces the current transaction to commit.

Specified by:
isTransactional in class Prepared
Returns:
true if it is

isReadOnly

public boolean isReadOnly()
Description copied from class: Prepared
Check if this command is read only.

Overrides:
isReadOnly in class Prepared
Returns:
true if it is