Module org.jooq

Package org.jooq

Interface Comment

All Superinterfaces:

QueryPart, Serializable

public interface Comment
extends QueryPart

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	Description
String	getComment()	Get the comment.

Methods inherited from interface org.jooq.QueryPart

equals, hashCode, toString

Method Detail

getComment

String getComment()

Get the comment.