接口 TableInformation
-
- 所有已知实现类:
TableInformationImpl
public interface TableInformationProvides access to information about existing tables in the database- 作者:
- Christoph Sturm, Max Rydahl Andersen, Steve Ebersole
-
-
方法概要
所有方法 实例方法 抽象方法 修饰符和类型 方法 说明 voidaddColumn(ColumnInformation columnIdentifier)ColumnInformationgetColumn(Identifier columnIdentifier)Retrieve the named ColumnInformationStringgetComment()Get the comments/remarks defined for the table.ForeignKeyInformationgetForeignKey(Identifier keyName)Retrieve the named ForeignKeyInformationIterable<ForeignKeyInformation>getForeignKeys()Obtain an iterable over all the table's defined foreign keys.IndexInformationgetIndex(Identifier indexName)Retrieve the named IndexInformationIterable<IndexInformation>getIndexes()Obtain an iterable over all the table's defined indexes.QualifiedTableNamegetName()Get the qualified name of the table.PrimaryKeyInformationgetPrimaryKey()Retrieve information about the table's primary key, if one is defined (aka, may returnnull).booleanisPhysicalTable()Does this information describe a physical table as opposed to a view, etc?
-
-
-
方法详细资料
-
getName
QualifiedTableName getName()
Get the qualified name of the table.- 返回:
- The qualified table name
-
isPhysicalTable
boolean isPhysicalTable()
Does this information describe a physical table as opposed to a view, etc?- 返回:
trueif this is a physical table;falseotherwise.
-
getComment
String getComment()
Get the comments/remarks defined for the table.- 返回:
- The table comments
-
getColumn
ColumnInformation getColumn(Identifier columnIdentifier)
Retrieve the named ColumnInformation- 参数:
columnIdentifier- The column identifier (simple name)- 返回:
- The matching column information. May return
null
-
getPrimaryKey
PrimaryKeyInformation getPrimaryKey()
Retrieve information about the table's primary key, if one is defined (aka, may returnnull).- 返回:
- The primary key information, or
nullif the table did not define a primary key.
-
getForeignKeys
Iterable<ForeignKeyInformation> getForeignKeys()
Obtain an iterable over all the table's defined foreign keys.- 返回:
- The iterable.
-
getForeignKey
ForeignKeyInformation getForeignKey(Identifier keyName)
Retrieve the named ForeignKeyInformation- 参数:
keyName- The foreign key identifier (simple name)- 返回:
- The matching foreign key information. May return
null
-
getIndexes
Iterable<IndexInformation> getIndexes()
Obtain an iterable over all the table's defined indexes.- 返回:
- The iterable.
-
getIndex
IndexInformation getIndex(Identifier indexName)
Retrieve the named IndexInformation- 参数:
indexName- The index identifier (simple name)- 返回:
- The matching index information. May return
null
-
addColumn
void addColumn(ColumnInformation columnIdentifier)
-
-