给SQL server数据库表字段添加注释SQL，附修改、删除注释SQL及演示

news2024/11/23 20:30:16

目录

一. 前提小知识(数据库连接，数据库，SCHEMA，Table的关系)

二. 添加备注

2.1 添加备注基本语法(sys.sp_addextendedproperty)

2.2 SQL演示

2.3 fn_listextendedproperty函数查询备注个数

2.4 开发常用添加注释语法

三. 修改备注

3.1 修改备注基本语法（sys.sp_updateextendedproperty）

3.2 需要注意的坑

3.3 添加注释与修改注释的搭配使用

四. 删除备注

4.1 删除备注基本语法

一. 前提小知识(数据库连接，数据库，SCHEMA，Table的关系)

数据库我们比较熟悉的就是数据库DataBase，然后就是数据库中的表Table；

但在它们二者中间，还有一个中间者，叫"SCHEMA"，一个数据库可以有多个"SCHEMA"，"SCHEMA"是数据库的一个逻辑结构，，用于组织数据库对象，如表、视图、存储过程等。如下图所示，

（1）数据库连接(数据库服务器)：我们知道，数据库都是一个个的链接，我们都过IP和端口去连接各个数据库服务器，所以连接是最大的一个单位；

（2）数据库：其次，我们就会发现，在连接的数据库服务器中，会有1~多个数据库DataBase，通常情况下一个项目会有多个数据库；

（3）SCHEMA：再次，在每个数据库DataBase下，还会有多个SCHEMA，每个SCHEMA都是一个独立的小单位，它们之间互相隔绝，每个SCHEMA都有自己的权限和对象，从而实现更好的数据隔离和安全性。

（4）Table表：最后，在每个SCHEMA之下没我们可以建立多张表，这个大家都很熟悉，就不多说了，每张表存储着不同的实体对象数据；

总结下来，一个数据库连接(数据库服务器)下可以有多个数据库(DataBase)，一个数据库下可以有多个SCHEMA，一个SCHEMA下可以建立多张数据表。所以它们的关系就是 数据库连接>数据库>SCHEMA>Table；了解了这个小知识，我们开始进入正题。

二. 添加备注

2.1 添加备注基本语法(sys.sp_addextendedproperty)

在SQL server中，使用"sys.sp_addextendedproperty"即可向表中的字段添加注释。

举例：现有一个表名叫 "MyTable"，表中有一个列的字段叫 "MyColumn"。

如下SQL，就是给字段 MyColumn 添加注释，注释即为 "MyColumn字段的描述"。

EXEC sys.sp_addextendedproperty
-- @name=N'MS_Description'添加备注的描述，固定写法@value=N'这是MyColumn字段的描述', 
     @name=N'MS_Description',@value=''就是我们要给字段添加的备注内容                //
-- @level0type=N'SCHEMA' 指定了级别0的类型为架构，name则指架构的名称为dbo。
     @level0type=N'SCHEMA', @level0name=N'dbo',
-- @level0name=N'dbo' 指定了级别1的类型为表,name则指表名为MyTable。    
     @level1type=N'TABLE', @level1name=N'MyTable',
-- @level2type=N'COLUMN' 指定了级别2的类型为列，name指要添加注释的列名为MyColumn
     @level2type=N'COLUMN', @level2name=N'MyColumn';

 

2.2 SQL演示

(a)如下图所示，在本地连接 'local' 中，有数据库 'fccbdb' ，数据库下有 SCHEAM 叫 'dbo'，现在我使用上述SQL给主键ID添加注释；

(b)SQL如下 

-- 给 log_fccb 表中的 ID 字段添加注释
EXEC sys.sp_addextendedproperty
    @name=N'MS_Description',                      
    @value=N'主键ID',
    @level0type=N'SCHEMA', @level0name=N'dbo',    
    @level1type=N'TABLE', @level1name=N'log_fccb',
    @level2type=N'COLUMN', @level2name=N'ID';

(c)然后运行上述 SQL 语句，我们再打开 log_fccb 表，就会看到此时的主键ID已经被添加上注释了；

