NutSql (Nutz 1.r.63.r2 API)

java.lang.Object
- org.nutz.dao.impl.sql.NutStatement
- - org.nutz.dao.impl.sql.NutSql

All Implemented Interfaces:

Serializable, DaoStatement, Sql
```
public class NutSql
extends NutStatement
implements Sql
```
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected SqlCallback`	`callback`
`protected Map<String,ValueAdaptor>`	`customValueAdaptor`
`protected List<PItem>`	`items`
`protected VarIndex`	`paramIndex`
`protected VarSet`	`params`
`protected char[]`	`placeholder`
`protected List<VarSet>`	`rows`
`protected String`	`sourceSql`
`protected VarIndex`	`varIndex`
`protected VarSet`	`vars`

Fields inherited from class org.nutz.dao.impl.sql.NutStatement
expert

Constructor Summary

Constructors
Constructor and Description

NutSql(String source)

NutSql(String source, SqlCallback callback)

Constructors
Constructor and Description
`NutSql(String source)`
`NutSql(String source, SqlCallback callback)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected int`	`_params_count()`
`void`	`addBatch()` 将当前的参数列表存储，以便执行批处理
`Sql`	`changePlaceholder(char param, char var)` 修改原有的占位符(默认是$和@),并重新解析.仅作用于当前SQL对象
`void`	`clearBatch()` 清除所有的曾经设置过的参数
`Sql`	`duplicate()`
`ValueAdaptor[]`	`getAdaptors()` 为本语句每一个参数提供一个适配器
`Record`	`getOutParams()` 获取存储过程的出参
`Object[][]`	`getParamMatrix()` 用一个矩阵描述语句的参数表。这个参数矩阵将同 getAdaptors() 的返回组合使用
`String`	`getSourceSql()` 获取原始SQL
`protected SqlLiteral`	`literal()` 若需要定制参数字符和变量字符,覆盖本方法,通过SqlLiteral的构造方法指定之
`void`	`onAfter(Connection conn, ResultSet rs, Statement stmt)` 语句执行完毕的后续操作
`void`	`onBefore(Connection conn)` 语句执行之前的操作
`VarIndex`	`paramIndex()`
`VarSet`	`params()` 所谓"参数"，就是当 Sql 对象转换成 PreparedStatement 对象前，会被填充成 ? 的占位符
`Sql`	`setCallback(SqlCallback callback)` 当前 Statement 被执行完毕后，有可能会产生一个 ResultSet。针对这个 ResultSet 你可以执行更多的操作。
`Sql`	`setCondition(Condition cnd)` 为 SQL 增加条件，SQL 必须有 '$condition' 变量
`Sql`	`setEntity(Entity<?> entity)` 设置当前语句对应的实体
`DaoStatement`	`setPager(Pager pager)` 为自定义SQL设置Pager 如果设置为非空值,那么将附加上分页语句!! 由于不带SQL语法分析,无法探知用户是否已经自行添加分页语句!! 使用这个功能,你就不要自己在SQL里面写limit了!!!
`Sql`	`setParam(String name, Object value)` sql.params().set(name, value)的链式调用方式
`void`	`setSourceSql(String sql)` 设置原始SQL,将重新解析里面的占位符
`void`	`setValueAdaptor(String name, ValueAdaptor adaptor)` 手动为某个语句参数设置适配器。
`Sql`	`setVar(String name, Object value)` sql.vars().set(name, value)的链式调用方式
`String`	`toPreparedStatement()` 将 Dao 语句转换为 JDBC SQL 缓冲语句
`VarIndex`	`varIndex()`
`VarSet`	`vars()` 所谓"变量"，就是当 Sql 对象转换成 Statement 对象前，预先被填充的占位符。

Methods inherited from class org.nutz.dao.impl.sql.NutStatement
forceExecQuery, forPrint, getAdapterBy, getBoolean, getContext, getDouble, getDouble, getEntity, getFloat, getFloat, getInt, getInt, getList, getLong, getLong, getNumber, getObject, getResult, getSqlType, getString, getUpdateCount, isAlter, isCall, isCreate, isDelete, isDrop, isExec, isForceExecQuery, isInsert, isOther, isRun, isSelect, isUpdate, param2String, setContext, setExpert, setSqlType, toExampleStatement, toStatement, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.nutz.dao.sql.DaoStatement
forceExecQuery, forPrint, getBoolean, getContext, getDouble, getDouble, getEntity, getFloat, getFloat, getInt, getInt, getList, getLong, getLong, getNumber, getObject, getResult, getSqlType, getString, getUpdateCount, isAlter, isCall, isCreate, isDelete, isDrop, isExec, isForceExecQuery, isInsert, isOther, isRun, isSelect, isUpdate, setExpert, toString

- Field Detail
  - sourceSql
```
protected String sourceSql
```
  - vars
```
protected VarSet vars
```
  - rows
```
protected List<VarSet> rows
```
  - params
```
protected VarSet params
```
  - callback
```
protected SqlCallback callback
```
  - varIndex
```
protected VarIndex varIndex
```
  - paramIndex
```
protected VarIndex paramIndex
```
  - customValueAdaptor
```
protected Map<String,ValueAdaptor> customValueAdaptor
```
  - items
```
protected List<PItem> items
```
  - placeholder
```
protected char[] placeholder
```
- Constructor Detail
  - NutSql
```
public NutSql(String source)
```
  - NutSql
```
public NutSql(String source,
              SqlCallback callback)
