Module org.jooq.meta

Package org.jooq.meta

Interface Relations

All Known Implementing Classes:

DefaultRelations

public interface Relations

A model for all known Referenced Key / Referencing Key relations in the Database's schema.

Author:

Lukas Eder

Method Summary

Modifier and Type	Method	Description
List<CheckConstraintDefinition>	getCheckConstraints(TableDefinition table)	Get a list of CHECK constraints for a given table.
List<ForeignKeyDefinition>	getForeignKeys(ColumnDefinition column)	Get a list of foreign keys for a given table, that the column participates in.
List<ForeignKeyDefinition>	getForeignKeys(TableDefinition table)	Get a list of foreign keys for a given table.
List<UniqueKeyDefinition>	getKeys()	Get a list of all unique keys (including primary keys).
List<UniqueKeyDefinition>	getKeys(ColumnDefinition column)	Get a list of unique keys (including the primary key) for a given table, that the column participates in.
List<UniqueKeyDefinition>	getKeys(SchemaDefinition schema)	Get a list of all unique keys (including primary keys) for a given schema.
List<UniqueKeyDefinition>	getKeys(TableDefinition table)	Get a list of unique keys (including the primary key) for a given table.
UniqueKeyDefinition	getPrimaryKey(ColumnDefinition column)	Get the the primary for a given column, or null if that column is not part of the primary key.
List<UniqueKeyDefinition>	getUniqueKeys()	Get a list of all unique keys (not including primary keys).
List<UniqueKeyDefinition>	getUniqueKeys(ColumnDefinition column)	Get a list of unique keys (not including the primary key) for a given table, that the column participates in.
List<UniqueKeyDefinition>	getUniqueKeys(SchemaDefinition schema)	Get a list of all unique keys (not including primary keys) for a given schema.
List<UniqueKeyDefinition>	getUniqueKeys(TableDefinition table)	Get a list of unique keys (not including the primary key) for a given table.

Method Details

getPrimaryKey

UniqueKeyDefinition getPrimaryKey(ColumnDefinition column)

Get the the primary for a given column, or null if that column is not part of the primary key.

getUniqueKeys

List<UniqueKeyDefinition> getUniqueKeys(ColumnDefinition column)

Get a list of unique keys (not including the primary key) for a given table, that the column participates in.

getUniqueKeys

List<UniqueKeyDefinition> getUniqueKeys(TableDefinition table)

Get a list of unique keys (not including the primary key) for a given table.

getUniqueKeys

List<UniqueKeyDefinition> getUniqueKeys(SchemaDefinition schema)

Get a list of all unique keys (not including primary keys) for a given schema.

getUniqueKeys

List<UniqueKeyDefinition> getUniqueKeys()

Get a list of all unique keys (not including primary keys).

getKeys

List<UniqueKeyDefinition> getKeys(ColumnDefinition column)

Get a list of unique keys (including the primary key) for a given table, that the column participates in.

getKeys

List<UniqueKeyDefinition> getKeys(TableDefinition table)

Get a list of unique keys (including the primary key) for a given table.

getKeys

List<UniqueKeyDefinition> getKeys(SchemaDefinition schema)

Get a list of all unique keys (including primary keys) for a given schema.

getKeys

List<UniqueKeyDefinition> getKeys()

Get a list of all unique keys (including primary keys).

getForeignKeys

List<ForeignKeyDefinition> getForeignKeys(ColumnDefinition column)

Get a list of foreign keys for a given table, that the column participates in. Returns an empty list if the given column is not part of any foreign key.

getForeignKeys

List<ForeignKeyDefinition> getForeignKeys(TableDefinition table)

Get a list of foreign keys for a given table. Returns an empty list if the given table has no foreign keys.

getCheckConstraints

List<CheckConstraintDefinition> getCheckConstraints(TableDefinition table)

Get a list of CHECK constraints for a given table. Returns an empty list if the given table has no CHECK constraints.