SQL文とデータベースオブジェクトのコメント方法は異なります。
SQL文のコメント
通常のSQL文について、OceanBaseデータベースは以下の3種類のコメント方法をサポートしています:
#から行末までを記述することで、1行をコメントアウトできます。--から行末までを記述することで、1行をコメントアウトできます。/*から*/までを記述することで、複数行をコメントアウトできます。説明
SQL文ではネストされたコメントはサポートされていません。
特に、OceanBaseデータベースは /*!*/ 内の文をSQLとして処理し、コメント内の文を実行することをサポートしています。/*!*/ 内に構文エラーが発生した場合、データベースはデフォルトでコメントとして扱います。
コメントの書式は次のとおりです:
/*![バージョン番号を表す連続する数字文字] <スペース> <任意のSQL文> */
例1:テーブル
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例2:
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例3:PLの
DROP IF EXISTS構文の実行をサポートします。obclient> /*!50003 DROP PROCEDURE IF EXISTS */; Query OK, 0 rows affected
データベースオブジェクトのコメント
DDL文において、COMMENT 句を使用してデータベースオブジェクトにコメントを指定できます。例:
obclient> CREATE TABLE tbl1(pk INT PRIMARY KEY COMMENT '主キー');
Query OK, 0 rows affected