org.jooq.util

Interface TableDefinition

All Superinterfaces:

Definition

All Known Implementing Classes:

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

public interface TableDefinition
extends Definition

The definition of a table or view.

Author:

Lukas Eder

Method Summary

Methods

Modifier and Type	Method and Description
List<CheckConstraintDefinition>	getCheckConstraints() Get the CHECK constraints for this table.
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.
IdentityDefinition	getIdentity() Get the IDENTITY column of this table, or null, if no such column exists.
UniqueKeyDefinition	getPrimaryKey() Get the primary key for this table.
Table<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).

getPrimaryKey

UniqueKeyDefinition getPrimaryKey()

Get the primary 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.

getCheckConstraints

List<CheckConstraintDefinition> getCheckConstraints()

Get the CHECK constraints for this table.

getIdentity

IdentityDefinition getIdentity()

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

getTable

Table<Record> getTable()

This TableDefinition as a Table.