(d)此外，fccbdb下 还有 SCHEMA 叫 guest，但并没有任何的表数据，我们一会做对比看一下，将上述SQL语句中的SCHEMA由dbo改为guest再次执行；

EXEC sys.sp_addextendedproperty
    @name=N'MS_Description',                      
    @value=N'新注释主键ID',
    @level0type=N'SCHEMA', @level0name=N'guest',    
    @level1type=N'TABLE', @level1name=N'log_fccb',
    @level2type=N'COLUMN', @level2name=N'ID';

 

(e)执行上述SQL语句，就会出现下方的报错信息，错误信息"guest.log_fccb.ID"不存在，这也是正常的，我们刚才说了。guest下是空的，自然没有表，也没有名叫ID的字段；所以也侧面印证了SCHEMA是表的上一级，需要在SQL语句中指定某个SCHEMA下的某张表的某个字段，才能去通过SQL为其添加注释。

2.3 fn_listextendedproperty函数查询备注个数

在SQL server中，提供了 fn_listextendedproperty 函数，通过它可以返回某个列的备注数量，通常为0或者1，为0表示该字段没有被添加备注，为1则表示当前字段已经有备注。

(a)使用语法如下，其中括号内的8个参数与上面 sp_addextendedproperty 添加注释函数中的8个参数一样，但是查询不需要写"@name=N'MS_Description', @value=N'错误信息'，所以只剩下6个参数"，还可以将前面的@xxx省略。

-- 查询log_fccb表中字段ID的备注个数
SELECT COUNT(*) 
FROM fn_listextendedproperty
('MS_Description', 'SCHEMA', 
'dbo', 'TABLE', 
'log_fccb', 'COLUMN', 'ID')

(b)运行上述SQL，即可得到下图所示结果，显示 field 为1，表示当前ID字段有一个注释；

 

(c)我们可以在换一个字段，换成当前 log_fccb 表 errorMsg 字段，再次编辑执行SQL，如下图所示，得到的结果field就是0；

 (d)然后我们打开 log_fccb 数据表结构，如下图所示，errorMsg字段确实没有被添加注释；

 

2.4 开发常用添加注释语法

上面说的都是琐碎的语法，我们平常自己练习的时候可以使用，但在日常开发过程中，对数据库SQL脚本的要求是比较高的，最好不要出错，或者再执行脚本前去数据库中做判断。

（1）比如创建表，首先要判断是否存在，如果存在先删除，删除之后再创建；

（2）比如添加字段，要先判断字段是否存在，若存在先删除，删除之后再重新添加新的字段类型；

同理，注释也是一样的，我们再给表中的字段添加注释之前，要先判断当前字段是否已经存在注释，若存在则不添加；

此时，我们就可以将刚才的两个函数结合使用，再搭配 IF 语句做判断；

(a)SQL如下所示

-- IF做判断，括号内即为 fn_listextendedproperty 函数，返回值为0或1，
-- 如果为0，说明做判断的字段没有备注，就调用 sp_addextendedproperty 
-- 函数为其添加备注，如果返回值为1不等于0，则后面的函数也不会执行，
-- 由此就达到了没有备注添加备注有备注则不做任何操作的目的
IF (
	SELECT COUNT(*) 
	FROM fn_listextendedproperty('MS_Description', 'SCHEMA', 'dbo', 'TABLE', 'log_fccb', 'COLUMN', 'errorMsg')
) = 0
EXEC sp_addextendedproperty 
@name=N'MS_Description', @value=N'错误信息',
@level0type=N'SCHEMA', @level0name=N'dbo',    
@level1type=N'TABLE', @level1name=N'log_fccb',
@level2type=N'COLUMN', @level2name=N'errorMsg';

(b)上面也说到了， fn_listextendedproperty 函数中的8个参数前置可以省略，同理 sp_addextendedproperty 也可以省略，省略完毕之后，我们的SQL就得到了极大的简化，简化后如下

IF (
		SELECT COUNT(*) 
	  FROM fn_listextendedproperty('MS_Description', 'SCHEMA', 'dbo', 'TABLE', 'log_fccb', 'COLUMN', 'errorMsg')
) = 0
EXEC sp_addextendedproperty
N'MS_Description', N'错误信息',
N'SCHEMA', N'dbo',
N'TABLE', N'log_fccb',
N'COLUMN', N'errorMsg';

