テーブルおよびカラムにコメントを追加する

広告

テーブルを作成する時にテーブルやカラムにコメントを記述することができます。ここでは MariaDB の環境でテーブルやカラムにコメントを追加する方法について解説します。

(2021 年 07 月 30 日公開 / 2021 年 07 月 30 日更新)

テーブルにコメントを追加する

テーブルを作成するときにテーブルにコメントを追加することができます。書式は次の通りです。

CREATE TABLE db_name.tbl_name (col_name data_type,...)
  COMMENT [=] 'string'

テーブルに関するメモとしてコメントを記述しておくことができます。コメントは最大 2048 文字できます。

では実際に試してみます。次のように実行してください。

create table user (id int, name varchar(10)) comment 'by buzzword';

テーブルおよびカラム毎にコメントを追加する(1)

新しいテーブルを作成しました。コメントはあくまでメモとして残すものなので、テーブルの動作的には何も影響がありません。

テーブルに追加したコメントをあとから確認するには SHOW CREATE TABLE 文を使用します。次のように実行してください。

show create table user\G

テーブルおよびカラム毎にコメントを追加する(2)

テーブルに追加したコメントを確認することができました。

カラムにコメントを追加する

テーブルに対してだけではなく、テーブル内のカラム毎にコメントを追加することもできます。次の書式を使用します。

CREATE TABLE db_name.tbl_name 
  (col_name data_type COMMENT 'string',...)

カラムに関するメモとしてコメントを記述しておくことができます。コメントは最大 1024 文字できます。

では実際に試してみます。次のように実行してください。

create table user (id int comment 'identity code', name varchar(10));

テーブルおよびカラム毎にコメントを追加する(1)

新しいテーブルを作成しました。コメントはあくまでメモとして残すものなので、テーブルの動作的には何も影響がありません。

カラムに追加したコメントをあとから確認するには SHOW CREATE TABLE 文を使用します。次のように実行してください。

show create table user\G

テーブルおよびカラム毎にコメントを追加する(2)

カラムに追加したコメントを確認することができました。

-- --

MariaDB の環境でテーブルやカラムにコメントを追加する方法について解説しました。

( Written by Tatsuo Ikura )

関連記事 (一部広告含む)
Profile
profile_img

著者 / TATSUO IKURA

初心者~中級者の方を対象としたプログラミング方法や開発環境の構築の解説を行うサイトの運営を行っています。