org.jooq
Interface UpdatableTable<R extends Record>

Type Parameters:

R - The record type of the table

All Superinterfaces:

Adapter, AliasProvider<Table<R>>, Attachable, Comparable<NamedQueryPart>, FieldProvider, NamedQueryPart, QueryPart, SchemaProvider, Serializable, Table<R>, TableLike<R>, Type<R>, Updatable<R>

All Known Implementing Classes:

UpdatableTableImpl

public interface UpdatableTable<R extends Record>
extends Updatable<R>, Table<R>

A common interface for tables whose records can be stored back to the database again.

Author:

Lukas Eder

See Also:

UpdatableRecord

Method Summary

List<UniqueKey<R>>	getKeys() Retrieve all of the table's unique keys.
UniqueKey<R>	getMainKey() Retrieve the table's main unique key.
TableField<R,? extends Date>	getRecordTimestamp() A "timestamp" field holding record timestamp information used for optimistic locking jOOQ supports optimistic locking in UpdatableRecord.store() and UpdatableRecord.delete() if Settings.isExecuteWithOptimisticLocking() is enabled.
TableField<R,? extends Number>	getRecordVersion() A "version" field holding record version information used for optimistic locking jOOQ supports optimistic locking in UpdatableRecord.store() and UpdatableRecord.delete() if Settings.isExecuteWithOptimisticLocking() is enabled.
<O extends Record> List<ForeignKey<O,R>>	getReferencesFrom(Table<O> other) Get a list of FOREIGN KEY's of a specific table, referencing a this table.

Methods inherited from interface org.jooq.Table

crossJoin, crossJoin, crossJoin, crossJoin, divideBy, fullOuterJoin, fullOuterJoin, fullOuterJoin, fullOuterJoin, getIdentity, getRecordType, getReferences, getReferencesTo, getSchema, join, join, join, join, leftOuterJoin, leftOuterJoin, leftOuterJoin, leftOuterJoin, naturalJoin, naturalJoin, naturalJoin, naturalJoin, naturalLeftOuterJoin, naturalLeftOuterJoin, naturalLeftOuterJoin, naturalLeftOuterJoin, naturalRightOuterJoin, naturalRightOuterJoin, naturalRightOuterJoin, naturalRightOuterJoin, pivot, pivot, rightOuterJoin, rightOuterJoin, rightOuterJoin, rightOuterJoin

Methods inherited from interface org.jooq.NamedQueryPart

getName

Methods inherited from interface org.jooq.QueryPart

attach

Methods inherited from interface org.jooq.Adapter

internalAPI

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface org.jooq.FieldProvider

getField, getField, getField, getFields, getIndex

Methods inherited from interface org.jooq.AliasProvider

as

Methods inherited from interface org.jooq.TableLike

asTable, asTable

Method Detail

getMainKey

UniqueKey<R> getMainKey()

Retrieve the table's main unique key. If there exists a PRIMARY KEY in the table, the PRIMARY KEY is returned. Otherwise, the most suitable UNIQUE KEY is returned.

Returns:

The main key. This is never null because UpdatableTable's always have at least one key.

getKeys

List<UniqueKey<R>> getKeys()

Retrieve all of the table's unique keys.

Returns:

All keys. This is never null or empty, because UpdatableTable's always have at least one key. This method returns an unmodifiable list.

getReferencesFrom

<O extends Record> List<ForeignKey<O,R>> getReferencesFrom(Table<O> other)

Get a list of FOREIGN KEY's of a specific table, referencing a this table.

Type Parameters:

O - The other table's record type

Parameters:

other - The other table of the foreign key relationship

Returns:

Some other table's FOREIGN KEY's towards an this table. This is never null. This method returns an unmodifiable list.

getRecordVersion

TableField<R,? extends Number> getRecordVersion()

A "version" field holding record version information used for optimistic locking

jOOQ supports optimistic locking in UpdatableRecord.store() and UpdatableRecord.delete() if Settings.isExecuteWithOptimisticLocking() is enabled. Optimistic locking is performed in a single UPDATE or DELETE statement if tables provide a "version" or "timestamp" field, or in two steps using an additional SELECT .. FOR UPDATE statement otherwise.

This method is overridden in generated subclasses if their corresponding tables have been configured accordingly. A table may have both a "version" and a "timestamp" field.

Returns:

The "version" field, or null, if this table has no "version" field.

See Also:

getRecordTimestamp(), UpdatableRecord.store(), UpdatableRecord.delete(), Settings.isExecuteWithOptimisticLocking()

getRecordTimestamp

TableField<R,? extends Date> getRecordTimestamp()

A "timestamp" field holding record timestamp information used for optimistic locking

jOOQ supports optimistic locking in UpdatableRecord.store() and UpdatableRecord.delete() if Settings.isExecuteWithOptimisticLocking() is enabled. Optimistic locking is performed in a single UPDATE or DELETE statement if tables provide a "version" or "timestamp" field, or in two steps using an additional SELECT .. FOR UPDATE statement otherwise.

This method is overridden in generated subclasses if their corresponding tables have been configured accordingly. A table may have both a "version" and a "timestamp" field.

Returns:

The "timestamp" field, or null, if this table has no "timestamp" field.

See Also:

getRecordVersion(), UpdatableRecord.store(), UpdatableRecord.delete(), Settings.isExecuteWithOptimisticLocking()