cn.hutool.db.meta

Class Table

java.lang.Object

cn.hutool.db.meta.Table

All Implemented Interfaces:

Serializable, Cloneable

public class Table
extends Object
implements Serializable, Cloneable

数据库表信息

Author:

loolly

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Table(String tableName) 构造

Method Summary

Modifier and Type	Method and Description
Table	addPk(String pkColumnName) 添加主键
Table	clone()
static Table	create(String tableName)
String	getCatalog() 获取catalog
Column	getColumn(String name) 获取某列信息
Collection<Column>	getColumns() 获取所有字段元信息
String	getComment() 获取注释
List<IndexInfo>	getIndexInfoList() 获取索引信息
Set<String>	getPkNames() 获取主键列表
String	getSchema() 获取 schema
String	getTableName() 获取表名
boolean	isPk(String columnName) 给定列名是否为主键
Table	setCatalog(String catalog) 设置catalog
Table	setColumn(Column column) 设置列对象
Table	setComment(String comment) 设置注释
void	setIndexInfoList(List<IndexInfo> indexInfoList) 设置索引信息
void	setPkNames(Set<String> pkNames) 设置主键列表
Table	setSchema(String schema) 设置schema
void	setTableName(String tableName) 设置表名

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Table

public Table(String tableName)

构造

Parameters:

tableName - 表名

Method Detail

create

public static Table create(String tableName)

getSchema

public String getSchema()

获取 schema

Returns:

schema

Since:

5.4.3

setSchema

public Table setSchema(String schema)

设置schema

Parameters:

schema - schema

Returns:

this

Since:

5.4.3

getCatalog

public String getCatalog()

获取catalog

Returns:

catalog

Since:

5.4.3

setCatalog

public Table setCatalog(String catalog)

设置catalog

Parameters:

catalog - catalog

Returns:

this

Since:

5.4.3

getTableName

public String getTableName()

获取表名

Returns:

表名

setTableName

public void setTableName(String tableName)

设置表名

Parameters:

tableName - 表名

getComment

public String getComment()

获取注释

Returns:

注释

setComment

public Table setComment(String comment)

设置注释

Parameters:

comment - 注释

Returns:

this

getPkNames

public Set<String> getPkNames()

获取主键列表

Returns:

主键列表

isPk

public boolean isPk(String columnName)

给定列名是否为主键

Parameters:

columnName - 列名

Returns:

是否为主键

Since:

5.4.3

setPkNames

public void setPkNames(Set<String> pkNames)

设置主键列表

Parameters:

pkNames - 主键列表

setColumn

public Table setColumn(Column column)

设置列对象

Parameters:

column - 列对象

Returns:

自己

getColumn

public Column getColumn(String name)

获取某列信息

Parameters:

name - 列名

Returns:

列对象

Since:

4.2.2

getColumns

public Collection<Column> getColumns()

获取所有字段元信息

Returns:

字段元信息集合

Since:

4.5.8

addPk

public Table addPk(String pkColumnName)

添加主键

Parameters:

pkColumnName - 主键的列名

Returns:

自己

getIndexInfoList

public List<IndexInfo> getIndexInfoList()

获取索引信息

Returns:

索引信息

Since:

5.7.23

setIndexInfoList

public void setIndexInfoList(List<IndexInfo> indexInfoList)

设置索引信息

Parameters:

indexInfoList - 索引信息列表

Since:

5.7.23

clone

public Table clone()
            throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException