深刻理解SQL Server系统存储过程sp_rename

时间:2022-03-24 10:35:55
语法
 
sp_rename [ @objname = ] 'object_name' , [ @newname = ] 'new_name' 
    [ , [ @objtype = ] 'object_type' ] 

备注

只能更改当前数据库中的对象名称或数据类型名称。大多数系统数据类型和系统对象的名称都不能更改。

每当重命名 PRIMARY KEY 或 UNIQUE 约束时,sp_rename 都会自动重命名关联的索引。如果重命名的索引与 PRIMARY KEY 约束关联,则 sp_rename 也会自动重命名该 PRIMARY KEY 约束。

sp_rename 可用于重命名主要和次要的 XML 索引。

重命名存储过程、函数、视图或触发器将不会更改 sys.sql_modules 类别视图的 definition 列中相应对象名的名称。因此,我们建议不要使用 sp_rename 重命名这些对象类型。而是删除对象,然后使用新名称重新创建该对象。

重命名诸如表或列等对象将不会自动重命名对该对象的引用。您必须手动修改引用已重命名对象的任何对象。例如,如果您重命名表列,并且触发器中引用了该列,则必须修改触发器以反映新的列名。在重命名对象之前,使用 sys.sql_dependencies 列出该对象的依赖关系。

参数

[ @objname = ] 'object_name'

用户对象或数据类型的当前限定或非限定名称。如果要重命名的对象是表中的列,则 object_name 的格式必须是 table.column。如果要重命名的对象是索引,则 object_name 的格式必须是 table.index。

只有在指定了合法的对象时才必须使用引号。如果提供了完全限定名称,包括数据库名称,则该数据库名称必须是当前数据库的名称。object_name 的数据类型为 nvarchar(776),无默认值。

[ @newname = ] 'new_name'

指定对象的新名称。new_name 必须是名称的一部分,并且必须遵循标识符的规则。newname 的数据类型为 sysname,无默认值。

注意:
触发器名称不能以 # 或 ## 开头。

 

[ @objtype = ] 'object_type'

要重命名的对象的类型。object_type 的数据类型为 varchar(13),默认值为 NULL,可取下列值之一。

 

说明

COLUMN

要重命名的列。

DATABASE

用户定义数据库。重命名数据库时需要此对象类型。

INDEX

用户定义索引。

OBJECT

sys.objects 中跟踪的类型的项目。例如,OBJECT 可用于重命名约束(CHECK、FOREIGN KEY、PRIMARY/UNIQUE KEY)、用户表和规则等对象。

USERDATATYPE

通过执行 CREATE TYPEsp_addtype 添加别名数据类型或 CLR 用户定义类型。

返回代码值

0(成功)或非零数字(失败)

权限

若要重命名对象、列和索引,则需要对该对象具有 ALTER 权限。若要重命名用户类型,则需要对该类型具有 CONTROL 权限。若要重命名数据库,需要具备 sysadmin 或 dbcreator 固定服务器角色的成员身份

示例

A. 重命名表

以下示例将 SalesTerritory 表重命名为 SalesTerr

USE AdventureWorks;
GO
EXEC sp_rename 'Sales.SalesTerritory', 'SalesTerr';
GO

B. 重命名列

以下示例将 SalesTerritory 表中的 TerritoryID 列重命名为 TerrID

USE AdventureWorks;
GO
EXEC sp_rename 'Sales.SalesTerritory.TerritoryID', 'TerrID', 'COLUMN';
GO

C. 重命名索引

以下示例将 IX_ProductVendor_VendorID 索引重命名为 IX_VendorID

USE AdventureWorks;
GO
EXEC sp_rename N'Purchasing.ProductVendor.IX_ProductVendor_VendorID', N'IX_VendorID', N'INDEX';
GO

D. 重命名别名数据类型

以下示例将 Phone 别名数据类型重命名为 Telephone

USE AdventureWorks;
GO
EXEC sp_rename N'Phone', N'Telephone', N'USERDATATYPE';
GO