在mysql數(shù)據(jù)庫中,備注是用于描述表、字段、視圖等對象的重要信息,有利于代碼的可讀性和維護性。
表的備注可以在創(chuàng)建表時添加:
CREATE TABLE `example` ( `id` int(11) NOT NULL COMMENT '主鍵ID', `name` varchar(255) NOT NULL COMMENT '姓名', `age` int(11) DEFAULT NULL COMMENT '年齡', PRIMARY KEY (`id`) ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COMMENT='示例表';
字段的備注可以在字段定義后加COMMENT:
CREATE TABLE `example` ( `id` int(11) NOT NULL COMMENT '主鍵ID', `name` varchar(255) NOT NULL COMMENT '姓名', `age` int(11) DEFAULT NULL COMMENT '年齡', PRIMARY KEY (`id`) ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COMMENT='示例表';
查詢表結(jié)構(gòu)時,可通過DESCRIBE、SHOW COLUMNS等命令查看備注:
DESCRIBE example;
或者:
SHOW COLUMNS FROM example;
在編寫SQL語句時,可以使用注釋提高代碼可讀性。
SELECT * FROM `example` WHERE `age` >18 /* 只展示男性 */ AND `gender` = 'male';
在MySQL中,注釋有兩種形式,單行注釋和多行注釋。
單行注釋以“-- ”開頭,后面跟著注釋內(nèi)容,在語句中可寫在一行或多行:
SELECT * FROM `example` -- 示范表 WHERE `age` >18 -- 年齡大于18歲的 /* 只展示男性 */ AND `gender` = 'male';
多行注釋以“/* ”開頭,以“*/”結(jié)尾,可以在任意位置插入:
SELECT /* 選取 */ `name`, /* 年齡 */ `age` FROM /* 示范表 */ `example` WHERE /* 年齡大于18歲的 */ `age` >18 /* 只展示男性 */ AND `gender` = 'male';