Prepared (H2 Database Engine 2.0.0 API)

java.lang.Object
- org.h2.command.Prepared

直接已知子类:

BackupCommand, Call, DataChangeStatement, DefineCommand, ExecuteImmediate, ExecuteProcedure, Explain, Help, NoOperation, Query, RunScriptCommand, ScriptCommand, Set, SetSessionCharacteristics, TransactionCommand
```
public abstract class Prepared
extends Object
```
A prepared statement.

字段概要

字段
限定符和类型	字段和说明
`protected boolean`	`create` Whether to create a new object (for indexes).
`protected ArrayList<Parameter>`	`parameters` The list of parameters.
`protected boolean`	`prepareAlways` If the query should be prepared before each execution.
`protected SessionLocal`	`session` The session.
`protected String`	`sqlStatement` The SQL string.
`protected ArrayList<Token>`	`sqlTokens` The SQL tokens.

构造器概要

构造器
构造器和说明

Prepared(SessionLocal session)
Create a new object.

构造器
构造器和说明
`Prepared(SessionLocal session)` Create a new object.

方法概要

所有方法静态方法实例方法抽象方法具体方法
限定符和类型	方法和说明
`void`	`checkCanceled()` Check if this statement was canceled.
`protected void`	`checkParameters()` Check if all parameters have been set.
`void`	`collectDependencies(HashSet<DbObject> dependencies)` Find and collect all DbObjects, this Prepared depends on.
`List<TableView>`	`getCteCleanups()`
`long`	`getCurrentRowNumber()` Get the current row number.
`protected int`	`getObjectId()` Get the current object id, or get a new id from the database.
`ArrayList<Parameter>`	`getParameters()` Get the parameter list.
`int`	`getPersistedObjectId()` Get the object id to use for the database object that is created in this statement.
`String`	`getPlanSQL(int sqlFlags)` Get the SQL statement with the execution plan.
`SessionLocal`	`getSession()`
`static String`	`getSimpleSQL(Expression[] list)` Get the SQL snippet of the expression list.
`String`	`getSQL()` Get the SQL statement.
`ArrayList<Token>`	`getSQLTokens()` Get the SQL tokens.
`abstract int`	`getType()` Get the command type as defined in CommandInterface
`boolean`	`isCacheable()`
`boolean`	`isQuery()` Check if this object is a query.
`boolean`	`isReadOnly()` Check if this command is read only.
`abstract boolean`	`isTransactional()` Check if this command is transactional.
`boolean`	`isWithParamValues()` Returns whether values of parameters were specified in SQL.
`boolean`	`needRecompile()` Check if the statement needs to be re-compiled.
`void`	`prepare()` Prepare this statement.
`ResultInterface`	`query(long maxrows)` Execute the query.
`abstract ResultInterface`	`queryMeta()` Get an empty result set containing the meta data.
`void`	`setCommand(Command command)` Set the command.
`void`	`setCteCleanups(List<TableView> cteCleanups)` Set the temporary views created for CTE's.
`void`	`setCurrentRowNumber(long rowNumber)` Set the current row number.
`void`	`setParameterList(ArrayList<Parameter> parameters)` Set the parameter list of this statement.
`void`	`setPersistedObjectId(int i)` Set the persisted object id for this statement.
`void`	`setPrepareAlways(boolean prepareAlways)` Set the prepare always flag.
`protected DbException`	`setRow(DbException e, long rowId, String values)` Set the SQL statement of the exception to the given row.
`void`	`setSession(SessionLocal currentSession)` Set the session for this statement.
`void`	`setSQL(String sql, ArrayList<Token> sqlTokens)` Set the SQL statement.
`void`	`setWithParamValues(boolean withParamValues)` Sets whether values of parameters were specified in SQL.
`String`	`toString()` Convert the statement to a String.
`long`	`update()` Execute the statement.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- 字段详细资料
  - session
```
protected SessionLocal session
```
    The session.
  - sqlStatement
```
protected String sqlStatement
```
    The SQL string.
  - sqlTokens
```
protected ArrayList<Token> sqlTokens
```
    The SQL tokens.
  - create
```
protected boolean create
```
    Whether to create a new object (for indexes).
  - parameters
```
protected ArrayList<Parameter> parameters
```
    The list of parameters.
  - prepareAlways
```
protected boolean prepareAlways
```
    If the query should be prepared before each execution. This is set for queries with LIKE ?, because the query plan depends on the parameter value.
- 构造器详细资料
  - Prepared
```
public Prepared(SessionLocal session)
```
    Create a new object.
    
    参数:
    
    session - the session
- 方法详细资料
  - isTransactional
```
public abstract boolean isTransactional()
```
    Check if this command is transactional. If it is not, then it forces the current transaction to commit.
    
    返回:
    
    true if it is
  - queryMeta
```
public abstract ResultInterface queryMeta()
```
    Get an empty result set containing the meta data.
    
    返回:
    
    the result set
  - getType
```
public abstract int getType()
```
    Get the command type as defined in CommandInterface
    
    返回:
    
    the statement type
  - isReadOnly
```
public boolean isReadOnly()
```
    Check if this command is read only.
    
    返回:
    
    true if it is
  - needRecompile
```
public boolean needRecompile()
```
    Check if the statement needs to be re-compiled.
    
    返回:
    
    true if it must
  - setParameterList
```
public void setParameterList(ArrayList<Parameter> parameters)
```
    Set the parameter list of this statement.
    
    参数:
    
    parameters - the parameter list
  - getParameters