```
- Method Detail
  - setSourceSql
```
public void setSourceSql(String sql)
```
    Description copied from interface: Sql
    
    设置原始SQL,将重新解析里面的占位符
    
    Specified by:
    
    setSourceSql in interface Sql
  - _params_count
```
protected int _params_count()
```
  - getAdaptors
```
public ValueAdaptor[] getAdaptors()
```
    Description copied from interface: DaoStatement
    
    为本语句每一个参数提供一个适配器
    
    Specified by:
    
    getAdaptors in interface DaoStatement
    
    Returns:
    
    JDBC 缓冲语句的参数适配器
  - getParamMatrix
```
public Object[][] getParamMatrix()
```
    Description copied from interface: DaoStatement
    
    用一个矩阵描述语句的参数表。
    这个参数矩阵将同 getAdaptors() 的返回组合使用
    矩阵的每一行相当于执行一条语句
    参数表的下标意义为： Object[行][列]
    
    Specified by:
    
    getParamMatrix in interface DaoStatement
    
    Returns:
    
    语句参数表
  - toPreparedStatement
```
public String toPreparedStatement()
```
    Description copied from interface: DaoStatement
    
    将 Dao 语句转换为 JDBC SQL 缓冲语句
    
    Specified by:
    
    toPreparedStatement in interface DaoStatement
    
    Returns:
    
    JDBC SQL 缓冲语句
  - onBefore
```
public void onBefore(Connection conn)
              throws SQLException
```
    Description copied from interface: DaoStatement
    
    语句执行之前的操作
    这个接口函数你基本不会直接使用的
    
    Specified by:
    
    onBefore in interface DaoStatement
    
    Parameters:
    
    conn - 当前执行语句的连接
    
    Throws:
    
    SQLException
  - onAfter
```
public void onAfter(Connection conn,
                    ResultSet rs,
                    Statement stmt)
             throws SQLException
```
    Description copied from interface: DaoStatement
    
    语句执行完毕的后续操作
    这个接口函数你基本不会直接使用的
    
    Specified by:
    
    onAfter in interface DaoStatement
    
    Parameters:
    
    conn - 当前执行语句的连接
    
    rs - 当前语句执行的结果集
    
    stmt - TODO
    
    Throws:
    
    SQLException - 回调函数抛出的异常
  - setPager
```
public DaoStatement setPager(Pager pager)
```
    Description copied from interface: DaoStatement
    
    为自定义SQL设置Pager
    如果设置为非空值,那么将附加上分页语句!!
    由于不带SQL语法分析,无法探知用户是否已经自行添加分页语句!!
    使用这个功能,你就不要自己在SQL里面写limit了!!!
    
    Specified by:
    
    setPager in interface DaoStatement
  - vars
```
public VarSet vars()
```
    Description copied from interface: Sql
    
    所谓"变量"，就是当 Sql 对象转换成 Statement 对象前，预先被填充的占位符。
    这个集合允许你为 SQL 的变量占位符设值
    
    Specified by:
    
    vars in interface Sql
    
    Returns:
    
    变量集合
  - params
```
public VarSet params()
```
    Description copied from interface: Sql
    
    所谓"参数"，就是当 Sql 对象转换成 PreparedStatement 对象前，会被填充成 ? 的占位符
    集合是一个个的名值对，你设置了值的地方，会在执行时，被设置到 PreparedStatement中。
    这样省却了你一个一个计算 ? 位置的烦恼
    
    Specified by:
    
    params in interface Sql
    
    Returns:
    
    参数集合
  - setValueAdaptor
```
public void setValueAdaptor(String name,
                            ValueAdaptor adaptor)
