コメントの使用

テーブルコメントの使用

テーブルの各フィールドにコメントを追加することで、テーブル作成ステートメントを通じてテーブルおよび各フィールドが果たす役割をよりよく理解することができます。これは、後続の開発者が共同で開発する上で役立ち、データベース設計ドキュメントを補完する有益な機能です。

テーブルにコメントを追加する方法は2種類あります。

• テーブル作成時に同時にコメントを追加します。

  obclient> CREATE TABLE student(
  id INT PRIMARY KEY AUTO_INCREMENT COMMENT '学生番号',
  name VARCHAR(200) COMMENT '氏名',
  age INT COMMENT '年齢') COMMENT='学生情報';
  

• テーブル作成後、alter ステートメントを使用してコメントを追加します。

  obclient> CREATE TABLE student( id INT PRIMARY KEY AUTO_INCREMENT , name VARCHAR(200) , age INT);
  obclient> ALTER TABLE student COMMENT '学生情報';
  obclient> ALTER TABLE student MODIFY COLUMN id INT COMMENT '学生番号';
  obclient> ALTER TABLE student MODIFY COLUMN name VARCHAR(200) COMMENT '氏名';
  obclient> ALTER TABLE student MODIFY COLUMN age INT COMMENT '年齢';
  

  ここでは、テーブル作成後に ALTER ステートメントを使用してコメントを追加する2番目の方法を推奨します。これにより、後続のテーブルメンテナンスが容易になります。

SQL文コメントの使用

通常のSQL文について、OceanBaseデータベースは以下の3種類のコメント方法をサポートしています：

• # から行末までを指定すると、その行全体をコメントアウトできます。

• -- から行末までを指定すると、その行全体をコメントアウトできます。

• /* から */ までを指定すると、複数行をコメントアウトできます。

  説明

  SQL文ではネストされたコメントはサポートされていません。

特に、OceanBaseデータベースは /*！*/ 内の文をSQLとして処理し、コメント内の文を実行することをサポートしています。もし /*！*/ 内に構文エラーが発生した場合、データベースはデフォルトでコメントとして扱います。

コメントの書式は以下のとおりです：

/*![バージョン番号を示す連続する数字文字] <スペース> <任意のSQL文> */

例：

• テーブル t1 にHashパーティションを作成し、パーティション数を 8 に設定します。

  obclient> CREATE TABLE t1 (c1 INT PRIMARY KEY, c2 INT) /*!50100
      PARTITION BY HASH(c1) PARTITIONS 8*/;
  Query OK, 0 rows affected
  

• ENABLE KEYS を使用して非一意インデックスを更新し、一括挿入時には DISABLE KEYS を使用して最初は更新せず、すべてのインデックスの挿入が完了した後にインデックスを更新します。

  obclient> /*!ALTER TABLE t1 DISABLE KEYS */;
  Query OK, 0 rows affected
  
  obclient> /*!ALTER TABLE t1 ENABLE KEYS */;
  Query OK, 0 rows affected
  

• PLの DROP IF EXISTS 構文の実行をサポートします。

  obclient> /*!50003 DROP PROCEDURE IF EXISTS */;
  Query OK, 0 rows affected