Package org.h2.engine
Class Comment
java.lang.Object
org.h2.engine.DbObject
org.h2.engine.Comment
- All Implemented Interfaces:
HasSQL
Represents a database object comment.
-
Field Summary
FieldsFields inherited from class org.h2.engine.DbObject
AGGREGATE, comment, COMMENT, CONSTANT, CONSTRAINT, database, DOMAIN, FUNCTION_ALIAS, INDEX, RIGHT, ROLE, SCHEMA, SEQUENCE, SETTING, SYNONYM, TABLE_OR_VIEW, trace, TRIGGER, USER
Fields inherited from interface org.h2.util.HasSQL
ADD_PLAN_INFORMATION, DEFAULT_SQL_FLAGS, NO_CASTS, QUOTE_ONLY_WHEN_REQUIRED, REPLACE_LOBS_FOR_TRACE, TRACE_SQL_FLAGS
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Check if renaming is allowed.Construct the CREATE ...getCreateSQLForCopy
(Table table, String quotedName) 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(package private) static String
Get the comment key name for the given database object.int
getType()
Get the object type.private static String
getTypeName
(int type) void
removeChildrenAndResources
(SessionLocal session) Delete all dependent children objects and resources of this object.void
setCommentText
(String comment) Set the comment text.Methods inherited from class org.h2.engine.DbObject
getChildren, getComment, getCreateSQLForMeta, getDatabase, getDropSQL, getId, getModificationId, getName, getSQL, getSQL, invalidate, isTemporary, isValid, rename, setComment, setModified, setObjectName, setTemporary, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.h2.util.HasSQL
getTraceSQL
-
Field Details
-
objectType
private final int objectType -
quotedObjectName
-
commentText
-
-
Constructor Details
-
Comment
-
-
Method Details
-
getCreateSQLForCopy
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 classDbObject
- Parameters:
table
- the new tablequotedName
- the quoted name- Returns:
- the SQL statement
-
getTypeName
-
getCreateSQL
Description copied from class:DbObject
Construct the CREATE ... SQL statement for this object.- Specified by:
getCreateSQL
in classDbObject
- Returns:
- the SQL statement
-
getType
public int getType()Description copied from class:DbObject
Get the object type. -
removeChildrenAndResources
Description copied from class:DbObject
Delete all dependent children objects and resources of this object.- Specified by:
removeChildrenAndResources
in classDbObject
- 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 classDbObject
-
getKey
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
Set the comment text.- Parameters:
comment
- the text
-