```
    Description copied from interface: Sql
    
    手动为某个语句参数设置适配器。
    默认的，Sql 的实现类会自动根据你设置的值，自动为所有的参数设置适配器。
    但是，有些时候，你可能传入了 null 值或者其他的特殊对象，
    这里允许你主动为其设置一个适配器，这样你就有了终极手段最合理的适配你的参数对象
    
    Specified by:
    
    setValueAdaptor in interface Sql
    
    Parameters:
    
    name - 对应参数的名称
    
    adaptor - 适配器实例
  - varIndex
```
public VarIndex varIndex()
```
    Specified by:
    
    varIndex in interface Sql
    
    Returns:
    
    整个 SQL 的变量索引，你可以获得变量的个数和名称
  - paramIndex
```
public VarIndex paramIndex()
```
    Specified by:
    
    paramIndex in interface Sql
    
    Returns:
    
    整个 SQL 的参数索引，你可以获得参数的个数和名称
  - addBatch
```
public void addBatch()
```
    Description copied from interface: Sql
    
    将当前的参数列表存储，以便执行批处理
    
    Specified by:
    
    addBatch in interface Sql
  - clearBatch
```
public void clearBatch()
```
    Description copied from interface: Sql
    
    清除所有的曾经设置过的参数
    
    Specified by:
    
    clearBatch in interface Sql
  - setEntity
```
public Sql setEntity(Entity<?> entity)
```
    Description copied from interface: DaoStatement
    
    设置当前语句对应的实体
    
    Specified by:
    
    setEntity in interface DaoStatement
    
    Specified by:
    
    setEntity in interface Sql
    
    Overrides:
    
    setEntity in class NutStatement
    
    Parameters:
    
    entity - 实体
    
    Returns:
    
    自身
  - setCallback
```
public Sql setCallback(SqlCallback callback)
```
    Description copied from interface: Sql
    
    当前 Statement 被执行完毕后，有可能会产生一个 ResultSet。针对这个 ResultSet 你可以执行更多的操作。
    当然如果不是 SELECT 语句，那么你依然可以设置一个回调，
    当你的语句执行完毕后，会调用它（Connection 不会被 commit），但是 ResultSet 参数会是 null
    
    Specified by:
    
    setCallback in interface Sql
    
    Parameters:
    
    callback - 回调函数
    
    Returns:
    
    自身
  - setCondition
```
public Sql setCondition(Condition cnd)
```
    Description copied from interface: Sql
    
    为 SQL 增加条件，SQL 必须有 '$condition' 变量
    
    Specified by:
    
    setCondition in interface Sql
    
    Parameters:
    
    cnd - 条件
    
    Returns:
    
    自身
  - duplicate
```
public Sql duplicate()
```
    Specified by:
    
    duplicate in interface Sql
    
    Returns:
    
    一个新的和当前对象一样的对象。只是原来设置的变量和参数，需要你重新设置
  - getSourceSql
```
public String getSourceSql()
```
    Description copied from interface: Sql
    
    获取原始SQL
    
    Specified by:
    
    getSourceSql in interface Sql
  - literal
```
protected SqlLiteral literal()
```
    若需要定制参数字符和变量字符,覆盖本方法,通过SqlLiteral的构造方法指定之
  - setParam
```
public Sql setParam(String name,
                    Object value)
```
    Description copied from interface: Sql
    
    sql.params().set(name, value)的链式调用方式
    
    Specified by:
    
    setParam in interface Sql
    
    Parameters:
    
    name - 参数名称
    
    value - 参数值
    
    Returns:
    
    原Sql对象,用于链式调用
    
    See Also:
    
    Sql.params()
  - setVar
```
public Sql setVar(String name,
                  Object value)
```
    Description copied from interface: Sql
    
    sql.vars().set(name, value)的链式调用方式
    
    Specified by:
    
    setVar in interface Sql
    
    Parameters:
    
    name - 变量名称
    
    value - 变量值
    
    Returns:
    
    原Sql对象,用于链式调用
    
    See Also:
    
    Sql.vars()
  - getOutParams
```
public Record getOutParams()
```
    Description copied from interface: Sql
    
    获取存储过程的出参
    
    Specified by:
    
    getOutParams in interface Sql
  - changePlaceholder
```
public Sql changePlaceholder(char param,
                             char var)
```
    Description copied from interface: Sql
    
    修改原有的占位符(默认是$和@),并重新解析.仅作用于当前SQL对象
    
    Specified by:
    
    changePlaceholder in interface Sql
    
    Parameters:
    
    param - 参数占位符,默认是@
    
    var - 变量占位符,默认是$
    
    Returns:
    
    当前SQL对象

Class NutSql

Field Summary

Fields inherited from class org.nutz.dao.impl.sql.NutStatement

Constructor Summary

Method Summary

Methods inherited from class org.nutz.dao.impl.sql.NutStatement

Methods inherited from class java.lang.Object

Methods inherited from interface org.nutz.dao.sql.DaoStatement

Field Detail

sourceSql

vars

rows

params

callback

varIndex

paramIndex

customValueAdaptor

items

placeholder

Constructor Detail

NutSql

NutSql

Method Detail

setSourceSql

_params_count

getAdaptors

getParamMatrix

toPreparedStatement

onBefore

onAfter

setPager

vars

params

setValueAdaptor

varIndex

paramIndex

addBatch

clearBatch

setEntity

setCallback

setCondition

duplicate

getSourceSql

literal

setParam

setVar

getOutParams

changePlaceholder