Module org.jooq

Package org.jooq

Interface ForeignKey<R extends Record,O extends Record>

Type Parameters:

R - The FOREIGN KEY's owner table record

O - The referenced KEY's owner table record

All Superinterfaces:

Key<R>, Serializable

public interface ForeignKey<R extends Record,O extends Record>
extends Key<R>

A ForeignKey is an object referencing a UniqueKey. It represents a FOREIGN KEY relationship between two tables.

Instances of this type cannot be created directly. They are available from generated code.

Author:

Lukas Eder

Method Summary

Modifier and Type	Method	Description
Result<R>	fetchChildren(Collection<? extends O> records)	Fetch child records of a given set of records through this foreign key
Result<R>	fetchChildren(O record)	Fetch child records of a given record through this foreign key
Result<R>	fetchChildren(O... records)	Fetch child records of a given set of records through this foreign key
O	fetchParent(R record)	Fetch a parent record of a given record through this foreign key
Result<O>	fetchParents(Collection<? extends R> records)	Fetch parent records of a given set of record through this foreign key
Result<O>	fetchParents(R... records)	Fetch parent records of a given set of record through this foreign key
UniqueKey<O>	getKey()	The referenced Key

Methods inherited from interface org.jooq.Key

constraint, getFields, getFieldsArray, getName, getTable

Method Detail

getKey

UniqueKey<O> getKey()

The referenced Key

fetchParent

O fetchParent(R record)
       throws DataAccessException

Fetch a parent record of a given record through this foreign key

This returns a parent record referenced by a given record through this foreign key. If no parent record was found, this returns null

Throws:

DataAccessException - if something went wrong executing the query

See Also:

TableRecord.fetchParent(ForeignKey)

fetchParents

Result<O> fetchParents(R... records)
                throws DataAccessException

Fetch parent records of a given set of record through this foreign key

This returns parent records referenced by any record in a given set of records through this foreign key.

Throws:

DataAccessException - if something went wrong executing the query

See Also:

TableRecord.fetchParent(ForeignKey)

fetchParents

Result<O> fetchParents(Collection<? extends R> records)
                throws DataAccessException

Fetch parent records of a given set of record through this foreign key

This returns parent records referenced by any record in a given set of records through this foreign key.

Throws:

DataAccessException - if something went wrong executing the query

See Also:

TableRecord.fetchParent(ForeignKey)

fetchChildren

Result<R> fetchChildren(O record)
                 throws DataAccessException

Fetch child records of a given record through this foreign key

This returns childs record referencing a given record through this foreign key

Throws:

DataAccessException - if something went wrong executing the query

See Also:

UpdatableRecord.fetchChild(ForeignKey), UpdatableRecord.fetchChildren(ForeignKey)

fetchChildren

Result<R> fetchChildren(O... records)
                 throws DataAccessException

Fetch child records of a given set of records through this foreign key

This returns childs record referencing any record in a given set of records through this foreign key

Throws:

DataAccessException - if something went wrong executing the query

See Also:

UpdatableRecord.fetchChild(ForeignKey), UpdatableRecord.fetchChildren(ForeignKey)

fetchChildren

Result<R> fetchChildren(Collection<? extends O> records)
                 throws DataAccessException

Fetch child records of a given set of records through this foreign key

This returns childs record referencing any record in a given set of records through this foreign key

Throws:

DataAccessException - if something went wrong executing the query

See Also:

UpdatableRecord.fetchChild(ForeignKey), UpdatableRecord.fetchChildren(ForeignKey)