Module org.jooq

Package org.jooq

Class TableOptions

java.lang.Object

org.jooq.TableOptions

All Implemented Interfaces:

Serializable

public final class TableOptions
extends Object
implements Serializable

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

Author:

Lukas Eder

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	TableOptions.OnCommit	The ON COMMIT flag for TableOptions.TableType.GLOBAL_TEMPORARY tables.
static enum	TableOptions.TableType	A description of the type of a Table.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static final @NotNull TableOptions	expression()	Create a new TableOptions object for a TableOptions.TableType.EXPRESSION.
static final @NotNull TableOptions	function()	Create a new TableOptions object for a TableOptions.TableType.FUNCTION.
static final @NotNull TableOptions	function(String source)	Create a new TableOptions object for a TableOptions.TableType.FUNCTION.
static final @NotNull TableOptions	globalTemporaryTable()	Create a new TableOptions object for a TableOptions.TableType.GLOBAL_TEMPORARY table.
static final @NotNull TableOptions	globalTemporaryTable(QOM.TableCommitAction onCommit)	Create a new TableOptions object for a TableOptions.TableType.GLOBAL_TEMPORARY table.
static final @NotNull TableOptions	globalTemporaryTable(TableOptions.OnCommit onCommit)	Create a new TableOptions object for a TableOptions.TableType.GLOBAL_TEMPORARY table.
int	hashCode()
static final @NotNull TableOptions	localTemporaryTable()	Create a new TableOptions object for a TableOptions.TableType.LOCAL_TEMPORARY table.
static final @NotNull TableOptions	materializedView()	Create a new TableOptions object for a TableOptions.TableType.MATERIALIZED_VIEW of unknown content.
static final @NotNull TableOptions	materializedView(String source)	Create a new TableOptions object for a TableOptions.TableType.MATERIALIZED_VIEW of unknown content.
static final @NotNull TableOptions	materializedView(Select<?> select)	Create a new TableOptions object for a TableOptions.TableType.MATERIALIZED_VIEW.
static final @NotNull TableOptions	of(TableOptions.TableType tableType)	Get a new TableOptions object for a given table type.
final @Nullable TableOptions.OnCommit	onCommit()	The ON COMMIT flag for TableOptions.TableType.GLOBAL_TEMPORARY tables.
final @Nullable Select<?>	select()	The SELECT statement defining this TableOptions.TableType.VIEW or TableOptions.TableType.MATERIALIZED_VIEW.
final @Nullable String	source()	The SELECT statement defining this TableOptions.TableType.VIEW or TableOptions.TableType.MATERIALIZED_VIEW, in source form.
static final @NotNull TableOptions	table()	Create a new TableOptions object for a TableOptions.TableType.TABLE.
static final @NotNull TableOptions	temporaryTable()	Deprecated, for removal: This API element is subject to removal in a future version. - 3.21.0 - [#18626] - Use globalTemporaryTable() or localTemporaryTable() instead.
static final @NotNull TableOptions	temporaryTable(QOM.TableCommitAction onCommit)	Deprecated, for removal: This API element is subject to removal in a future version. - 3.21.0 - [#18626] - Use globalTemporaryTable(TableCommitAction).
static final @NotNull TableOptions	temporaryTable(TableOptions.OnCommit onCommit)	Deprecated, for removal: This API element is subject to removal in a future version. - 3.21.0 - [#18626] - Use globalTemporaryTable(OnCommit).
String	toString()
final @NotNull TableOptions.TableType	type()	The table type.
static final @NotNull TableOptions	view()	Create a new TableOptions object for a TableOptions.TableType.VIEW of unknown content.
static final @NotNull TableOptions	view(String source)	Create a new TableOptions object for a TableOptions.TableType.VIEW.
static final @NotNull TableOptions	view(Select<?> select)	Create a new TableOptions object for a TableOptions.TableType.VIEW.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

of

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

Get a new TableOptions object for a given table type.

table

@NotNull
public static final @NotNull TableOptions table()

Create a new TableOptions object for a TableOptions.TableType.TABLE.

temporaryTable

@Deprecated(forRemoval=true)
@NotNull
public static final @NotNull TableOptions temporaryTable()

Deprecated, for removal: This API element is subject to removal in a future version.

- 3.21.0 - [#18626] - Use globalTemporaryTable() or localTemporaryTable() instead.

Create a new TableOptions object for a TableOptions.TableType.GLOBAL_TEMPORARY table.

temporaryTable

@Deprecated(forRemoval=true)
@NotNull
public static final @NotNull TableOptions temporaryTable(TableOptions.OnCommit onCommit)

Deprecated, for removal: This API element is subject to removal in a future version.

- 3.21.0 - [#18626] - Use globalTemporaryTable(OnCommit).

Create a new TableOptions object for a TableOptions.TableType.GLOBAL_TEMPORARY table.

temporaryTable

@Deprecated(forRemoval=true)
@NotNull
public static final @NotNull TableOptions temporaryTable(QOM.TableCommitAction onCommit)

Deprecated, for removal: This API element is subject to removal in a future version.

- 3.21.0 - [#18626] - Use globalTemporaryTable(TableCommitAction).

Create a new TableOptions object for a TableOptions.TableType.GLOBAL_TEMPORARY table.

globalTemporaryTable

@NotNull
public static final @NotNull TableOptions globalTemporaryTable()

Create a new TableOptions object for a TableOptions.TableType.GLOBAL_TEMPORARY table.

globalTemporaryTable

@NotNull
public static final @NotNull TableOptions globalTemporaryTable(TableOptions.OnCommit onCommit)

Create a new TableOptions object for a TableOptions.TableType.GLOBAL_TEMPORARY table.

globalTemporaryTable

@NotNull
public static final @NotNull TableOptions globalTemporaryTable(QOM.TableCommitAction onCommit)

Create a new TableOptions object for a TableOptions.TableType.GLOBAL_TEMPORARY table.

localTemporaryTable

@NotNull
public static final @NotNull TableOptions localTemporaryTable()

Create a new TableOptions object for a TableOptions.TableType.LOCAL_TEMPORARY table.

view

@NotNull
public static final @NotNull TableOptions view()

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

view

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

Create a new TableOptions object for a TableOptions.TableType.VIEW.

view

@NotNull
public static final @NotNull TableOptions view(String source)

Create a new TableOptions object for a TableOptions.TableType.VIEW.

materializedView

@NotNull
public static final @NotNull TableOptions materializedView()

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

materializedView

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

Create a new TableOptions object for a TableOptions.TableType.MATERIALIZED_VIEW.

materializedView

@NotNull
public static final @NotNull TableOptions materializedView(String source)

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

expression

@NotNull
public static final @NotNull TableOptions expression()

Create a new TableOptions object for a TableOptions.TableType.EXPRESSION.

function

@NotNull
public static final @NotNull TableOptions function()

Create a new TableOptions object for a TableOptions.TableType.FUNCTION.

function

@NotNull
public static final @NotNull TableOptions function(String source)

Create a new TableOptions object for a TableOptions.TableType.FUNCTION.

type

@NotNull
public final @NotNull TableOptions.TableType type()

The table type.

This is never null.

onCommit

@Nullable
public final @Nullable TableOptions.OnCommit onCommit()

The ON COMMIT flag for TableOptions.TableType.GLOBAL_TEMPORARY tables.

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

select

@Nullable
public final @Nullable Select<?> select()

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

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

source

@Nullable
public final @Nullable String source()

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

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object