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