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 and 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.
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 referenced keys (primary or unique).
List<UniqueKeyDefinition>	getUniqueKeys(ColumnDefinition column) Get a list of referenced keys (primary or unique) for a given table, that the column participates in.
List<UniqueKeyDefinition>	getUniqueKeys(SchemaDefinition schema) Get a list of all referenced keys (primary or unique) for a given schema.
List<UniqueKeyDefinition>	getUniqueKeys(TableDefinition table) Get a list of referenced keys (primary or unique) for a given table.

Method Detail

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 referenced keys (primary or unique) for a given table, that the column participates in. Returns an empty list if the given column is not part of any primary key or unique key.

getUniqueKeys

List<UniqueKeyDefinition> getUniqueKeys(TableDefinition table)

Get a list of referenced keys (primary or unique) for a given table. Returns an empty list if the given table has no primary or unique keys.

getUniqueKeys

List<UniqueKeyDefinition> getUniqueKeys(SchemaDefinition schema)

Get a list of all referenced keys (primary or unique) for a given schema. Returns an empty list if the given schema has no primary or unique keys.

getUniqueKeys

List<UniqueKeyDefinition> getUniqueKeys()

Get a list of all referenced keys (primary or unique). Returns an empty list if there are no primary or unique 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.