(c)运行上述SQL，结果如下执行成功

 (d)然后我们再打开 log_fccb 表，就可以看到 errorMsg 字段已经被我们成功添加注释；

 

三. 修改备注

3.1 修改备注基本语法（sys.sp_updateextendedproperty）

在SQL server中，使用"sys.sp_updateextendedproperty"即可更新表中字段的注释。和刚才的添加注释方法几乎没有区别，只是换了一个函数；

(a)举例：继续拿上面的 log_fccb 表举例，将刚才给ID字段添加的注释 "主键ID" 修改为 "新的备注主键ID" ，SQL如下。

--  更新log_fccb 表中字段ID的备注为 "新的备注主键ID"
EXEC sys.sp_updateextendedproperty
N'MS_Description', N'新的注释主键ID', 
N'SCHEMA', N'dbo', 
N'TABLE', N'log_fccb', 
N'COLUMN', N'ID';

(b)执行SQL，如下所示显示成功，

 (c)然后我们打开 log_fccb 表，就可以看到主键ID的备注已经被修改为新的了；

3.2 需要注意的坑

(a)虽然使用 sys.sp_updateextendedproperty 可以帮助我们修改字段的备注，但是特也有坑需要我们注意，如果我们要修改备注的字段根本就没有添加备注，它就会修改失败；如下图所示，显示该字段没有 "MS_Description" 属性，该属性是在给字段添加过注释之后才有的，没有添加过注释的字段是没有的，所以会报错。

(b)如下图所示，我给 res_text 字段修改备注为"响应文本"，但实际上该字段原本没有备注，执行SQL，就会报出如下错误；

3.3 添加注释与修改注释的搭配使用

(c)上面我们将 fn_listextendedproperty 函数和 sp_addextendedproperty 函数搭配使用给没有备注的字段添加注释，这里我们可以继续扩展，再搭配上 sys.sp_updateextendedproperty 更新函数更新表的字段；

(d)SQL如下所示

-- 1. 判断 res_text 字段当前有没有注释，如果没有则为其添加注释 "响应文本666"
IF (
		SELECT COUNT(*) 
	  FROM fn_listextendedproperty('MS_Description', 'SCHEMA', 'dbo', 'TABLE', 'log_fccb', 'COLUMN', 'res_text')
) = 0
EXEC sp_addextendedproperty
N'MS_Description', N'响应文本666',
N'SCHEMA', N'dbo',
N'TABLE', N'log_fccb',
N'COLUMN', N'res_text'
-- 2. 判断当前res_text 字段当前有没有注释，如果有则把注释改为 "响应文本999"
else IF (
		SELECT COUNT(*) 
	  FROM fn_listextendedproperty('MS_Description', 'SCHEMA', 'dbo', 'TABLE', 'log_fccb', 'COLUMN', 'res_text')
) = 1
EXEC sys.sp_updateextendedproperty
N'MS_Description', N'响应文本999',
N'SCHEMA', N'dbo',
N'TABLE', N'log_fccb',
N'COLUMN', N'res_text';

(e)运行SQL，得到OK，说明执行成功， 

(f)打开 log_fccb 表，可以看到 res_text 字段 注释已经被改为 "响应文本999"目的达成

四. 删除备注

4.1 删除备注基本语法

(a)删除其实都没什么好说的，因为开发过程中我们几乎都是去添加或者修改注释，不会去删除注释，但还是提一嘴，删除注释函数为 dorp ，然后下方8个参数不需要写注释，因为要删掉注释，当然不需要写注释内容，所以剩下7个参数，其他语法不变；示例SQL如下所示；

-- 删除 log_fccb 表中 errorMsg 字段的备注
EXEC sys.sp_dropextendedproperty 
    @name=N'MS_Description', 
    @level0type=N'SCHEMA', @level0name=N'dbo', 
    @level1type=N'TABLE', @level1name=N'log_fccb', 
    @level2type=N'COLUMN', @level2name=N'errorMsg';

(b)执行此SQL，如下图OK成功

