TableInfo (mybatis-plus-core 3.5.3.1 API)

java.lang.Object
- com.baomidou.mybatisplus.core.metadata.TableInfo

所有已实现的接口:

Constants, StringPool, java.io.Serializable
```
public class TableInfo
extends java.lang.Object
implements Constants
```
数据库表反射信息

从以下版本开始:

2016-01-23

作者:

hubin

另请参阅:

序列化表格

字段概要
- 从接口继承的字段 com.baomidou.mybatisplus.core.toolkit.Constants
  AES, AES_CBC_CIPHER, ARRAY, AS, ASC, COLL, COLLECTION, COLUMN_MAP, COLUMN_MAP_IS_EMPTY, DESC, ENTITY, ENTITY_DOT, LIMIT, LIST, MD5, MP_OPTLOCK_VERSION_ORIGINAL, MYBATIS_PLUS, ORDER_BY, Q_WRAPPER_SQL_COMMENT, Q_WRAPPER_SQL_FIRST, Q_WRAPPER_SQL_SELECT, U_WRAPPER_SQL_SET, WHERE, WRAPPER, WRAPPER_DOT, WRAPPER_EMPTYOFNORMAL, WRAPPER_EMPTYOFWHERE, WRAPPER_ENTITY, WRAPPER_ENTITY_DOT, WRAPPER_EXPRESSION_ORDER, WRAPPER_NONEMPTYOFENTITY, WRAPPER_NONEMPTYOFNORMAL, WRAPPER_NONEMPTYOFWHERE, WRAPPER_PARAM, WRAPPER_PARAM_MIDDLE, WRAPPER_SQLSEGMENT
- 从接口继承的字段 com.baomidou.mybatisplus.core.toolkit.StringPool
  AMPERSAND, AND, ASTERISK, AT, BACK_SLASH, BACKTICK, BYTES_NEW_LINE, COLON, COMMA, CRLF, DASH, DOLLAR, DOLLAR_LEFT_BRACE, DOT, DOT_CLASS, DOT_JAVA, DOT_NEWLINE, DOT_XML, DOTDOT, EMPTY, EMPTY_ARRAY, EQUALS, EXCLAMATION_MARK, FALSE, HASH, HASH_LEFT_BRACE, HAT, HTML_AMP, HTML_GT, HTML_LT, HTML_NBSP, HTML_QUOTE, ISO_8859_1, LEFT_BRACE, LEFT_BRACKET, LEFT_CHEV, LEFT_SQ_BRACKET, N, NEWLINE, NO, NULL, NUM, OFF, ON, ONE, PERCENT, PIPE, PLUS, QUESTION_MARK, QUOTE, RETURN, RIGHT_BRACE, RIGHT_BRACKET, RIGHT_CHEV, RIGHT_SQ_BRACKET, SEMICOLON, SINGLE_QUOTE, SLASH, SPACE, SQL, STAR, TAB, TILDA, TRUE, UNDERSCORE, US_ASCII, UTF_8, Y, YES, ZERO

构造器概要

构造器
构造器和说明

TableInfo(org.apache.ibatis.session.Configuration configuration, java.lang.Class<?> entityType)

构造器
构造器和说明
`TableInfo(org.apache.ibatis.session.Configuration configuration, java.lang.Class<?> entityType)`

方法概要