```
public ArrayList<Parameter> getParameters()
```
    Get the parameter list.
    
    返回:
    
    the parameter list
  - isWithParamValues
```
public boolean isWithParamValues()
```
    Returns whether values of parameters were specified in SQL.
    
    返回:
    
    are values of parameters were specified in SQL
  - setWithParamValues
```
public void setWithParamValues(boolean withParamValues)
```
    Sets whether values of parameters were specified in SQL.
    
    参数:
    
    withParamValues - are values of parameters were specified in SQL
  - checkParameters
```
protected void checkParameters()
```
    Check if all parameters have been set.
    
    抛出:
    
    DbException - if any parameter has not been set
  - setCommand
```
public void setCommand(Command command)
```
    Set the command.
    
    参数:
    
    command - the new command
  - isQuery
```
public boolean isQuery()
```
    Check if this object is a query.
    
    返回:
    
    true if it is
  - prepare
```
public void prepare()
```
    Prepare this statement.
  - update
```
public long update()
```
    Execute the statement.
    
    返回:
    
    the update count
    
    抛出:
    
    DbException - if it is a query
  - query
```
public ResultInterface query(long maxrows)
```
    Execute the query.
    
    参数:
    
    maxrows - the maximum number of rows to return
    
    返回:
    
    the result set
    
    抛出:
    
    DbException - if it is not a query
  - setSQL
```
public final void setSQL(String sql,
                         ArrayList<Token> sqlTokens)
```
    Set the SQL statement.
    
    参数:
    
    sql - the SQL statement
    
    sqlTokens - the SQL tokens
  - getSQL
```
public final String getSQL()
```
    Get the SQL statement.
    
    返回:
    
    the SQL statement
  - getSQLTokens
```
public final ArrayList<Token> getSQLTokens()
```
    Get the SQL tokens.
    
    返回:
    
    the SQL tokens
  - getPersistedObjectId
```
public int getPersistedObjectId()
```
    Get the object id to use for the database object that is created in this statement. This id is only set when the object is already persisted. If not set, this method returns 0.
    
    返回:
    
    the object id or 0 if not set
  - getObjectId
```
protected int getObjectId()
```
    Get the current object id, or get a new id from the database. The object id is used when creating new database object (CREATE statement). This method may be called only once.
    
    返回:
    
    the object id
  - getPlanSQL
```
public String getPlanSQL(int sqlFlags)
```
    Get the SQL statement with the execution plan.
    
    参数:
    
    sqlFlags - formatting flags
    
    返回:
    
    the execution plan
  - checkCanceled
```
public void checkCanceled()
```
    Check if this statement was canceled.
    
    抛出:
    
    DbException - if it was canceled
  - setPersistedObjectId
```
public void setPersistedObjectId(int i)
```
    Set the persisted object id for this statement.
    
    参数:
    
    i - the object id
  - setSession
```
public void setSession(SessionLocal currentSession)
```
    Set the session for this statement.
    
    参数:
    
    currentSession - the new session
  - setPrepareAlways
```
public void setPrepareAlways(boolean prepareAlways)
```
    Set the prepare always flag. If set, the statement is re-compiled whenever it is executed.
    
    参数:
    
    prepareAlways - the new value
  - setCurrentRowNumber
```
public void setCurrentRowNumber(long rowNumber)
```
    Set the current row number.
    
    参数:
    
    rowNumber - the row number
  - getCurrentRowNumber
```
public long getCurrentRowNumber()
```
    Get the current row number.
    
    返回:
    
    the row number
  - toString
```
public String toString()
```
    Convert the statement to a String.
    
    覆盖:
    
    toString 在类中 Object
    
    返回:
    
    the SQL statement
  - getSimpleSQL
```
public static String getSimpleSQL(Expression[] list)
```
    Get the SQL snippet of the expression list.
    
    参数:
    
    list - the expression list
    
    返回:
    
    the SQL snippet
  - setRow
```
protected DbException setRow(DbException e,
                             long rowId,
                             String values)
```
    Set the SQL statement of the exception to the given row.
    
    参数:
    
    e - the exception
    
    rowId - the row number
    
    values - the values of the row
    
    返回:
    
    the exception
  - isCacheable
```
public boolean isCacheable()
```
  - getCteCleanups
```
public List<TableView> getCteCleanups()
```
    返回:
    
    the temporary views created for CTE's.
  - setCteCleanups
```
public void setCteCleanups(List<TableView> cteCleanups)
```
    Set the temporary views created for CTE's.
    
    参数:
    
    cteCleanups - the temporary views
  - getSession
```
public final SessionLocal getSession()
```
  - collectDependencies
```
public void collectDependencies(HashSet<DbObject> dependencies)
```
    Find and collect all DbObjects, this Prepared depends on.
    
    参数:
    
    dependencies - collection of dependencies to populate

类 Prepared

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

session

sqlStatement

sqlTokens

create

parameters

prepareAlways

构造器详细资料

Prepared

方法详细资料

isTransactional

queryMeta

getType

isReadOnly

needRecompile

setParameterList

getParameters

isWithParamValues

setWithParamValues

checkParameters

setCommand

isQuery

prepare

update

query

setSQL

getSQL

getSQLTokens

getPersistedObjectId

getObjectId

getPlanSQL

checkCanceled

setPersistedObjectId

setSession

setPrepareAlways

setCurrentRowNumber

getCurrentRowNumber

toString

getSimpleSQL

setRow

isCacheable

getCteCleanups

setCteCleanups

getSession

collectDependencies