Package org.h2.engine

Class Comment

All Implemented Interfaces:
HasSQL

public final class Comment extends DbObject
Represents a database object comment.
  • Field Details

    • objectType

      private final int objectType
    • quotedObjectName

      private final String quotedObjectName
    • commentText

      private String commentText
  • Constructor Details

  • Method Details

    • getCreateSQLForCopy

      public String getCreateSQLForCopy(Table table, String quotedName)
      Description copied from class: DbObject
      Build a SQL statement to re-create the object, or to create a copy of the object with a different name or referencing a different table
      Specified by:
      getCreateSQLForCopy in class DbObject
      Parameters:
      table - the new table
      quotedName - the quoted name
      Returns:
      the SQL statement
    • getTypeName

      private static String getTypeName(int type)
    • getCreateSQL

      public String getCreateSQL()
      Description copied from class: DbObject
      Construct the CREATE ... SQL statement for this object.
      Specified by:
      getCreateSQL in class DbObject
      Returns:
      the SQL statement
    • getType

      public int getType()
      Description copied from class: DbObject
      Get the object type.
      Specified by:
      getType in class DbObject
      Returns:
      the object type
    • removeChildrenAndResources

      public void removeChildrenAndResources(SessionLocal session)
      Description copied from class: DbObject
      Delete all dependent children objects and resources of this object.
      Specified by:
      removeChildrenAndResources in class DbObject
      Parameters:
      session - the session
    • checkRename

      public void checkRename()
      Description copied from class: DbObject
      Check if renaming is allowed. Does nothing when allowed.
      Overrides:
      checkRename in class DbObject
    • getKey

      static String getKey(DbObject obj)
      Get the comment key name for the given database object. This key name is used internally to associate the comment to the object.
      Parameters:
      obj - the object
      Returns:
      the key name
    • setCommentText

      public void setCommentText(String comment)
      Set the comment text.
      Parameters:
      comment - the text