所有方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`protected boolean`	`canEqual(java.lang.Object other)`
`java.lang.String`	`chooseSelect(java.util.function.Predicate<TableFieldInfo> predicate)` 获取需要进行查询的 select sql 片段
`boolean`	`equals(java.lang.Object o)`
`protected java.lang.String`	`formatLogicDeleteSql(boolean isWhere)` format logic delete SQL, can be overrided by subclass github #1386
`java.lang.String`	`getAllInsertSqlColumnMaybeIf(java.lang.String prefix)` 获取 insert 时候字段 sql 脚本片段 insert into table (字段) values (值) 位于 "字段" 部位自动选部位,根据规则会生成 if 标签
`java.lang.String`	`getAllInsertSqlPropertyMaybeIf(java.lang.String prefix)` 获取所有 insert 时候插入值 sql 脚本片段 insert into table (字段) values (值) 位于 "值" 部位自动选部位,根据规则会生成 if 标签
`java.lang.String`	`getAllSqlSelect()` 获取包含主键及字段的 select sql 片段
`java.lang.String`	`getAllSqlSet(boolean ignoreLogicDelFiled, java.lang.String prefix)` 获取所有的 sql set 片段
`java.lang.String`	`getAllSqlWhere(boolean ignoreLogicDelFiled, boolean withId, java.lang.String prefix)` 获取所有的查询的 sql 片段
`org.apache.ibatis.session.Configuration`	`getConfiguration()` MybatisConfiguration 标记 (Configuration内存地址值)
`java.lang.String`	`getCurrentNamespace()` 命名空间 (对应的 mapper 接口的全类名)
`java.lang.Class<?>`	`getEntityType()` 实体类型
`java.util.List<TableFieldInfo>`	`getFieldList()`
`com.baomidou.mybatisplus.annotation.IdType`	`getIdType()` 表主键ID 类型
`java.lang.String`	`getKeyColumn()` 表主键ID 字段名
`java.lang.String`	`getKeyInsertSqlColumn(boolean batch, boolean newLine)` 获取 insert 时候主键 sql 脚本片段 insert into table (字段) values (值) 位于 "字段" 部位
`java.lang.String`	`getKeyInsertSqlProperty(boolean batch, java.lang.String prefix, boolean newLine)` 获取 insert 时候主键 sql 脚本片段 insert into table (字段) values (值) 位于 "值" 部位
`java.lang.String`	`getKeyProperty()` 表主键ID 属性名
`com.baomidou.mybatisplus.annotation.KeySequence`	`getKeySequence()` 表主键ID Sequence
`java.lang.String`	`getKeySqlSelect()` 获取主键的 select sql 片段
`java.lang.Class<?>`	`getKeyType()` 表主键ID 属性类型
`TableFieldInfo`	`getLogicDeleteFieldInfo()` 逻辑删除字段
`java.lang.String`	`getLogicDeleteSql(boolean startWithAnd, boolean isWhere)` 获取逻辑删除字段的 sql 脚本
`java.util.List<TableFieldInfo>`	`getOrderByFields()`
`java.lang.Object`	`getPropertyValue(java.lang.Object entity, java.lang.String property)` 获取对象属性值
`org.apache.ibatis.reflection.Reflector`	`getReflector()`
`java.lang.String`	`getResultMap()` 表映射结果集
`java.lang.String`	`getSqlStatement(java.lang.String sqlMethod)` 已过时。 3.4.0 如果存在的多mapper共用一个实体的情况，这里可能会出现获取命名空间错误的情况
`java.lang.String`	`getTableName()` 表名称
`TableFieldInfo`	`getVersionFieldInfo()` 乐观锁字段
`int`	`hashCode()`
`boolean`	`havePK()` 是否有主键
`boolean`	`isAutoInitResultMap()` 是否是需要自动生成的 resultMap
`boolean`	`isKeyRelated()` 主键是否有存在字段名与属性名关联 true: 表示要进行 as
`boolean`	`isLogicDelete()` 已过时。
`boolean`	`isUnderCamel()` 是否开启下划线转驼峰未注解指定字段名的情况下,用于自动从 property 推算 column 的命名
`boolean`	`isWithInsertFill()` 表字段是否启用了插入填充
`boolean`	`isWithLogicDelete()` 表字段是否启用了逻辑删除
`boolean`	`isWithUpdateFill()` 表字段是否启用了更新填充
`boolean`	`isWithVersion()` 表字段是否启用了乐观锁
`<T> T`	`newInstance()` 创建实例
`TableInfo`	`setOrderByFields(java.util.List<TableFieldInfo> orderByFields)` 排序列表
`void`	`setPropertyValue(java.lang.Object entity, java.lang.String property, java.lang.Object... values)` 设置对象属性值
`java.lang.String`	`toString()`

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

