jOOQ 3.18.7 · org.jooq.ForeignKey

Method Summary

Modifier and Type	Method and Description
public @NotNull Table<R>	children(O record) Get a table expression representing the children of a record, given this foreign key.
public @NotNull Table<R>	children(O... records) Get a table expression representing the children of a record, given this foreign key.
public @NotNull Table<R>	children(Collection<? extends O> records) Get a table expression representing the children of a record, given this foreign key.
public @NotNull Result<R>	fetchChildren(O record) 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)`.
public @NotNull Result<R>	fetchChildren(O... records) 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...)`.
public @NotNull Result<R>	fetchChildren(Collection<? extends O> records) 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)`.
public O	fetchParent(R record) 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)`.
public @NotNull Result<O>	fetchParents(R... records) 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...)`.
public @NotNull Result<O>	fetchParents(Collection<? extends R> records) 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)`.
public @NotNull UniqueKey<O>	getKey() The referenced `UniqueKey`.
public @NotNull List<TableField<O, ?>>	getKeyFields() The fields that make up the referenced `UniqueKey`.
public @NotNull @NotNull TableField<O, ?>[]	getKeyFieldsArray() Deprecated as a consequence of `TableField` being deprecated. The fields that make up the referenced `UniqueKey`.
public @NotNull Table<O>	parent(R record) Get a table expression representing the parent of a record, given this foreign key.
public @NotNull Table<O>	parents(R... records) Get a table expression representing the parents of a record, given this foreign key.
public @NotNull Table<O>	parents(Collection<? extends R> records) Get a table expression representing the parents of a record, given this foreign key.

Inherited from org.jooq.Key:: constraint enforced getFields getFieldsArray getTable nullable

Method Detail

children	back to summary
public @NotNull Table<R> children(O record) Get a table expression representing the children of a record, given this foreign key. Annotations @NotNull

children

back to summary

public @NotNull Table<R> children(O record)

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

Annotations

@NotNull

children	back to summary
public @NotNull Table<R> children(O... records) Get a table expression representing the children of a record, given this foreign key. Annotations @NotNull

children

back to summary

public @NotNull Table<R> children(O... records)

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

Annotations

@NotNull

children	back to summary
public @NotNull Table<R> children(Collection<? extends O> records) Get a table expression representing the children of a record, given this foreign key. Annotations @NotNull

children

back to summary

public @NotNull Table<R> children(Collection<? extends O> records)

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

Annotations

@NotNull

fetchChildren back to summary

fetchChildren	back to summary
public @NotNull 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, as if fetching from `children(Record)`. Annotations @NotNull @Blocking Exceptions DataAccessException: if something went wrong executing the query See Also `UpdatableRecord#fetchChild(ForeignKey)`, `UpdatableRecord#fetchChildren(ForeignKey)`

public @NotNull 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, as if fetching from children(Record).

Annotations

@NotNull
@Blocking

Exceptions

DataAccessException:: if something went wrong executing the query

fetchChildren back to summary

fetchChildren	back to summary
public @NotNull 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, as if fetching from `children(Record...)`. Annotations @NotNull @Blocking Exceptions DataAccessException: if something went wrong executing the query See Also `UpdatableRecord#fetchChild(ForeignKey)`, `UpdatableRecord#fetchChildren(ForeignKey)`

public @NotNull 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, as if fetching from children(Record...).

Annotations

@NotNull
@Blocking

Exceptions

DataAccessException:: if something went wrong executing the query

fetchChildren back to summary

fetchChildren	back to summary
public @NotNull 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, as if fetching from `children(Collection)`. Annotations @NotNull @Blocking Exceptions DataAccessException: if something went wrong executing the query See Also `UpdatableRecord#fetchChild(ForeignKey)`, `UpdatableRecord#fetchChildren(ForeignKey)`

public @NotNull 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, as if fetching from children(Collection).

Annotations

@NotNull
@Blocking

Exceptions

DataAccessException:: if something went wrong executing the query

fetchParent back to summary

fetchParent	back to summary
public 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, as if fetching from `parent(Record)`. If no parent record was found, this returns `null` Annotations @Nullable @Blocking Exceptions DataAccessException: if something went wrong executing the query See Also `TableRecord#fetchParent(ForeignKey)`

public 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, as if fetching from parent(Record). If no parent record was found, this returns null

Annotations

@Nullable
@Blocking

Exceptions

DataAccessException:: if something went wrong executing the query

See Also

TableRecord#fetchParent(ForeignKey)

fetchParents back to summary

fetchParents	back to summary
public @NotNull 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, as if fetching from `parents(Record...)`. Annotations @NotNull @Blocking Exceptions DataAccessException: if something went wrong executing the query See Also `TableRecord#fetchParent(ForeignKey)`

public @NotNull 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, as if fetching from parents(Record...).

Annotations

@NotNull
@Blocking

Exceptions

DataAccessException:: if something went wrong executing the query

See Also

TableRecord#fetchParent(ForeignKey)

fetchParents back to summary

fetchParents	back to summary
public @NotNull 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, as if fetching from `parents(Collection)`. Annotations @NotNull @Blocking Exceptions DataAccessException: if something went wrong executing the query See Also `TableRecord#fetchParent(ForeignKey)`

public @NotNull 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, as if fetching from parents(Collection).

Annotations

@NotNull
@Blocking

Exceptions

DataAccessException:: if something went wrong executing the query

See Also

TableRecord#fetchParent(ForeignKey)

getKey back to summary

getKey	back to summary
public @NotNull UniqueKey<O> getKey() The referenced `UniqueKey`. Annotations @NotNull

public @NotNull UniqueKey<O> getKey()

The referenced UniqueKey.

Annotations

@NotNull

getKeyFields back to summary

getKeyFields	back to summary
public @NotNull List<TableField<O, ?>> 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 `UniqueKey#getFields()`, but not necessarily so. Annotations @NotNull

public @NotNull List<TableField<O, ?>> 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 UniqueKey#getFields(), but not necessarily so.

Annotations

@NotNull

getKeyFieldsArray back to summary

getKeyFieldsArray	back to summary
public @NotNull @NotNull TableField<O, ?>[] getKeyFieldsArray() Deprecated as a consequence of `TableField` being deprecated. See corresponding docs for further information. 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 `UniqueKey#getFieldsArray()`, but not necessarily so. Annotations @NotNull See Also `getKeyFields()`

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

Deprecated

as a consequence of TableField being deprecated. See corresponding docs for further information.

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 UniqueKey#getFieldsArray(), but not necessarily so.

Annotations

@NotNull

See Also

getKeyFields()

parent	back to summary
public @NotNull Table<O> parent(R record) Get a table expression representing the parent of a record, given this foreign key. Annotations @NotNull

parent

back to summary

public @NotNull Table<O> parent(R record)

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

Annotations

@NotNull

parents	back to summary
public @NotNull Table<O> parents(R... records) Get a table expression representing the parents of a record, given this foreign key. Annotations @NotNull

parents

back to summary

public @NotNull Table<O> parents(R... records)

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

Annotations

@NotNull

parents	back to summary
public @NotNull Table<O> parents(Collection<? extends R> records) Get a table expression representing the parents of a record, given this foreign key. Annotations @NotNull

parents

back to summary

public @NotNull Table<O> parents(Collection<? extends R> records)

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

Annotations

@NotNull

public Interface ForeignKey<R extends org.jooq.Record, O extends org.jooq.Record>

Method Summary

Method Detail