org.jooq.util
Interface TableDefinition

All Superinterfaces:

Definition

All Known Subinterfaces:

MasterDataTableDefinition

All Known Implementing Classes:

AbstractTableDefinition, ASETableDefinition, CUBRIDTableDefinition, DB2TableDefinition, DefaultMasterDataTableDefinition, DerbyTableDefinition, H2TableDefinition, HSQLDBTableDefinition, IngresTableDefinition, MySQLTableDefinition, OracleTableDefinition, PostgresTableDefinition, SQLiteTableDefinition, SQLServerTableDefinition, SybaseTableDefinition

public interface TableDefinition
extends Definition

The definition of a table or view.

Author:

Lukas Eder

Method Summary

ColumnDefinition	getColumn(int columnIndex) Get a column in this type by its index (starting at 0)
ColumnDefinition	getColumn(String columnName) Get a column in this type by its name
ColumnDefinition	getColumn(String columnName, boolean ignoreCase) Get a column in this type by its name
List<ColumnDefinition>	getColumns() All columns in the type, table or view
List<ForeignKeyDefinition>	getForeignKeys() Get the foreign keys for this table
ColumnDefinition	getIdentity() Get the IDENTITY column of this table, or null, if no such column exists.
UniqueKeyDefinition	getMainUniqueKey() Get the primary key or the main unique key for this table
org.jooq.Table<org.jooq.Record>	getTable() This TableDefinition as a Table
List<UniqueKeyDefinition>	getUniqueKeys() Get the unique keys for this table

Methods inherited from interface org.jooq.util.Definition

getComment, getDatabase, getDefinitionPath, getInputName, getName, getOutputName, getOverload, getQualifiedInputName, getQualifiedName, getQualifiedOutputName, getSchema

Method Detail

getColumns

List<ColumnDefinition> getColumns()

All columns in the type, table or view

getColumn

ColumnDefinition getColumn(String columnName)

Get a column in this type by its name

getColumn

ColumnDefinition getColumn(String columnName,
                           boolean ignoreCase)

Get a column in this type by its name

getColumn

ColumnDefinition getColumn(int columnIndex)

Get a column in this type by its index (starting at 0)

getMainUniqueKey

UniqueKeyDefinition getMainUniqueKey()

Get the primary key or the main unique key for this table

getUniqueKeys

List<UniqueKeyDefinition> getUniqueKeys()

Get the unique keys for this table

getForeignKeys

List<ForeignKeyDefinition> getForeignKeys()

Get the foreign keys for this table

getIdentity

ColumnDefinition getIdentity()

Get the IDENTITY column of this table, or null, if no such column exists.

getTable

org.jooq.Table<org.jooq.Record> getTable()

This TableDefinition as a Table