Oracle环境下的编写表与字段注释指南_特定语法与可视化配置

酷强大大_7821

酷强大大_7821

2026-03-28

393人浏览

原创

oracle表注释需用comment on table语句单独添加,必须指定schema名(当前用户可省略),注释内容为4000字节内字符串字面量;字段注释同理用comment on column逐列添加,双引号列名需保持一致,单引号需转义为两个单引号;验证须查all_tab_comments/all_col_comments数据字典视图,注意权限与owner匹配;工具不显示注释常因未启用“show comments”选项或缓存未刷新。

怎么给 oracle 表加注释(comment on table)

Oracle 不像 MySQL 那样支持建表时直接写 COMMENT,必须用独立语句。不执行这条,ALL_TAB_COMMENTS 里就查不到表注释。

  • COMMENT ON TABLE schema_name.table_name IS '描述内容'; —— 必须带 schema 名(如 HR.EMPLOYEES),当前用户下可省略 schema,但跨用户或脚本复用时强烈建议写全
  • 注释内容最大长度 4000 字节,超长会报 ORA-00997: illegal use of LONG datatype
  • 注释不支持变量或表达式,不能写 IS SYSDATE || ' 创建',只能是字符串字面量
  • 执行后不会立即在 PL/SQL Developer 或 SQL Developer 的“对象浏览器”里刷新,需右键刷新或重新展开节点

怎么给 Oracle 字段加注释(COMMENT ON COLUMN)

字段注释必须逐列添加,没有批量语法;漏掉一列,ALL_COL_COMMENTS 里那列的 COMMENTS 就是 NULL。

  • COMMENT ON COLUMN schema_name.table_name.column_name IS '姓名全称,含空格和大小写'; —— 列名不区分大小写,但若建表时用双引号定义了大小写敏感列名(如 "userName"),这里也得加双引号
  • 如果表有同义词(synonym),不能对 synonym 执行 COMMENT ON COLUMN,会报 ORA-00942: table or view does not exist,必须指向基表
  • 注释内容中的单引号要转义:写成两个单引号 '',比如 IS '用户状态:''ACTIVE'' 或 ''INACTIVE'''

怎么验证注释是否生效(查 ALL_TAB_COMMENTS / ALL_COL_COMMENTS)

别只信工具界面显示——很多 IDE 缓存注释、延迟加载,或者只查当前用户视图,实际需要确认底层数据字典。

  • 查表注释:SELECT TABLE_NAME, COMMENTS FROM ALL_TAB_COMMENTS WHERE OWNER = 'HR' AND TABLE_NAME = 'EMPLOYEES';
  • 查字段注释:SELECT COLUMN_NAME, COMMENTS FROM ALL_COL_COMMENTS WHERE OWNER = 'HR' AND TABLE_NAME = 'EMPLOYEES' ORDER BY COLUMN_ID;
  • 注意:ALL_* 视图只返回当前用户有权限访问的对象;如果没权限查别人 schema,得用 DBA_TAB_COMMENTS(需 DBA 权限)或让 DBA 授权 SELECT_CATALOG_ROLE
  • 字段注释顺序不按字母,而是按 COLUMN_ID,和 DESC table_name 输出一致

SQL Developer 和 PL/SQL Developer 里注释不显示?常见配置点

不是注释没加成功,大概率是客户端没开对应选项,或连接用的是只读用户。

  • SQL Developer:菜单 Tools → Preferences → Database → Object Viewer,勾选 Show Comments;另需确认连接属性里 Auto Commit 关闭(否则某些版本提交前不刷新元数据)
  • PL/SQL Developer:右键表 → Edit → Comments 标签页,但该标签页只读——它不用于编辑,仅用于查看已存在的注释;编辑仍要靠 COMMENT ON 语句
  • 如果用了连接池或中间件(如 MyBatis + Druid),部分驱动默认不拉取注释字段,需显式配置 includeSynonyms=false 或升级 JDBC 驱动到 12.2+ 版本
Oracle 注释本身不参与执行计划、不占存储空间,但字段注释在生成 JPA 实体或 Swagger 文档时容易被忽略——因为多数工具只读 USER_COL_COMMENTS,而你执行 COMMENT 时如果没指定 schema,默认写入的是当前用户的 USER_* 视图,跨 schema 场景下必须核对 OWNER 字段。
PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

3349

3

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2023.07.25

2368

9

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

2023.08.02

1300

5

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.09

1258

4

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

2023.09.05

1376

5

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2023.09.20

2258

7

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

2023.09.20

3640

8

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

2023.09.22

16835

6

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

2023.09.22

549

3

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.7万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 133.9万人学习