DBTool (YangMVC 2023.06.19 API)

java.lang.Object
- org.docshare.orm.DBTool

```
public class DBTool
extends Object
```
ORM类库最核心的类。负责数据库表的查询。所有数据库查询均需先创建此类。
创建方法:
DBTool tool = DBTool.getIns("book"); //book为数据库表名
LasyList list = tool.all().limit(10); //查询数据库的前10行， all()并非获取了所有列，当添加完参数，真正读取时才进行查询。它实际上是一个SQL语句的Builder 得到LasyList可以使用像ArrayList一样使用了。

作者:

Tongfeng Yang

字段概要

字段
限定符和类型字段和说明

Map<String,ColumnDesc> c_to_remarks

字段
限定符和类型	字段和说明
`Map<String,ColumnDesc>`	`c_to_remarks`

方法概要

所有方法静态方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`LasyList`	`all()` 获取表格所有行，这里采用了延迟加载技术，并不会真的查询所有的行，可以调用返回的LasyList的过滤器添加查询条件，在读取数据时才真正进行查询。
`static void`	`clearCache()`
`DBTool`	`commit()`
`Model`	`create()`
`Model`	`db2Table(ResultSet rs, Map<String,?> c, Set<String> column_set)`
`int`	`del(Model m)` 根据Model对象删除数据表的一行
`int`	`del(Object id)` 根据表的主键删除表格的一行
`int`	`delBy(String column, Object val)` 根据某个列的值进行删除
`protected void`	`finalize()`
`static LasyList`	`fromSQL(String sql)` 已过时。
`Model`	`get(Object id)` 获取key为id的记录并返回模型。
`Model`	`get(String column, Object value)` 获取column列等于id的所有集合的第一个
`ColumnDesc`	`getColumnDesc(String column)` 获取当前数据表的某一行的信息
`String`	`getColumnRemark(String column)` 获取列的注释
`int`	`getColumnType(String column)` 获取列的类型（int类型）
`String`	`getColumnTypeName(String column)` 获取列的类型名
`IDBDelegate`	`getDelegate()`
`static DBTool`	`getIns(String tname)`
`Model`	`getNotNull(Object id)`
`int`	`insert(Model m)` 执行一次插入操作
`Model`	`insertAndRet(Model m)`
`Set<String>`	`listColumns()` 列举所有的列名
`DBTool`	`rollback()`
`int`	`run(String sql, Object... objects)`
`int`	`save(Model m)` 插入或保存数据。
`int`	`save(Model m, boolean isInsert)` 更新或保存数据。
`int`	`save(Object obj)`
`int`	`save(Object obj, boolean isInsert)`
`Model`	`saveAndRet(Model m)`
`DBTool`	`tran()`

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

- 字段详细资料
  - c_to_remarks
```
public Map<String,ColumnDesc> c_to_remarks
```
- 方法详细资料
  - getDelegate
```
public IDBDelegate getDelegate()
```
  - getColumnRemark
```
public String getColumnRemark(String column)
```
    获取列的注释
    
    参数:
    
    column - 列名
    
    返回:
    
    指定列的列名
  - getColumnType
```
public int getColumnType(String column)
```
    获取列的类型（int类型）
    
    参数:
    
    column - 字段名
    
    返回:
    
    类型
  - getColumnTypeName
```
public String getColumnTypeName(String column)
```
    获取列的类型名
    
    参数:
    
    column - 字段名
    
    返回:
    
    字段类型
  - listColumns
```
public Set<String> listColumns()
```
    列举所有的列名
    
    返回:
    
    所有列名的集合
  - fromSQL
```
@Deprecated
public static LasyList fromSQL(String sql)
```
    已过时。
    
    根据用户自定义的sql来获取list 如果需要使用原生的SQL，请使用LasyList.fromRawSQL实现
    
    参数:
    
    sql - SQL语句
    
    返回:
    
    返回一个包含了该SQL结果的LasyList（并没有真正查询，在你读取数据时真正查询
  - get
```
public Model get(Object id)
```
    获取key为id的记录并返回模型。注意必须有主键，且主键为整数
    
    参数:
    
    id - 主键的值
    
    返回:
    
    符合条件的模型
  - getNotNull
```
public Model getNotNull(Object id)
```
  - get
```
public Model get(String column,
                 Object value)
```
    获取column列等于id的所有集合的第一个
    
    参数:
    
    column - 字段名
    
    value - 值
    
    返回:
    
    找到列column等于value的对象
  - create
```
public Model create()
```
  - save
```
public int save(Model m)
```
    插入或保存数据。当m的主键为非空时，则为更新，主键为空是为插入。
    
    参数:
    
    m - 模型变量
    
    返回:
    
    影响的数据库行数
  - saveAndRet
```
public Model saveAndRet(Model m)
```
  - save
```
public int save(Object obj,
                boolean isInsert)
```
  - save
```
public int save(Object obj)
```
  - save
```
public int save(Model m,
                boolean isInsert)
```
    更新或保存数据。当主键为null 或isInsert为真时，执行插入数据否则，执行更新操作。
    
    参数:
    
    m - 模型
    
    isInsert - 是否强制为插入操作
    
    返回:
    
    影响的数据库行数
  - insert
```
public int insert(Model m)
```
    执行一次插入操作
    
    参数:
    
    m - 模型
    
    返回:
    
    插入影响的行数
  - insertAndRet
```
public Model insertAndRet(Model m)
```
  - all
```
public LasyList all()
```
    获取表格所有行，这里采用了延迟加载技术，并不会真的查询所有的行，可以调用返回的LasyList的过滤器添加查询条件，在读取数据时才真正进行查询。如: tool.all().eq("id",12).gt("no",333) ; 相当于 select * from tablea where id = 12 and no>333
    
    返回:
    
    LasyList对象
  - db2Table
```
public Model db2Table(ResultSet rs,
                      Map<String,?> c,
                      Set<String> column_set)
```
  - del
```
public int del(Object id)
```
    根据表的主键删除表格的一行
    
    参数:
    
    id - 主键的值
    
    返回:
    
    影响的数据库的行数
  - delBy
```
public int delBy(String column,
                 Object val)
```
    根据某个列的值进行删除
    
    参数:
    
    column - 列名
    
    val - 值
    
    返回:
    
    影响的数据库行数
  - del
```
public int del(Model m)
```
    根据Model对象删除数据表的一行
    
    参数:
    
    m - 模型
    
    返回:
    
    影响的数据库行数
  - finalize
```
protected void finalize()
                 throws Throwable
```
    覆盖:
    
    finalize 在类中 Object
    
    抛出:
    
    Throwable
  - getColumnDesc
```
public ColumnDesc getColumnDesc(String column)
```
    获取当前数据表的某一行的信息
    
    参数:
    
    column - 列名
    
    返回:
    
    获取column列描述信息
  - run
```
public int run(String sql,
               Object... objects)
```
  - getIns
```
public static DBTool getIns(String tname)
```
  - clearCache
```
public static void clearCache()
```
  - tran
```
public DBTool tran()
```
  - commit
```
public DBTool commit()
```
  - rollback
```
public DBTool rollback()
```

类 DBTool

字段概要

方法概要

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

字段详细资料

c_to_remarks

方法详细资料

getDelegate

getColumnRemark

getColumnType

getColumnTypeName

listColumns

fromSQL

get

getNotNull

get

create

save

saveAndRet

save

save

save

insert

insertAndRet

all

db2Table

del

delBy

del

finalize

getColumnDesc

run

getIns

clearCache

tran

commit

rollback