Module org.jooq

Package org.jooq

Interface ForeignKey<CHILD extends Record,PARENT extends Record>

Type Parameters:

CHILD - The FOREIGN KEY's owner table record

PARENT - The referenced KEY's owner table record

All Superinterfaces:

Key<CHILD>, Named, QueryPart, Serializable

public interface ForeignKey<CHILD extends Record,PARENT extends Record>
extends Key<CHILD>

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
@NotNull Table<CHILD>	children(Collection<? extends PARENT> records)	Get a table expression representing the children of a record, given this foreign key.
@NotNull Table<CHILD>	children(PARENT record)	Get a table expression representing the children of a record, given this foreign key.
@NotNull Table<CHILD>	children(PARENT... records)	Get a table expression representing the children of a record, given this foreign key.
@NotNull Result<CHILD>	fetchChildren(Collection<? extends PARENT> records)	Fetch child records of a given set of records through this foreign key
@NotNull Result<CHILD>	fetchChildren(PARENT record)	Fetch child records of a given record through this foreign key
@NotNull Result<CHILD>	fetchChildren(PARENT... records)	Fetch child records of a given set of records through this foreign key
PARENT	fetchParent(CHILD record)	Fetch a parent record of a given record through this foreign key
@NotNull Result<PARENT>	fetchParents(CHILD... records)	Fetch parent records of a given set of record through this foreign key
@NotNull Result<PARENT>	fetchParents(Collection<? extends CHILD> records)	Fetch parent records of a given set of record through this foreign key
@Nullable QOM.ForeignKeyRule	getDeleteRule()	The foreign key's ON DELETE rule, or null if it's not specified, which defaults to QOM.ForeignKeyRule.NO_ACTION.
@NotNull InverseForeignKey<PARENT,CHILD>	getInverseKey()	The inverse key.
@NotNull UniqueKey<PARENT>	getKey()	The referenced UniqueKey.
@NotNull List<TableField<PARENT,?>>	getKeyFields()	The fields that make up the referenced UniqueKey.
@NotNull TableField<PARENT,?> @NotNull []	getKeyFieldsArray()	The fields that make up the referenced UniqueKey.
@Nullable QOM.ForeignKeyRule	getUpdateRule()	The foreign key's ON UPDATE rule, or null if it's not specified, which defaults to QOM.ForeignKeyRule.NO_ACTION.
@NotNull Table<PARENT>	parent(CHILD record)	Get a table expression representing the parent of a record, given this foreign key.
@NotNull Table<PARENT>	parents(CHILD... records)	Get a table expression representing the parents of a record, given this foreign key.
@NotNull Table<PARENT>	parents(Collection<? extends CHILD> records)	Get a table expression representing the parents of a record, given this foreign key.

Methods inherited from interface org.jooq.Key

constraint, enforced, getFields, getFieldsArray, getTable, nullable

Methods inherited from interface org.jooq.Named

$name, getComment, getCommentPart, getName, getQualifiedName, getUnqualifiedName

Methods inherited from interface org.jooq.QueryPart

$replace, $replace, $traverse, $traverse, equals, hashCode, toString

Method Details

getDeleteRule

@Nullable
@Nullable QOM.ForeignKeyRule getDeleteRule()

The foreign key's ON DELETE rule, or null if it's not specified, which defaults to QOM.ForeignKeyRule.NO_ACTION.

getUpdateRule

@Nullable
@Nullable QOM.ForeignKeyRule getUpdateRule()

The foreign key's ON UPDATE rule, or null if it's not specified, which defaults to QOM.ForeignKeyRule.NO_ACTION.

getInverseKey

@NotNull
@NotNull InverseForeignKey<PARENT,CHILD> getInverseKey()

The inverse key.

getKey

@NotNull
@NotNull UniqueKey<PARENT> getKey()

The referenced UniqueKey.

getKeyFields

@NotNull
@NotNull List<TableField<PARENT,?>> getKeyFields()

The fields that make up the referenced UniqueKey.

This returns the order in which the fields of getKey() are referenced, which is usually the same as the fields of Key.getFields(), but not necessarily so.

getKeyFieldsArray

@NotNull
@NotNull TableField<PARENT,?> @NotNull [] getKeyFieldsArray()

The fields that make up the referenced UniqueKey.

This returns the order in which the fields of getKey() are referenced, which is usually the same as the fields of Key.getFieldsArray(), but not necessarily so.

See Also:

• getKeyFields()

fetchParent

@Nullable
@Blocking
PARENT fetchParent(CHILD 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, as if fetching from parent(Record). If no parent record was found, this returns null

Throws:

DataAccessException - if something went wrong executing the query

See Also:

• TableRecord.fetchParent(ForeignKey)

fetchParents

@NotNull
@Blocking
@NotNull Result<PARENT> fetchParents(CHILD... 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, as if fetching from parents(Record...).

Throws:

DataAccessException - if something went wrong executing the query

See Also:

• TableRecord.fetchParent(ForeignKey)

fetchParents

@NotNull
@Blocking
@NotNull Result<PARENT> fetchParents(Collection<? extends CHILD> 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, as if fetching from parents(Collection).

Throws:

DataAccessException - if something went wrong executing the query

See Also:

• TableRecord.fetchParent(ForeignKey)

fetchChildren

@NotNull
@Blocking
@NotNull Result<CHILD> fetchChildren(PARENT 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, as if fetching from children(Record).

Throws:

DataAccessException - if something went wrong executing the query

See Also:

• UpdatableRecord.fetchChild(ForeignKey)
• UpdatableRecord.fetchChildren(ForeignKey)

fetchChildren

@NotNull
@Blocking
@NotNull Result<CHILD> fetchChildren(PARENT... 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, as if fetching from children(Record...).

Throws:

DataAccessException - if something went wrong executing the query

See Also:

• UpdatableRecord.fetchChild(ForeignKey)
• UpdatableRecord.fetchChildren(ForeignKey)

fetchChildren

@NotNull
@Blocking
@NotNull Result<CHILD> fetchChildren(Collection<? extends PARENT> 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, as if fetching from children(Collection).

Throws:

DataAccessException - if something went wrong executing the query

See Also:

• UpdatableRecord.fetchChild(ForeignKey)
• UpdatableRecord.fetchChildren(ForeignKey)

parent

@NotNull
@NotNull Table<PARENT> parent(CHILD record)

Get a table expression representing the parent of a record, given this foreign key.

parents

@NotNull
@NotNull Table<PARENT> parents(CHILD... records)

Get a table expression representing the parents of a record, given this foreign key.

parents

@NotNull
@NotNull Table<PARENT> parents(Collection<? extends CHILD> records)

Get a table expression representing the parents of a record, given this foreign key.

children

@NotNull
@NotNull Table<CHILD> children(PARENT record)

Get a table expression representing the children of a record, given this foreign key.

children

@NotNull
@NotNull Table<CHILD> children(PARENT... records)

Get a table expression representing the children of a record, given this foreign key.

children

@NotNull
@NotNull Table<CHILD> children(Collection<? extends PARENT> records)

Get a table expression representing the children of a record, given this foreign key.