Module org.jooq

Package org.jooq

Interface TableRecord<R extends TableRecord<R>>

Type Parameters:

R - The record type

All Superinterfaces:

Attachable, Comparable<Record>, Fields, Formattable, QualifiedRecord<R>, Record, Serializable, SQLData

All Known Subinterfaces:

UpdatableRecord<R>

All Known Implementing Classes:

CustomRecord, TableRecordImpl, UpdatableRecordImpl

public interface TableRecord<R extends TableRecord<R>>
extends QualifiedRecord<R>

A record originating from a single table

Author:

Lukas Eder

Method Summary

Modifier and Type	Method	Description
<O extends UpdatableRecord<O>> O	fetchParent(ForeignKey<R,O> key)	Fetch a parent record of this record, given a foreign key.
@NotNull Table<R>	getTable()	The table from which this record was read.
int	insert()	Store this record to the database using an INSERT statement.
int	insert(Collection<? extends Field<?>> fields)	Store parts of this record to the database using an INSERT statement.
int	insert(Field<?>... fields)	Store parts of this record to the database using an INSERT statement.
R	original()	Get this record containing the original values as fetched from the database.
<O extends UpdatableRecord<O>> @NotNull Table<O>	parent(ForeignKey<R,O> key)	Get a table expression representing the parent of this record, given a foreign key.

Methods inherited from interface org.jooq.Attachable

attach, configuration, detach

Methods inherited from interface org.jooq.Fields

dataType, dataType, dataType, dataTypes, field, field, field, field, field, field, field, field, field, field, fields, fields, fields, fields, fields, fieldsIncludingHidden, fieldsRow, fieldStream, indexOf, indexOf, indexOf, type, type, type, types

Methods inherited from interface org.jooq.Formattable

format, format, format, format, format, format, format, format, format, formatChart, formatChart, formatChart, formatChart, formatChart, formatChart, formatCSV, formatCSV, formatCSV, formatCSV, formatCSV, formatCSV, formatCSV, formatCSV, formatCSV, formatCSV, formatCSV, formatCSV, formatCSV, formatCSV, formatCSV, formatCSV, formatCSV, formatCSV, formatCSV, formatCSV, formatCSV, formatHTML, formatHTML, formatHTML, formatInsert, formatInsert, formatInsert, formatInsert, formatInsert, formatInsert, formatJSON, formatJSON, formatJSON, formatJSON, formatJSON, formatJSON, formatXML, formatXML, formatXML, formatXML, formatXML, formatXML, intoXML, intoXML, intoXML, intoXML

Methods inherited from interface org.jooq.QualifiedRecord

getQualifier, with, with

Methods inherited from interface org.jooq.Record

changed, changed, changed, changed, changed, changed, changed, changed, changed, changed, compareTo, equals, from, from, from, from, from, fromArray, fromArray, fromArray, fromArray, fromArray, fromMap, fromMap, fromMap, fromMap, fromMap, get, get, get, get, get, get, get, get, get, get, get, get, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, hashCode, into, into, into, into, into, into, into, into, into, into, into, into, into, into, into, into, into, into, into, into, into, into, into, into, into, into, intoArray, intoList, intoMap, intoResultSet, intoStream, map, modified, modified, modified, modified, modified, original, original, original, original, reset, reset, reset, reset, reset, set, set, setValue, setValue, size, touched, touched, touched, touched, touched, touched, touched, touched, touched, touched, valuesRow

Methods inherited from interface java.sql.SQLData

getSQLTypeName, readSQL, writeSQL

Method Details

getTable

@NotNull
@NotNull Table<R> getTable()

The table from which this record was read.

original

@NotNull
R original()

Description copied from interface: Record

Get this record containing the original values as fetched from the database.

Record values can be freely modified after having fetched a record from the database. Every record also references the originally fetched values. This method returns a new record containing those original values.

Specified by:

original in interface Record

See Also:

• Record.original(Field)
• Record.original(int)
• Record.original(String)

insert

@Support
int insert()
    throws DataAccessException

Store this record to the database using an INSERT statement.

If you want to enforce re-insertion this record's values, regardless if the values in this record were Record.modified(), you can explicitly set the touched flags for all values with Record.touched(boolean) or for single values with Record.touched(Field, boolean), prior to insertion, if Settings.getRecordDirtyTracking() is set to RecordDirtyTracking.TOUCHED

Returns:

1 if the record was stored to the database. 0 if storing was not necessary and Settings.isInsertUnchangedRecords() is set to false.

Throws:

DataAccessException - if something went wrong executing the query

insert

@Support
int insert(Field<?>... fields)
    throws DataAccessException

Store parts of this record to the database using an INSERT statement.

Returns:

1 if the record was stored to the database. 0 if storing was not necessary.

Throws:

DataAccessException - if something went wrong executing the query

See Also:

• insert()

insert

@Support
int insert(Collection<? extends Field<?>> fields)
    throws DataAccessException

Store parts of this record to the database using an INSERT statement.

Returns:

1 if the record was stored to the database. 0 if storing was not necessary.

Throws:

DataAccessException - if something went wrong executing the query

See Also:

• insert()

fetchParent

@Nullable
@Support
@Blocking
<O extends UpdatableRecord<O>> O fetchParent(ForeignKey<R,O> key)
                                      throws DataAccessException

Fetch a parent record of this record, given a foreign key.

This returns a parent record referenced by this record through a given foreign key, as if fetching from parent(ForeignKey). If no parent record was found, this returns null.

A separate roundtrip is created by this operation. It is often much better to include parent records using ordinary JOIN mechanisms in a single query, or using nested records, see https://www.jooq.org/doc/latest/manual/sql-building/column-expressions/nested-records/.

Throws:

DataAccessException - if something went wrong executing the query

See Also:

• ForeignKey.fetchParent(Record)
• ForeignKey.fetchParents(java.util.Collection)
• ForeignKey.fetchParents(Record...)

parent

@NotNull
@Support
<O extends UpdatableRecord<O>> @NotNull Table<O> parent(ForeignKey<R,O> key)

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