Module org.jooq.meta

Package org.jooq.meta

Interface TableDefinition

All Superinterfaces:

Definition

All Known Implementing Classes:

AbstractTableDefinition, CUBRIDTableDefinition, DefaultMetaTableDefinition, DerbyTableDefinition, FirebirdTableDefinition, FirebirdTableValuedFunction, H2TableDefinition, HSQLDBTableDefinition, HSQLDBTableValuedFunction, MySQLTableDefinition, PostgresMaterializedViewDefinition, PostgresTableDefinition, PostgresTableValuedFunction, SQLiteTableDefinition, XMLTableDefinition

public interface TableDefinition
extends Definition

The definition of a table or view.

Author:

Lukas Eder

Method Summary

Modifier and Type	Method	Description
List<CheckConstraintDefinition>	getCheckConstraints()	Get the CHECK constraints for this table.
List<TableDefinition>	getChildTables()	Get the child tables if table inheritance is applicable.
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<ColumnDefinition>	getColumnsIncludingHidden()	All columns in the type, table or view, including hidden columns.
List<EmbeddableDefinition>	getEmbeddables()	All embeddable types in this defining table.
List<ForeignKeyDefinition>	getForeignKeys()	Get the foreign keys for this table.
List<ForeignKeyDefinition>	getForeignKeys(TableDefinition referenced)	Get the foreign keys for this table referencing a specific table.
IdentityDefinition	getIdentity()	Get the IDENTITY column of this table, or null, if no such column exists.
List<IndexDefinition>	getIndexes()	Get the indexes for this table.
List<InverseForeignKeyDefinition>	getInverseForeignKeys()	Get the inverse foreign keys for this table.
List<InverseForeignKeyDefinition>	getInverseForeignKeys(TableDefinition referencing)	Get the inverse foreign keys for this table referenced from a specific table.
UniqueKeyDefinition	getKey(String name)	Get the unique key or primary key for this table by name.
List<UniqueKeyDefinition>	getKeys()	Get the unique keys and primary keys for this table.
List<ManyToManyKeyDefinition>	getManyToManyKeys()	Get the many to many keys for this table.
List<ManyToManyKeyDefinition>	getManyToManyKeys(TableDefinition referencing)	Get the many to many keys for this table referencing another, specific table.
List<ParameterDefinition>	getParameters()	The parameters of this table if this is a table-valued function.
TableDefinition	getParentTable()	Get the parent table if table inheritance is applicable.
UniqueKeyDefinition	getPrimaryKey()	Get the primary key for this table.
List<EmbeddableDefinition>	getReferencedEmbeddables()	All embeddable types in this referencing table.
@NotNull TableDefinition	getReferencedTable()	Deprecated. - [#7406] - 3.20.0 - Use getReferencedTableOrUDT() instead.
@NotNull Definition	getReferencedTableOrUDT()	The referenced table or UDT type, if this isTableValuedFunction().
Table<Record>	getTable()	This TableDefinition as a Table.
TableOptions	getTableOptions()	The TableOptions providing additional information about the table.
UniqueKeyDefinition	getUniqueKey(String name)	Get the unique key for this table by name.
List<UniqueKeyDefinition>	getUniqueKeys()	Get the unique keys for this table.
boolean	isMaterializedView()	Whether this table is a materialized view.
boolean	isSynthetic()	Whether this table is a synthetic table (e.g.
boolean	isTableValuedFunction()	Whether this table is a table-valued function.
boolean	isTemporary()	Whether this table is a temporary table.
boolean	isView()	Whether this table is a view.

Methods inherited from interface org.jooq.meta.Definition

getCatalog, getComment, getDatabase, getDefinitionPath, getInputName, getName, getOutputName, getOverload, getPackage, getPartiallyQualifiedNames, getQualifiedInputName, getQualifiedInputNamePart, getQualifiedName, getQualifiedNamePart, getQualifiedOutputName, getQualifiedOutputNamePart, getSchema, getSource

Method Details

getColumns

List<ColumnDefinition> getColumns()

All columns in the type, table or view.

getColumnsIncludingHidden

List<ColumnDefinition> getColumnsIncludingHidden()

All columns in the type, table or view, including hidden columns.

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).

isSynthetic

boolean isSynthetic()

Whether this table is a synthetic table (e.g. a synthetic view).

Specified by:

isSynthetic in interface Definition

getEmbeddables

List<EmbeddableDefinition> getEmbeddables()

All embeddable types in this defining table.

getReferencedEmbeddables

List<EmbeddableDefinition> getReferencedEmbeddables()

All embeddable types in this referencing table.

getIndexes

List<IndexDefinition> getIndexes()

Get the indexes for this table.

getPrimaryKey

UniqueKeyDefinition getPrimaryKey()

Get the primary key for this table.

getUniqueKeys

List<UniqueKeyDefinition> getUniqueKeys()

Get the unique keys for this table.

getUniqueKey

UniqueKeyDefinition getUniqueKey(String name)

Get the unique key for this table by name.

getKeys

List<UniqueKeyDefinition> getKeys()

Get the unique keys and primary keys for this table.

getKey

UniqueKeyDefinition getKey(String name)

Get the unique key or primary key for this table by name.

getForeignKeys

List<ForeignKeyDefinition> getForeignKeys()

Get the foreign keys for this table.

getForeignKeys

List<ForeignKeyDefinition> getForeignKeys(TableDefinition referenced)

Get the foreign keys for this table referencing a specific table.

getInverseForeignKeys

List<InverseForeignKeyDefinition> getInverseForeignKeys()

Get the inverse foreign keys for this table.

getInverseForeignKeys

List<InverseForeignKeyDefinition> getInverseForeignKeys(TableDefinition referencing)

Get the inverse foreign keys for this table referenced from a specific table.

getManyToManyKeys

List<ManyToManyKeyDefinition> getManyToManyKeys()

Get the many to many keys for this table.

getManyToManyKeys

List<ManyToManyKeyDefinition> getManyToManyKeys(TableDefinition referencing)

Get the many to many keys for this table referencing another, specific 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.

getParentTable

TableDefinition getParentTable()

Get the parent table if table inheritance is applicable.

getChildTables

List<TableDefinition> getChildTables()

Get the child tables if table inheritance is applicable.

getTable

Table<Record> getTable()

This TableDefinition as a Table.

getTableOptions

TableOptions getTableOptions()

The TableOptions providing additional information about the table.

getParameters

List<ParameterDefinition> getParameters()

The parameters of this table if this is a table-valued function.

isTemporary

boolean isTemporary()

Whether this table is a temporary table.

isView

boolean isView()

Whether this table is a view.

isMaterializedView

boolean isMaterializedView()

Whether this table is a materialized view.

isTableValuedFunction

boolean isTableValuedFunction()

Whether this table is a table-valued function.

getReferencedTable

@Deprecated
@NotNull
@NotNull TableDefinition getReferencedTable()

Deprecated.

- [#7406] - 3.20.0 - Use getReferencedTableOrUDT() instead.

The referenced table type, if this isTableValuedFunction().

This returns:

• this, if isTableValuedFunction() == false
• this, if isTableValuedFunction() == true but the table valued function doesn't reference a table type
• Another table, if isTableValuedFunction() == true and the table valued function references a table type

getReferencedTableOrUDT

@NotNull
@NotNull Definition getReferencedTableOrUDT()

The referenced table or UDT type, if this isTableValuedFunction().

This returns:

• this, if isTableValuedFunction() == false
• this, if isTableValuedFunction() == true but the table valued function doesn't reference a table type
• Another TableDefinition or UDTDefinition, if isTableValuedFunction() == true and the table valued function references a table type