Module org.jooq.meta

Package org.jooq.meta

Interface ColumnDefinition

All Superinterfaces:

ContainerElementDefinition<TableDefinition>, Definition, PositionedDefinition, TypedElementDefinition<TableDefinition>

All Known Implementing Classes:

DefaultColumnDefinition

public interface ColumnDefinition
extends TypedElementDefinition<TableDefinition>, PositionedDefinition

An interface defining a column of a table.

Author:

Lukas Eder

Method Summary

Modifier and Type	Method	Description
List<ForeignKeyDefinition>	getForeignKeys()	All definitions of foreign keys that this column is part of.
List<UniqueKeyDefinition>	getKeys()	All definitions of unique and primary keys that this column is part of.
UniqueKeyDefinition	getPrimaryKey()	A definition for the primary key that this column is part of, or null if this column is not part of a primary key.
List<UniqueKeyDefinition>	getUniqueKeys()	All definitions of unique keys that this column is part of.
boolean	isHidden()	Whether this column is hidden.
boolean	isIdentity()	Whether this column is the table's IDENTITY column.
boolean	isReadonly()	Whether this column is readonly.

Methods inherited from interface org.jooq.meta.ContainerElementDefinition

getContainer

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, isSynthetic

Methods inherited from interface org.jooq.meta.PositionedDefinition

getPosition

Methods inherited from interface org.jooq.meta.TypedElementDefinition

getDefinedType, getDomain, getType, getType

Method Details

getPrimaryKey

UniqueKeyDefinition getPrimaryKey()

A definition for the primary key that this column is part of, or null if this column is not part of a primary key.

getUniqueKeys

List<UniqueKeyDefinition> getUniqueKeys()

All definitions of unique keys that this column is part of.

getKeys

List<UniqueKeyDefinition> getKeys()

All definitions of unique and primary keys that this column is part of.

getForeignKeys

List<ForeignKeyDefinition> getForeignKeys()

All definitions of foreign keys that this column is part of.

isIdentity

boolean isIdentity()

Whether this column is the table's IDENTITY column.

isHidden

boolean isHidden()

Whether this column is hidden.

isReadonly

boolean isReadonly()

Whether this column is readonly.