Top Description Inners Fields Constructors Methods
org.jooq

public final Class TableOptions

extends Object
implements Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable
Static Imports
org.jooq.SQLDialect.POSTGRES, .TableOptions.OnCommit.DELETE_ROWS, .TableOptions.OnCommit.DROP, .TableOptions.OnCommit.PRESERVE_ROWS

A description of various additional Table options to describe the table runtime meta model.
Author
Lukas Eder

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
TableOptions.OnCommit

The ON COMMIT flag for TableType#TEMPORARY tables.

public static enum
TableOptions.TableType

A description of the type of a Table.

Field Summary

Modifier and TypeField and Description
private static final TableOptions
private static final TableOptions
private static final TableOptions
private static final TableOptions
private static final TableOptions
private static final TableOptions
private final TableOptions.OnCommit
private final Select<?>
private final String
private final TableOptions.TableType

Constructor Summary

AccessConstructor and Description
private
private
private
private

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
obj
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
public static final @NotNull TableOptions
expression()

Create a new TableOptions object for a TableType#EXPRESSION.

public static final @NotNull TableOptions
function()

Create a new TableOptions object for a TableType#FUNCTION.

public static final @NotNull TableOptions
function(String source)

Create a new TableOptions object for a TableType#FUNCTION.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
public static final @NotNull TableOptions
materializedView()

Create a new TableOptions object for a TableType#MATERIALIZED_VIEW of unknown content.

public static final @NotNull TableOptions
materializedView(Select<?> select)

Create a new TableOptions object for a TableType#MATERIALIZED_VIEW.

public static final @NotNull TableOptions
of(TableOptions.TableType tableType)

Get a new TableOptions object for a given table type.

public final @Nullable TableOptions.OnCommit
onCommit()

The ON COMMIT flag for TableType#TEMPORARY tables.

public final @Nullable Select<?>
select()

The SELECT statement defining this TableType#VIEW or TableType#MATERIALIZED_VIEW.

public final @Nullable String
source()

The SELECT statement defining this TableType#VIEW or TableType#MATERIALIZED_VIEW, in source form.

public static final @NotNull TableOptions
table()

Create a new TableOptions object for a TableType#TABLE.

public static final @NotNull TableOptions
temporaryTable()

Create a new TableOptions object for a TableType#TEMPORARY.

public static final @NotNull TableOptions
public static final @NotNull TableOptions
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
public final @NotNull TableOptions.TableType
type()

The table type.

public static final @NotNull TableOptions
view()

Create a new TableOptions object for a TableType#VIEW of unknown content.

public static final @NotNull TableOptions
view(Select<?> select)

Create a new TableOptions object for a TableType#VIEW.

public static final @NotNull TableOptions
view(String source)

Create a new TableOptions object for a TableType#VIEW.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

C_EXPRESSIONback to summary
private static final TableOptions C_EXPRESSION
C_FUNCTIONback to summary
private static final TableOptions C_FUNCTION
C_MATERIALIZED_VIEWback to summary
private static final TableOptions C_MATERIALIZED_VIEW
C_TABLEback to summary
private static final TableOptions C_TABLE
C_TEMPORARYback to summary
private static final TableOptions C_TEMPORARY
C_VIEWback to summary
private static final TableOptions C_VIEW
onCommitback to summary
private final TableOptions.OnCommit onCommit
selectback to summary
private final Select<?> select
sourceback to summary
private final String source
typeback to summary
private final TableOptions.TableType type

Constructor Detail

TableOptionsback to summary
private TableOptions(TableOptions.TableType type)
TableOptionsback to summary
private TableOptions(TableOptions.OnCommit onCommit)
TableOptionsback to summary
private TableOptions(TableOptions.TableType type, Select<?> select)
TableOptionsback to summary
private TableOptions(TableOptions.TableType type, String source)

Method Detail

equalsback to summary
public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
expressionback to summary
public static final @NotNull TableOptions expression()

Create a new TableOptions object for a TableType#EXPRESSION.

Annotations
@NotNull
functionback to summary
public static final @NotNull TableOptions function()

Create a new TableOptions object for a TableType#FUNCTION.

Annotations
@NotNull
functionback to summary
public static final @NotNull TableOptions function(String source)

Create a new TableOptions object for a TableType#FUNCTION.

Annotations
@NotNull
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object.

Annotations
@Override
materializedViewback to summary
public static final @NotNull TableOptions materializedView()

Create a new TableOptions object for a TableType#MATERIALIZED_VIEW of unknown content.

Annotations
@NotNull
materializedViewback to summary
public static final @NotNull TableOptions materializedView(Select<?> select)

Create a new TableOptions object for a TableType#MATERIALIZED_VIEW.

Annotations
@NotNull
ofback to summary
public static final @NotNull TableOptions of(TableOptions.TableType tableType)

Get a new TableOptions object for a given table type.

Annotations
@NotNull
onCommitback to summary
public final @Nullable TableOptions.OnCommit onCommit()

The ON COMMIT flag for TableType#TEMPORARY tables.

This may be null, if it is undefined, or unknown, or if the table is not a TableType#TEMPORARY table.

Annotations
@Nullable
selectback to summary
public final @Nullable Select<?> select()

The SELECT statement defining this TableType#VIEW or TableType#MATERIALIZED_VIEW.

