Comments - Kinetica Docs

Comments, text-based tags, can be applied to a variety of object types. Normally, comments are applied to objects after the object is created; however, comments can also be applied in-line to table columns within a CREATE TABLE or CREATE EXTERNAL TABLE statement.

COMMENT Syntax

COMMENT ON <object type> <object name> IS '<comment text>';

Parameters

Specifies the type of object to which the comment will be applied. The following types are supported:

Type	Description
`SCHEMA`	Apply a schema-level comment; can be viewed in the `ki_catalog.ki_schemas` Kinetica catalog table
`TABLE`	Apply a table-level comment; can be viewed in the `ki_catalog.ki_objects` Kinetica catalog table
`VIEW`	Apply a view-level comment; can be viewed in the `ki_catalog.ki_objects` Kinetica catalog table
`COLUMN`	Apply a column-level comment; can be viewed in the `ki_catalog.ki_columns` Kinetica catalog table
`PROCEDURE`	Apply a procedure-level comment; can be viewed in the `ki_catalog.ki_objects` Kinetica catalog table
`USER`	Apply a user-level comment; can be viewed in the `ki_catalog.ki_users_and_roles` Kinetica catalog table
`ROLE`	Apply a role-level comment; can be viewed in the `ki_catalog.ki_users_and_roles` Kinetica catalog table

Name of the object to which the comment will be applied; must adhere to the supported naming criteria

Text of the comment to apply.

Examples

For example, to apply a comment to a column in-line with the containing table creation:

In-Line Column Comment Example

CREATE TABLE comment_schema.comment_table_inline
(
	id INT COMMENT 'I''m an in-line table column-level comment',
	name VARCHAR(32)
)

To apply a comment to a column after the containing table is created:

Post-Creation Column Comment Example

COMMENT ON COLUMN comment_schema.comment_table_inline.name IS 'I''m a post-creation table column-level comment'

List Comments

To list the comments for users & roles:

List User/Role Comments

SELECT name, comments
FROM ki_users_and_roles

To list the comments for schemas:

List Schema Comments

SELECT schema_name, comments
FROM ki_schemas

To list the comments for tables, views, & SQL procedures:

List Table/View/Procedure Comments

SELECT obj_kind, object_name, comments
FROM ki_objects

To list the comments for columns:

List Column Comments

SELECT schema_name, table_name, column_name, comments
FROM ki_columns

To show the comments for columns within the context of the containing table, use SHOW TABLE on the table containing the columns.

DESCRIBE Loading Data

⌘I

​Parameters

​Examples

​List Comments

Parameters

Examples

List Comments