Comments on schema and non-schema objects

You can use the COMMENT statement to associate a comment with a schema object (table, operator, or index type) or a non-schema object (edition) in OceanBase Database. Comments associated with schema and non-schema objects are stored in the data dictionary.

The syntax for creating comments on schema and non-schema objects is as follows:

COMMENT ON {TABLE table | COLUMN column | INDEXTYPE indextype
| OPERATOR operator} IS string

Here are some examples:

• Add a comment on a user table

  COMMENT ON TABLE test.user is "This table stores user information";
  

• Add a comment on the user_name column

  COMMENT ON COLUMN test.user.user_name is "This column stores the username";