コメントの使用

テーブルコメントの使用

テーブルの各フィールドにコメントを追加することで、テーブル作成ステートメントからテーブルや各フィールドの役割をより容易に理解できます。これは後続の開発者が共同で開発する際に役立ち、データベース設計ドキュメントを補完する有効な手段であり、自然な機能説明となります。

テーブルにコメントを追加する方法は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