(c)打开 log_fccb 表，可以看到 errorMsg 字段的注释已经被删除了；

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.coloradmin.cn/o/2036473.html

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

深入理解 PHP 高性能框架 Workerman 守护进程原理

深入理解 PHP 高性能框架 Workerman 守护进程原理

大家好，我是码农先森。 守护进程顾名思义就是能够在后台一直运行的进程，不会霸占用户的会话终端，脱离了终端的控制。相信朋友们对这东西都不陌生了吧？如果连这个概念都还不能理解的话，建议回炉重造多看看 Linux 进程管…
阅读更多...
C++：vector类（default关键字，迭代器失效）

C++：vector类（default关键字，迭代器失效）

目录 前言 成员变量结构 iterator定义 size capacity empty clear swap []运算符重载 push_back pop_back reserve resize 构造函数 默认构造函数 default 迭代器构造 拷贝构造函数 赋值重载函数 析构函数 insert erase 迭代器失效问题 insert失效 er…
阅读更多...
Linux使用学习笔记3 系统运维监控基础

Linux使用学习笔记3 系统运维监控基础

系统运维监控类命令 查询每个进程的线程数 for pid in $(ps -ef | grep -v grep|grep "systemd" |awk {print $2});do echo ${pid} > /tmp/a.txt;cat /proc/${pid}/status|grep Threads > /tmp/b.txt;paste /tmp/a.txt /tmp/b.txt;done|sort -k3 -rn for pid…
阅读更多...
mfc100u.dll丢失问题分析，详细讲解mfc100u.dll丢失解决方法

mfc100u.dll丢失问题分析，详细讲解mfc100u.dll丢失解决方法

面对mfc100u.dll文件丢失带来的挑战时，许多用户都可能感到有些无助，尤其是当这一问题影响到他们日常使用的软件时。但实际上，存在几种有效方法可以帮助您快速恢复该关键的系统文件。为了方便不同水平的用户，本文将详细解析各种处理…
阅读更多...
自动化测试工具Selenium IDE

自动化测试工具Selenium IDE

简介 Selenium IDE 是实现Web自动化的一种便捷工具，本质上它是一种浏览器插件。该插件支持Chrome和Firefox浏览器，拥有录制、编写及回放操作等功能，能够快速实现Web的自动化测试。 使用场景 1、Selenium IDE本身的定位并不是用于复杂的自动…
阅读更多...
Ps：首选项 - 技术预览

Ps：首选项 - 技术预览

Ps菜单：编辑/首选项 Edit/Preferences 快捷键：Ctrl K Photoshop 首选项中的“技术预览” Technology Previews选项卡允许用户启用或禁用一些实验性功能，以测试或使用 Adobe 提供的最新技术。 技术预览 Technology Previews 启用保留细节 2.0…
阅读更多...
如何解决浏览器页面过曝，泛白等问题

如何解决浏览器页面过曝，泛白等问题

问题描述，分别对应edge和chrome浏览器这是什么原因？
阅读更多...
使用C#禁止Windows系统插入U盘（除鼠标键盘以外的USB设备）

使用C#禁止Windows系统插入U盘（除鼠标键盘以外的USB设备）

试用网上成品的禁用U盘的相关软件，发现使用固态硬盘改装的U盘以及手机等设备，无法被禁止，无奈下，自己使用C#手搓了一个。 基本逻辑： 开机自启；启动时，修改注册表，禁止系统插入USB存…
阅读更多...
字符串函数!!!(续)(C语言)

字符串函数!!!(续)(C语言)

一. strtok函数的使用 继续上次的学习，今天我们来认识一个新的函数strtok，它的原型是char* strtok(char* str,const char* sep)，sep参数指向了一个字符串，定义了用作分隔符的字符合集，第一个参数指定⼀个字符串&#…
阅读更多...
DataStream API的Joining操作

DataStream API的Joining操作

目录 Window Join Tumbling Window Join Sliding Window Join Session Window Join Interval Join Window CoGroup Window Join 窗口连接（window join）将两个流的元素连接在一起，这两个流共享一个公共键，并且位于同一窗口。…
阅读更多...
从老旧到智慧病房，全视通智慧病房方案减轻医护工作负担

