org.jooq.meta

Interface ColumnDefinition

All Superinterfaces:

Definition, TypedElementDefinition<TableDefinition>

All Known Implementing Classes:

DefaultColumnDefinition

public interface ColumnDefinition
extends TypedElementDefinition<TableDefinition>

An interface defining a column of a table.

Author:

Lukas Eder

Method Summary

Modifier and Type	Method and Description
List<ForeignKeyDefinition>	getForeignKeys() All definitions of foreign keys that this column is part of.
int	getPosition() The column position in the table.
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	isIdentity() Whether this column is the table's IDENTITY column.
boolean	isNullable() Deprecated. - [#2699] - 3.2.0 - Use DataTypeDefinition.isNullable() instead.

Methods inherited from interface org.jooq.meta.TypedElementDefinition

getContainer, getDefinedType, getType, getType

Methods inherited from interface org.jooq.meta.Definition

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

Method Detail

getPosition

int getPosition()

The column position in the table.

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.

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.

isNullable

@Deprecated
boolean isNullable()

Deprecated. - [#2699] - 3.2.0 - Use DataTypeDefinition.isNullable() instead.

Whether the column is nullable.