org.voltdb

Class SQLStmt

java.lang.Object

org.voltdb.SQLStmt

public class SQLStmt
extends java.lang.Object

A simple wrapper of a parameterized SQL statement. VoltDB uses this instead of a Java String type for performance reasons and to cache statement meta-data like result schema, compiled plan, etc..

SQLStmts are used exclusively in subclasses of VoltProcedure

See Also:

VoltProcedure

Constructor Summary

Constructors

Constructor and Description
SQLStmt(java.lang.String sqlText) Construct a SQLStmt instance from a SQL statement.
SQLStmt(java.lang.String sqlText, java.lang.String joinOrder) Construct a SQLStmt instance from a SQL statement.

Method Summary

Modifier and Type	Method and Description
static java.lang.String	canonicalizeStmt(java.lang.String stmtStr)
java.lang.String	getJoinOrder() Get the join order hint supplied in the constructor.
java.lang.String	getText() Get the text of the SQL statement represented.
boolean	isReadOnly() Is this a read only statement?
void	setInCatalog(boolean inCatalog)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SQLStmt

public SQLStmt(java.lang.String sqlText)

Construct a SQLStmt instance from a SQL statement.

Parameters:

sqlText - Valid VoltDB compliant SQL with question marks as parameter place holders.

SQLStmt

public SQLStmt(java.lang.String sqlText,
               java.lang.String joinOrder)

Construct a SQLStmt instance from a SQL statement.

Parameters:

sqlText - Valid VoltDB compliant SQL with question marks as parameter place holders.

joinOrder - separated list of tables used by the query specifying the order they should be joined in

Method Detail

getText

public java.lang.String getText()

Get the text of the SQL statement represented.

Returns:

String containing the text of the SQL statement represented.

getJoinOrder

public java.lang.String getJoinOrder()

Get the join order hint supplied in the constructor.

Returns:

String containing the join order hint.

isReadOnly

public boolean isReadOnly()

Is this a read only statement?

Returns:

true if it's read only, false otherwise

canonicalizeStmt

public static java.lang.String canonicalizeStmt(java.lang.String stmtStr)

setInCatalog

public void setInCatalog(boolean inCatalog)