org.jooq

public non-sealed Interface Comment

Known Direct Implementers: org.jooq.impl.CommentImpl
Imports: org.jooq.impl.DSL, .QOM, org.jetbrains.annotations.NotNull, .ApiStatus.Experimental

A comment.

Most RDBMS support commenting (i.e. documenting) stored objects, such as Schema, Table, Field, and other objects. Such comments can be modelled in DDL statements as well as retrieved from meta data through the Comment type.

Example:


// Assuming import static org.jooq.impl.DSL.*;

using(configuration)
   .commentOnTable(TABLE)
   .is(comment("My Comment"))
   .execute();

Instances can be created using DSL#comment(String) and overloads.

Author: Lukas Eder

Method Summary

Modifier and Type	Method and Description
public @NotNull String	$comment() Experimental query object model accessor method, see also `QOM`.
public String	getComment() Get the comment.

Method Detail

$comment back to summary

$comment	back to summary
public @NotNull String $comment() Experimental query object model accessor method, see also `QOM`. Subject to change in future jOOQ versions, use at your own risk. Annotations @Experimental @NotNull

public @NotNull String $comment()

Experimental query object model accessor method, see also QOM. Subject to change in future jOOQ versions, use at your own risk.

Annotations

@Experimental
@NotNull

getComment	back to summary
public String getComment() Get the comment.