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

public Class Help

extends Prepared
Class Inheritance
Imports
java.io.ByteArrayInputStream, .IOException, .InputStreamReader, .Reader, java.nio.charset.StandardCharsets, java.sql.ResultSet, org.h2.command.CommandInterface, .Prepared, org.h2.engine.Database, .SessionLocal, org.h2.expression.Expression, .ExpressionColumn, org.h2.message.DbException, org.h2.result.LocalResult, .ResultInterface, org.h2.table.Column, org.h2.tools.Csv, org.h2.util.Utils, org.h2.value.TypeInfo, .ValueVarchar
This class represents the statement CALL.

Field Summary

Modifier and TypeField and Description
private final String[]
conditions

private final Expression[]
expressions

Inherited from org.h2.command.Prepared:
createparametersprepareAlwayssessionsqlStatementsqlTokens

Constructor Summary

AccessConstructor and Description
public
Help(SessionLocal session, String[] conditions)

Method Summary

Modifier and TypeMethod and Description
public static ResultSet

Returns:

HELP table with columns SECTION,TOPIC,SYNTAX,TEXT
getTable()

Returns HELP table.

public int
getType()

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

Get the command type as defined in CommandInterface

public boolean
isCacheable()

Overrides org.h2.command.Prepared.isCacheable.

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 static String

Returns:

text without wrapping quotes and trimmed
processHelpText(String
text to process
s)

Sanitize value read from csv file (i.e. help.csv)

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 static String

Returns:

cleaned text
stripAnnotationsFromSyntax(String
to process
s)

Strip out the special annotations we use to help build the railroad/BNF diagrams

Inherited from org.h2.command.Prepared:
checkCanceledcheckParameterscollectDependenciesgetCurrentRowNumbergetDatabasegetObjectIdgetParametersgetPersistedObjectIdgetPlanSQLgetPlanSQLgetSessiongetSimpleSQLgetSQLgetSQLTokensisRetryableisWithParamValuesneedRecompilepreparesetCommandsetCurrentRowNumbersetParameterListsetPersistedObjectIdsetPrepareAlwayssetRowsetSessionsetSQLsetWithParamValuestoStringupdate

Field Detail

conditionsback to summary
private final String[] conditions
expressionsback to summary
private final Expression[] expressions

Constructor Detail

Helpback to summary
public Help(SessionLocal session, String[] conditions)

Method Detail

getTableback to summary
public static ResultSet getTable() throws IOException

Returns HELP table.

Returns:ResultSet

HELP table with columns SECTION,TOPIC,SYNTAX,TEXT

Exceptions
IOException:
on I/O exception
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
isCacheableback to summary
public boolean isCacheable()

Overrides org.h2.command.Prepared.isCacheable.

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
processHelpTextback to summary
public static String processHelpText(String s)

Sanitize value read from csv file (i.e. help.csv)

Parameters
s:String

text to process

Returns:String

text without wrapping quotes and trimmed

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
stripAnnotationsFromSyntaxback to summary
public static String stripAnnotationsFromSyntax(String s)

Strip out the special annotations we use to help build the railroad/BNF diagrams

Parameters
s:String

to process

Returns:String

cleaned text