NutSql (nutz 1.r.58 API)

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

所有已实现的接口:: DaoStatement, Sql

public class NutSql
extends NutStatement
implements Sql

字段概要

字段
限定符和类型	字段和说明
`protected SqlCallback`	`callback`
`protected java.util.Map<java.lang.String,ValueAdaptor>`	`customValueAdaptor`
`protected java.util.List<PItem>`	`items`
`protected VarIndex`	`paramIndex`
`protected VarSet`	`params`
`protected java.util.List<VarSet>`	`rows`
`protected java.lang.String`	`sourceSql`
`protected VarIndex`	`varIndex`
`protected VarSet`	`vars`

构造器概要

构造器
构造器和说明

NutSql(java.lang.String source)

NutSql(java.lang.String source, SqlCallback callback)

构造器
构造器和说明
`NutSql(java.lang.String source)`
`NutSql(java.lang.String source, SqlCallback callback)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`protected int`	`_params_count()`
`void`	`addBatch()` 将当前的参数列表存储，以便执行批处理
`void`	`clearBatch()` 清除所有的曾经设置过的参数
`Sql`	`duplicate()`
`ValueAdaptor[]`	`getAdaptors()` 为本语句每一个参数提供一个适配器
`Record`	`getOutParams()`
`java.lang.Object[][]`	`getParamMatrix()` 用一个矩阵描述语句的参数表。
`java.lang.String`	`getSourceSql()`
`protected SqlLiteral`	`literal()` 若需要定制参数字符和变量字符,覆盖本方法,通过SqlLiteral的构造方法指定之
`void`	`onAfter(java.sql.Connection conn, java.sql.ResultSet rs, java.sql.Statement stmt)` 语句执行完毕的后续操作这个接口函数你基本不会直接使用的
`void`	`onBefore(java.sql.Connection conn)` 语句执行之前的操作这个接口函数你基本不会直接使用的
`VarIndex`	`paramIndex()`
`VarSet`	`params()` 所谓"参数"，就是当 Sql 对象转换成 PreparedStatement 对象前，会被填充成 ?
`Sql`	`setCallback(SqlCallback callback)` 当前 Statement 被执行完毕后，有可能会产生一个 ResultSet。
`Sql`	`setCondition(Condition cnd)` 为 SQL 增加条件，SQL 必须有 '$condition' 变量
`Sql`	`setEntity(Entity<?> entity)` 设置当前语句对应的实体
`DaoStatement`	`setPager(Pager pager)` 为自定义SQL设置Pager 如果设置为非空值,那么将附加上分页语句!!
`Sql`	`setParam(java.lang.String name, java.lang.Object value)` sql.params().set(name, value)的链式调用方式
`void`	`setSourceSql(java.lang.String sql)`
`void`	`setValueAdaptor(java.lang.String name, ValueAdaptor adaptor)` 手动为某个语句参数设置适配器。
`Sql`	`setVar(java.lang.String name, java.lang.Object value)` sql.vars().set(name, value)的链式调用方式
`java.lang.String`	`toPreparedStatement()` 将 Dao 语句转换为 JDBC SQL 缓冲语句
`VarIndex`	`varIndex()`
`VarSet`	`vars()` 所谓"变量"，就是当 Sql 对象转换成 Statement 对象前，预先被填充的占位符。

从类继承的方法 org.nutz.dao.impl.sql.NutStatement
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, param2obj, param2String, setContext, setSqlType, toExampleStatement, toStatement, toString

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

从接口继承的方法 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, toString

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

类 NutSql

字段概要

构造器概要

方法概要

从类继承的方法 org.nutz.dao.impl.sql.NutStatement

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

从接口继承的方法 org.nutz.dao.sql.DaoStatement

字段详细资料

sourceSql

vars

rows

params

callback

varIndex

paramIndex

customValueAdaptor

items

构造器详细资料

NutSql

NutSql

方法详细资料

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