テーブルのカラムにコメント付与する方法（9.3.1新機能）

公開日: 公開日：2020年06月11日（木）
更新日: 更新日：2020年06月24日（水）
サブカテゴリー: 基本操作; 新バージョン/機能

タグ: #カラムテーブル

はじめに

一般的にRDBMSではテーブルのカラムに対して、コメントを付与することが可能です。カラム名が英名であっても、カラムの和名をコメントとして付与しておくことで、カラムの意味合いがより理解しやすくなります。

Vertica 9.3.0までは、カラムに対するコメントの付与は、プロジェクションカラムにしかできず、プロジェクションの最適化、再作成をした際に付与したコメントがクリアされてしまう課題がありました。
Vertica 9.3.1ではその点を改善し、通常のRDBMSと同様にテーブルカラムに対してコメントが付与できるようになりました。
本記事では、その方法をご紹介します。

テーブルカラムへのコメント付与方法

構文

COMMENT ON COLUMN [[<db>.]<スキーマ名>.]<テーブル名>.<カラム名> IS {‘<コメント>’ | NULL};</db>

実行例

## サンプルテーブルの作成 
dbadmin=> CREATE TABLE department(
dbadmin(>   deptno   NUMBER(4,0),
dbadmin(>   deptname VARCHAR2(60),
dbadmin(>   area     VARCHAR2(15))
dbadmin-> ;
CREATE TABLE

## カラムコメントの付与
dbadmin=> COMMENT ON COLUMN department.deptno IS '部署番号';
COMMENT
dbadmin=> COMMENT ON COLUMN department.deptname IS '部署名';
COMMENT
dbadmin=> COMMENT ON COLUMN department.area IS '地域';
COMMENT

## 付与結果の確認（commentsシステムテーブル）
dbadmin=> SELECT object_schema, object_type, object_name, child_object, comment FROM comments
dbadmin-> WHERE object_name = 'department';

 object_schema | object_type | object_name | child_object | comment
---------------+-------------+-------------+--------------+----------
 public        | COLUMN      | department  | deptno       | 部署番号
 public        | COLUMN      | department  | deptname     | 部署名
 public        | COLUMN      | department  | area         | 地域
(3 rows)

補足

Vertica 9.3.1以降においても、プロジェクションカラムへのコメントの付与は可能です。構文についても変更はありません。
ただし、冒頭の記載の通り、プロジェクションの最適化、再作成をした際は、該当プロジェクションに付与したコメントはクリアされますので、その点にご留意ください。

参考情報

・COMMENT ON TABLE COLUMN
https://www.vertica.com/docs/9.3.x/HTML/Content/Authoring/SQLReferenceManual/Statements/COMMENT/COMMENTONTABLECOLUMN.htm

検証バージョンについて

この記事の内容はVertica 9.3で確認しています。

更新履歴

2020/06/11　本記事を公開

Analytics Database