DBHelper (YangMVC 2023.06.19 API)

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

直接已知子类:

AccessDBHelper, MySQLDBHelper, PostgresDBHelper
```
public abstract class DBHelper
extends Object
```

嵌套类概要

嵌套类
限定符和类型类和说明

class DBHelper.TableInfo

嵌套类
限定符和类型	类和说明
`class`	`DBHelper.TableInfo`

字段概要

字段
限定符和类型	字段和说明
`protected Connection`	`con`
`static String`	`DB_MYSQL`
`static String`	`DB_POSTGRES`
`protected Object`	`last_id`
`static boolean`	`useCache`
`static boolean`	`useConfigFile` 是否需要尝试读取源文件根目录下的tbconfig目录下的表格式文件。

构造器概要

构造器
构造器和说明

DBHelper()

构造器
构造器和说明
`DBHelper()`

方法概要

所有方法静态方法实例方法抽象方法具体方法
限定符和类型	方法和说明
`void`	`beginTransation()` 启动事务，所有提交在sql会在调用commit后被执行。
`void`	`clearDescCache()`
`void`	`close()`
`HashMap<String,ColumnDesc>`	`columeOfRs(String sql, ResultSet rs)` 列举sql返回的所有的行
`void`	`commit()`
`abstract void`	`conn()` 连接数据库
`static void`	`disableCache()`
`protected void`	`finalize()`
`Connection`	`getConnection()`
`void`	`getFKey(String table, HashMap<String,ColumnDesc> map)` 获取该表的外键信息
`static DBHelper`	`getIns()`
`static DBHelper`	`getIns(String type)` 使用该函数获取DBHelper对象。
`Object`	`getLastId()`
`ResultSet`	`getPrepareRS(String sql, Object obj)` 根据sql和参数进行查询
`ResultSet`	`getPrepareRS(String sql, Object a, Object b)`
`ResultSet`	`getRS(String sql)`
`ResultSet`	`getRS(String sql, List<Object> params)`
`List<DBHelper.TableInfo>`	`getTables()`
`int`	`getVal(String sql, String column)`
`String`	`keyColumn(String tb)` 获取表的主键
`HashMap<String,ColumnDesc>`	`listColumn(String tb)` 列举表中的所有字段，获取表结构
`HashMap<String,ColumnDesc>`	`listColumn(String tb, boolean useCache)` 返回表格中所有的列，以及列的注释（这个注释可以用于显示）
`protected void`	`printParams(String sql, List<Object> params)`
`HashMap<String,ColumnDesc>`	`readColumnDesc(String tb)` 尝试从文件中存储预存的表结构（仅应用与某些无法直接获取表结构的场景）
`static void`	`removeThreadLocal()`
`void`	`rollback()`
`int`	`update(String sql, Object... objs)`
`int`	`updateWithArray(String sql, Object[] objs)`

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

字段详细资料
- DB_MYSQL
```
public static final String DB_MYSQL
```
  另请参阅:
  
  常量字段值
- DB_POSTGRES
```
public static final String DB_POSTGRES
```
  另请参阅:
  
  常量字段值
- useCache
```
public static boolean useCache
```
- con
```
protected Connection con
```
- last_id
```
protected Object last_id
```
- useConfigFile
```
public static boolean useConfigFile
```
  是否需要尝试读取源文件根目录下的tbconfig目录下的表格式文件。生成方法：使用 java -jar yangmvc-1.9-all.jar 直接生成此目录，将tbconfig整个目录拷贝到src目录下即可。如果不需要尝试读取ConfigFile可以将这个变量置为false

构造器详细资料
- DBHelper
```
public DBHelper()
```

方法详细资料

getIns
```
public static DBHelper getIns(String type)
```
使用该函数获取DBHelper对象。本类的设计为同一个线程公用一个DBHelper

参数:

type - 数据库类型

返回:

DBHelper对象

getIns
```
public static DBHelper getIns()
```

getConnection
```
public Connection getConnection()
```

disableCache
```
public static void disableCache()
```

removeThreadLocal

public static void removeThreadLocal()

conn
```
public abstract void conn()
```
连接数据库

getFKey

public void getFKey(String table,
                    HashMap<String,ColumnDesc> map)
             throws SQLException

获取该表的外键信息

参数:: table - 表名; map - 字段描述
抛出:: SQLException - 数据库异常

getPrepareRS

public ResultSet getPrepareRS(String sql,
                              Object obj)
                       throws SQLException

根据sql和参数进行查询

参数:: sql - SQL语句; obj - 参数
返回:: 结果集
抛出:: SQLException - 数据库异常

getPrepareRS

public ResultSet getPrepareRS(String sql,
                              Object a,
                              Object b)
                       throws SQLException

抛出:: SQLException

getRS

public ResultSet getRS(String sql)
                throws SQLException

抛出:: SQLException

getTables

public List<DBHelper.TableInfo> getTables()

columeOfRs

public HashMap<String,ColumnDesc> columeOfRs(String sql,
                                             ResultSet rs)

列举sql返回的所有的行

参数:: sql - SQL语句; rs - 结果集
返回:: 字段描述map

clearDescCache
```
public void clearDescCache()
```

getLastId
```
public Object getLastId()
```

updateWithArray

public int updateWithArray(String sql,
                           Object[] objs)

update

public int update(String sql,
                  Object... objs)

close
```
public void close()
```

listColumn
```
public HashMap<String,ColumnDesc> listColumn(String tb)
```
列举表中的所有字段，获取表结构

参数:

tb - 表名

返回:

字段描述信息

readColumnDesc
```
public HashMap<String,ColumnDesc> readColumnDesc(String tb)
```
尝试从文件中存储预存的表结构（仅应用与某些无法直接获取表结构的场景）

参数:

tb - 表名

返回:

字段描述信息

listColumn
```
public HashMap<String,ColumnDesc> listColumn(String tb,
                                             boolean useCache)
```
返回表格中所有的列，以及列的注释（这个注释可以用于显示）

参数:

tb - 表格名称

useCache - 是否使用缓存

返回:

列名->注释的映射表

keyColumn
```
public String keyColumn(String tb)
```
获取表的主键

参数:

tb - 表名

返回:

主键名称

getVal

public int getVal(String sql,
                  String column)

finalize

protected void finalize()
                 throws Throwable

覆盖:: finalize 在类中 Object
抛出:: Throwable

printParams

protected void printParams(String sql,
                           List<Object> params)

getRS

public ResultSet getRS(String sql,
                       List<Object> params)
                throws SQLException

抛出:: SQLException

beginTransation
```
public void beginTransation()
```
启动事务，所有提交在sql会在调用commit后被执行。

commit
```
public void commit()
```

rollback
```
public void rollback()
```

类 DBHelper

嵌套类概要

字段概要

构造器概要

方法概要

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

字段详细资料

DB_MYSQL

DB_POSTGRES

useCache

con

last_id

useConfigFile

构造器详细资料

DBHelper

方法详细资料

getIns

getIns

getConnection

disableCache

removeThreadLocal

conn

getFKey

getPrepareRS

getPrepareRS

getRS

getTables

columeOfRs

clearDescCache

getLastId

updateWithArray

update

close

listColumn

readColumnDesc

listColumn

keyColumn

getVal

finalize

printParams

getRS

beginTransation

commit

rollback