从老旧到智慧病房，全视通智慧病房方案减轻医护工作负担

传统的老旧病房面临着诸多挑战。例如，患者风险信息的管理仍依赖于手写记录和人工核查；病房呼叫系统仅支持基本的点对点呼叫，缺乏与其它系统的集成能力；信息传递主要依靠医护人员口头传达；护理信息管理分散且不连贯&…
阅读更多...
JavaEE-多线程

JavaEE-多线程

前情提要：本文内容过多，建议搭配目录食用，想看哪里点哪里~ PC端目录 手机端目录 话不多说，我们正式开始~~ 目录 多线程的概念进程和线程的区别和联系:使用Java代码进行多线程编程Thread类中的方法和属性线程的核心操作1. 启动…
阅读更多...
【mamba学习】（一）SSM原理与说明

【mamba学习】（一）SSM原理与说明

mamba输入输出实现与transformer几乎完全一样的功能，但速度和内存占用具有很大优势。对比transformer，transformer存在记忆有限的情况，如果输入或者预测的序列过长可能导致爆炸（非线性），而mamba不存在这种情…
阅读更多...
物理网卡MAC修改器v3.0-直接修改网卡内部硬件MAC地址，重装系统不变！

物理网卡MAC修改器v3.0-直接修改网卡内部硬件MAC地址，重装系统不变！

直接在操作系统里就能修改网卡硬件mac地址，刷新网卡mac序列号硬件码机器码，电脑主板集成网卡，pcie网卡，usb有线网卡，usb无线网卡，英特尔网卡，瑞昱网卡全支持！ 一键修改mac&#xff0…
阅读更多...
百问网全志系列开发板音频ALSA配置步骤详解

百问网全志系列开发板音频ALSA配置步骤详解

8 ALSA 8.1 音频相关概念 ​ 音频信号是一种连续变化的模拟信号，但计算机只能处理和记录二进制的数字信号，由自然音源得到的音频信号必须经过一定的变换，成为数字音频信号之后，才能送到计算机中作进一步的处理。 ​ 数字音频系…
阅读更多...
MySQL本地Windows安装

MySQL本地Windows安装

下载MySQL 官网：MySQL 下载完成后文件 安装类型 选择功能 功能过滤筛选，系统为64位操作系统，所以选【64-bit】，32位可选【32.bit】 下方勾选后自动检查安装环境，如果提示缺少运行库，请先安装VC_redist.x64。…
阅读更多...
【Dash】plotly.express 气泡图

【Dash】plotly.express 气泡图

一、More about Visualization The Dash Core Compnents module dash.dcc includes a componenet called Graph. Graph renders interactive data visualizations using the open source plotly.js javaScript graphing library.Plotly.js supports over 35 chart types and …
阅读更多...
数据结构 之 二叉树功能的代码实现

数据结构 之 二叉树功能的代码实现

文章目录 二叉搜索树搜索删除节点二叉树的遍历 代码实现 二叉搜索树 无序树的查找，就是整个遍历，所以时间复杂度为O(N)。为了优化无序查找的时间复杂度，我们把树进行排序，这里引入了二叉搜索树。 二叉搜索树是一个有序树&#xf…
阅读更多...
vue el-select下拉框在弹框里面错位，

vue el-select下拉框在弹框里面错位，

1&#xff1a;原因是因为 底层滚动条滚动的问题。 2&#xff1a;解决方案 加上这个属性 :popper-append-to-body"false" 和样式 <el-select:popper-append-to-body"false"> </el-select><style> .el-select .el-select-dropdown {t…
阅读更多...
数据埋点系列 4｜数据分析与可视化：从数据到洞察

数据埋点系列 4｜数据分析与可视化：从数据到洞察

在前面的文章中,我们讨论了数据埋点的基础知识、技术实现以及数据质量保证。现在,我们拥有了高质量的数据,是时候深入挖掘这些数据的价值了。本文将带你探索如何通过数据分析和可视化,将原始数据转化为有价值的业务洞察。 目录 1. 数据分析基础1.1 描述性统计1.2 推断统计1.3 相…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023