Package org.h2.command.dml
Class Help
- java.lang.Object
-
- org.h2.command.Prepared
-
- org.h2.command.dml.Help
-
public class Help extends Prepared
This class represents the statement CALL.
-
-
Field Summary
Fields Modifier and Type Field Description private java.lang.String[]
conditions
private Expression[]
expressions
-
Fields inherited from class org.h2.command.Prepared
create, parameters, prepareAlways, session, sqlStatement, sqlTokens
-
-
Constructor Summary
Constructors Constructor Description Help(SessionLocal session, java.lang.String[] conditions)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static java.sql.ResultSet
getTable()
Returns HELP table.int
getType()
Get the command type as defined in CommandInterfaceboolean
isCacheable()
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.static java.lang.String
processHelpText(java.lang.String s)
Sanitize value read from csv file (i.e.ResultInterface
query(long maxrows)
Execute the query.ResultInterface
queryMeta()
Get an empty result set containing the meta data.static java.lang.String
stripAnnotationsFromSyntax(java.lang.String s)
Strip out the special annotations we use to help build the railroad/BNF diagrams-
Methods inherited from class org.h2.command.Prepared
checkCanceled, checkParameters, collectDependencies, getCteCleanups, getCurrentRowNumber, getObjectId, getParameters, getPersistedObjectId, getPlanSQL, getSession, getSimpleSQL, getSQL, getSQLTokens, needRecompile, prepare, setCommand, setCteCleanups, setCurrentRowNumber, setParameterList, setPersistedObjectId, setPrepareAlways, setRow, setSession, setSQL, toString, update
-
-
-
-
Field Detail
-
conditions
private final java.lang.String[] conditions
-
expressions
private final Expression[] expressions
-
-
Constructor Detail
-
Help
public Help(SessionLocal session, java.lang.String[] conditions)
-
-
Method Detail
-
queryMeta
public ResultInterface queryMeta()
Description copied from class:Prepared
Get an empty result set containing the meta data.
-
query
public ResultInterface query(long maxrows)
Description copied from class:Prepared
Execute the query.
-
stripAnnotationsFromSyntax
public static java.lang.String stripAnnotationsFromSyntax(java.lang.String s)
Strip out the special annotations we use to help build the railroad/BNF diagrams- Parameters:
s
- to process- Returns:
- cleaned text
-
processHelpText
public static java.lang.String processHelpText(java.lang.String s)
Sanitize value read from csv file (i.e. help.csv)- Parameters:
s
- text to process- Returns:
- text without wrapping quotes and trimmed
-
getTable
public static java.sql.ResultSet getTable() throws java.io.IOException
Returns HELP table.- Returns:
- HELP table with columns SECTION,TOPIC,SYNTAX,TEXT
- Throws:
java.io.IOException
- on I/O exception
-
isQuery
public boolean isQuery()
Description copied from class:Prepared
Check if this object is a query.
-
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 classPrepared
- Returns:
- true if it is
-
isReadOnly
public boolean isReadOnly()
Description copied from class:Prepared
Check if this command is read only.- Overrides:
isReadOnly
in classPrepared
- Returns:
- true if it is
-
getType
public int getType()
Description copied from class:Prepared
Get the command type as defined in CommandInterface
-
isCacheable
public boolean isCacheable()
- Overrides:
isCacheable
in classPrepared
-
-