Module org.jooq

Package org.jooq.impl

Interface QOM.CommentOn

All Superinterfaces:

Attachable, AttachableQueryPart, DDLQuery, Flow.Publisher<Integer>, Publisher<Integer>, org.reactivestreams.Publisher<Integer>, Query, QueryPart, RowCountQuery, Serializable, Statement

Enclosing class:

QOM

public static interface QOM.CommentOn
extends DDLQuery

The COMMENT ON TABLE statement.

Method Summary

Modifier and Type	Method	Description
@NotNull Comment	$comment()
@NotNull QOM.CommentOn	$comment(Comment comment)
@Nullable Field<?>	$field()
@NotNull QOM.CommentOn	$field(Field<?> field)
@Nullable Name	$function()
@NotNull QOM.CommentOn	$function(Name function)
boolean	$isMaterializedView()	Deprecated, for removal: This API element is subject to removal in a future version. - 3.21.0 - [#18684] - Use $objectType() instead.
@NotNull QOM.CommentOn	$isMaterializedView(boolean isMaterializedView)	Deprecated, for removal: This API element is subject to removal in a future version. - 3.21.0 - [#18684] - Use $objectType() instead.
boolean	$isView()	Deprecated, for removal: This API element is subject to removal in a future version. - 3.21.0 - [#18684] - Use $objectType() instead.
@NotNull QOM.CommentOn	$isView(boolean isView)	Deprecated, for removal: This API element is subject to removal in a future version. - 3.21.0 - [#18684] - Use $objectType() instead.
@NotNull QOM.CommentObjectType	$objectType()
@NotNull QOM.CommentOn	$objectType(QOM.CommentObjectType objectType)
@NotNull QOM.UnmodifiableList<? extends Parameter<?>>	$parameters()
@NotNull QOM.CommentOn	$parameters(Collection<? extends Parameter<?>> parameters)
@Nullable Name	$procedure()
@NotNull QOM.CommentOn	$procedure(Name procedure)
@Nullable Table<?>	$table()
@NotNull QOM.CommentOn	$table(Table<?> table)

Methods inherited from interface org.jooq.Attachable

attach, configuration, detach

Methods inherited from interface org.jooq.AttachableQueryPart

getBindValues, getParam, getParams, getSQL, getSQL

Methods inherited from interface org.jooq.Publisher

subscribe

Methods inherited from interface org.reactivestreams.Publisher

subscribe

Methods inherited from interface org.jooq.Query

bind, bind, cancel, execute, executeAsync, executeAsync, isExecutable, keepStatement, poolable, queryTimeout

Methods inherited from interface org.jooq.QueryPart

$replace, $replace, $traverse, $traverse, equals, hashCode, toString

Method Details

$objectType

@NotNull
@NotNull QOM.CommentObjectType $objectType()

$table

@Nullable
@Nullable Table<?> $table()

$field

@Nullable
@Nullable Field<?> $field()

$function

@Nullable
@Nullable Name $function()

$procedure

@Nullable
@Nullable Name $procedure()

$isView

@Deprecated(forRemoval=true,
            since="3.21")
boolean $isView()

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

- 3.21.0 - [#18684] - Use $objectType() instead.

$isMaterializedView

@Deprecated(forRemoval=true,
            since="3.21")
boolean $isMaterializedView()

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

- 3.21.0 - [#18684] - Use $objectType() instead.

$parameters

@NotNull
@NotNull QOM.UnmodifiableList<? extends Parameter<?>> $parameters()

$comment

@NotNull
@NotNull Comment $comment()

$objectType

@CheckReturnValue
@NotNull
@NotNull QOM.CommentOn $objectType(QOM.CommentObjectType objectType)

$table

@CheckReturnValue
@NotNull
@NotNull QOM.CommentOn $table(Table<?> table)

$field

@CheckReturnValue
@NotNull
@NotNull QOM.CommentOn $field(Field<?> field)

$function

@CheckReturnValue
@NotNull
@NotNull QOM.CommentOn $function(Name function)

$procedure

@CheckReturnValue
@NotNull
@NotNull QOM.CommentOn $procedure(Name procedure)

$isView

@Deprecated(forRemoval=true,
            since="3.21")
@CheckReturnValue
@NotNull
@NotNull QOM.CommentOn $isView(boolean isView)

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

- 3.21.0 - [#18684] - Use $objectType() instead.

$isMaterializedView

@Deprecated(forRemoval=true,
            since="3.21")
@CheckReturnValue
@NotNull
@NotNull QOM.CommentOn $isMaterializedView(boolean isMaterializedView)

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

- 3.21.0 - [#18684] - Use $objectType() instead.

$parameters

@CheckReturnValue
@NotNull
@NotNull QOM.CommentOn $parameters(Collection<? extends Parameter<?>> parameters)

$comment

@CheckReturnValue
@NotNull
@NotNull QOM.CommentOn $comment(Comment comment)