This may be null, if it is undefined, or unknown, or if the table is not a view.

Annotations
@Nullable
sourceback to summary
public final @Nullable String source()

The SELECT statement defining this TableType#VIEW or TableType#MATERIALIZED_VIEW, in source form.

This may be null, if it is undefined, or unknown, or if the table is not a view.

Annotations
@Nullable
tableback to summary
public static final @NotNull TableOptions table()

Create a new TableOptions object for a TableType#TABLE.

Annotations
@NotNull
temporaryTableback to summary
public static final @NotNull TableOptions temporaryTable()

Create a new TableOptions object for a TableType#TEMPORARY.

Annotations
@NotNull
temporaryTableback to summary
public static final @NotNull TableOptions temporaryTable(TableOptions.OnCommit onCommit)

Create a new TableOptions object for a TableType#TEMPORARY.

Annotations
@NotNull
temporaryTableback to summary
public static final @NotNull TableOptions temporaryTable(QOM.TableCommitAction onCommit)

Create a new TableOptions object for a TableType#TEMPORARY.

Annotations
@NotNull
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations
@Override
typeback to summary
public final @NotNull TableOptions.TableType type()

The table type.

This is never null.

Annotations
@NotNull
viewback to summary
public static final @NotNull TableOptions view()

Create a new TableOptions object for a TableType#VIEW of unknown content.

Annotations
@NotNull
viewback to summary
public static final @NotNull TableOptions view(Select<?> select)

Create a new TableOptions object for a TableType#VIEW.

Annotations
@NotNull
viewback to summary
public static final @NotNull TableOptions view(String source)

Create a new TableOptions object for a TableType#VIEW.

Annotations
@NotNull
org.jooq back to summary

public final Enum TableOptions.OnCommit

extends Enum<TableOptions.OnCommit>
Class Inheritance

The ON COMMIT flag for TableType#TEMPORARY tables.

Field Summary

Modifier and TypeField and Description
public static final TableOptions.OnCommit
public static final TableOptions.OnCommit
public static final TableOptions.OnCommit

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public static TableOptions.OnCommit
public static TableOptions.OnCommit[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

DELETE_ROWSback to summary
public static final TableOptions.OnCommit DELETE_ROWS
Annotations
@Support:POSTGRES
DROPback to summary
public static final TableOptions.OnCommit DROP
Annotations
@Support:POSTGRES
PRESERVE_ROWSback to summary
public static final TableOptions.OnCommit PRESERVE_ROWS
Annotations
@Support:POSTGRES

Constructor Detail

OnCommitback to summary
private OnCommit()

Method Detail

valueOfback to summary
public static TableOptions.OnCommit valueOf(String name)
valuesback to summary
public static TableOptions.OnCommit[] values()
org.jooq back to summary

public final Enum TableOptions.TableType

extends Enum<TableOptions.TableType>
Class Inheritance

A description of the type of a Table.

Field Summary

Modifier and TypeField and Description
public static final TableOptions.TableType
EXPRESSION

A table expression, such as a derived table, a joined table, a common table expression, etc.

public static final TableOptions.TableType
FUNCTION

A table valued function that is defined by a Routine.

public static final TableOptions.TableType
MATERIALIZED_VIEW

A materialised view that is defined by a Select statement, and whose data is materialised in the schema.

public static final TableOptions.TableType
TABLE

An ordinary table that is stored in the schema.

public static final TableOptions.TableType
TEMPORARY

A global temporary table that is stored in the schema and visible to everyone.

public static final TableOptions.TableType
UNKNOWN

A table type that is unknown to jOOQ.

public static final TableOptions.TableType
VIEW

A view that is defined by a Select statement.

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public final boolean
isFunction()

Whether the type is a function.

public final boolean
isTable()

Whether the type is a view.

public final boolean
isView()

Whether the type is a view.

public static TableOptions.TableType
public static TableOptions.TableType[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

EXPRESSIONback to summary
public static final TableOptions.TableType EXPRESSION

A table expression, such as a derived table, a joined table, a common table expression, etc.

FUNCTIONback to summary
public static final TableOptions.TableType FUNCTION

A table valued function that is defined by a Routine.

MATERIALIZED_VIEWback to summary
public static final TableOptions.TableType MATERIALIZED_VIEW

A materialised view that is defined by a Select statement, and whose data is materialised in the schema.

TABLEback to summary
public static final TableOptions.TableType TABLE

An ordinary table that is stored in the schema.

TEMPORARYback to summary
public static final TableOptions.TableType TEMPORARY

A global temporary table that is stored in the schema and visible to everyone.

UNKNOWNback to summary
public static final TableOptions.TableType UNKNOWN

A table type that is unknown to jOOQ.

VIEWback to summary
public static final TableOptions.TableType VIEW

A view that is defined by a Select statement.

Constructor Detail

TableTypeback to summary
private TableType()

Method Detail

isFunctionback to summary
public final boolean isFunction()

Whether the type is a function.

isTableback to summary
public final boolean isTable()

Whether the type is a view.

isViewback to summary
public final boolean isView()

Whether the type is a view.

valueOfback to summary
public static TableOptions.TableType valueOf(String name)
valuesback to summary
public static TableOptions.TableType[] values()