注释

SQL 语句和数据库对象的注释方法是不同的。

SQL 语句的注释

对于普通 SQL 语句，OceanBase 数据库支持以下三种注释方法：

• 从 # 到行尾，可以注释一行。

• 从 -- 到行尾，可以注释一行。

• 从 /* 到 */，可以注释多行。

  说明

  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