- 构造器详细资料
  - TableInfo
```
public TableInfo(org.apache.ibatis.session.Configuration configuration,
                 java.lang.Class<?> entityType)
```
    参数:
    
    configuration - 配置对象
    
    entityType - 实体类型
    
    从以下版本开始:
    
    3.4.4
- 方法详细资料
  - getSqlStatement
```
@Deprecated
public java.lang.String getSqlStatement(java.lang.String sqlMethod)
```
    已过时。 3.4.0 如果存在的多mapper共用一个实体的情况，这里可能会出现获取命名空间错误的情况
    
    获得注入的 SQL Statement
    
    参数:
    
    sqlMethod - MybatisPlus 支持 SQL 方法
    
    返回:
    
    SQL Statement
  - havePK
```
public boolean havePK()
```
    是否有主键
    
    返回:
    
    是否有
  - getKeySqlSelect
```
public java.lang.String getKeySqlSelect()
```
    获取主键的 select sql 片段
    
    返回:
    
    sql 片段
  - getAllSqlSelect
```
public java.lang.String getAllSqlSelect()
```
    获取包含主键及字段的 select sql 片段
    
    返回:
    
    sql 片段
  - chooseSelect
```
public java.lang.String chooseSelect(java.util.function.Predicate<TableFieldInfo> predicate)
```
    获取需要进行查询的 select sql 片段
    
    参数:
    
    predicate - 过滤条件
    
    返回:
    
    sql 片段
  - getKeyInsertSqlProperty
```
public java.lang.String getKeyInsertSqlProperty(boolean batch,
                                                java.lang.String prefix,
                                                boolean newLine)
```
    获取 insert 时候主键 sql 脚本片段
    insert into table (字段) values (值)
    
    位于 "值" 部位
    
    返回:
    
    sql 脚本片段
  - getKeyInsertSqlColumn
```
public java.lang.String getKeyInsertSqlColumn(boolean batch,
                                              boolean newLine)
```
    获取 insert 时候主键 sql 脚本片段
    insert into table (字段) values (值)
    
    位于 "字段" 部位
    
    返回:
    
    sql 脚本片段
  - getAllInsertSqlPropertyMaybeIf
```
public java.lang.String getAllInsertSqlPropertyMaybeIf(java.lang.String prefix)
```
    获取所有 insert 时候插入值 sql 脚本片段
    insert into table (字段) values (值)
    
    位于 "值" 部位
  - 自动选部位,根据规则会生成 if 标签

返回:: sql 脚本片段

getAllInsertSqlColumnMaybeIf
```
public java.lang.String getAllInsertSqlColumnMaybeIf(java.lang.String prefix)
```
获取 insert 时候字段 sql 脚本片段
insert into table (字段) values (值)

位于 "字段" 部位
自动选部位,根据规则会生成 if 标签

类 TableInfo

字段概要

从接口继承的字段 com.baomidou.mybatisplus.core.toolkit.Constants

从接口继承的字段 com.baomidou.mybatisplus.core.toolkit.StringPool

构造器概要

方法概要

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

构造器详细资料

TableInfo

方法详细资料

getSqlStatement

havePK

getKeySqlSelect

getAllSqlSelect

chooseSelect

getKeyInsertSqlProperty

getKeyInsertSqlColumn

getAllInsertSqlPropertyMaybeIf

getAllInsertSqlColumnMaybeIf

getAllSqlWhere

getAllSqlSet

getLogicDeleteSql

formatLogicDeleteSql

getFieldList

getOrderByFields

isLogicDelete

getPropertyValue

setPropertyValue

newInstance

getEntityType

getIdType

getTableName

getResultMap

isAutoInitResultMap

isKeyRelated

getKeyColumn

getKeyProperty

getKeyType

getKeySequence

getCurrentNamespace

isUnderCamel

equals

canEqual

hashCode

toString

getConfiguration

isWithInsertFill

isWithUpdateFill

isWithLogicDelete

getLogicDeleteFieldInfo

isWithVersion

getVersionFieldInfo

setOrderByFields

getReflector