sp_rename (Transact-SQL)

  • 项目

在当前数据库中更改用户创建对象的名称。此对象可以是表、索引、列、别名数据类型或 Microsoft .NET Framework 公共语言运行时 (CLR) 用户定义类型。

注意事项注意

更改对象名的任一部分都可能破坏脚本和存储过程。我们建议您不要使用此语句来重命名存储过程、触发器、用户定义函数或视图；而是删除该对象，然后使用新名称重新创建该对象。

主题链接图标 Transact-SQL 语法约定

语法

sp_rename [ @objname = ] 'object_name' , [ @newname = ] 'new_name' 
    [ , [ @objtype = ] 'object_type' ]

参数

  • [ @objname = ] 'object_name'
    用户对象或数据类型的当前限定或非限定名称。如果要重命名的对象是表中的列，则 object_name 的形式必须是 table.column 或 schema.table.column。如果要重命名的对象是索引，则 object_name 的形式必须是 table.index 或 schema.table.index。如果要重命名的对象是约束，则 object_name 的形式必须是 schema.constraint。

    只有在指定了限定对象时才必须使用引号。如果提供的是完全限定名称（包括数据库名称），则数据库名称必须是当前数据库的名称。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）、用户表和规则在内的对象。

    STATISTICS

    由用户显式创建的统计信息或使用索引隐式创建的统计信息。重命名索引的统计信息时，也会自动重命名索引。

    USERDATATYPE

    通过执行 CREATE TYPE 或 sp_addtype 添加的 CLR 用户定义类型。

返回代码值

0（成功）或非零数字（失败）

注释

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

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

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

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

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

权限

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

示例

A. 重命名表

下面的示例将 Sales 架构中的 SalesTerritory 表重命名为 SalesTerr。

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

B. 重命名列

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

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

C. 重命名索引

下面的示例将 IX_ProductVendor_VendorID 索引重命名为 IX_VendorID。

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

D. 重命名别名数据类型

下面的示例将 Phone 别名数据类型重命名为 Telephone。

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

E. 重命名约束

下面的示例重命名 PRIMARY KEY 约束、CHECK 约束和 FOREIGN KEY 约束。重命名约束时，必须指定约束所属的架构。

USE AdventureWorks2012; 
GO
-- Return the current Primary Key, Foreign Key and Check constraints for the Employee table.
SELECT name, SCHEMA_NAME(schema_id) AS schema_name, type_desc
FROM sys.objects
WHERE parent_object_id = (OBJECT_ID('HumanResources.Employee')) 
AND type IN ('C','F', 'PK'); 
GO

-- Rename the primary key constraint.
sp_rename 'HumanResources.PK_Employee_BusinessEntityID', 'PK_EmployeeID';
GO

-- Rename a check constraint.
sp_rename 'HumanResources.CK_Employee_BirthDate', 'CK_BirthDate';
GO

-- Rename a foreign key constraint.
sp_rename 'HumanResources.FK_Employee_Person_BusinessEntityID', 'FK_EmployeeID';

-- Return the current Primary Key, Foreign Key and Check constraints for the Employee table.
SELECT name, SCHEMA_NAME(schema_id) AS schema_name, type_desc
FROM sys.objects
WHERE parent_object_id = (OBJECT_ID('HumanResources.Employee')) 
AND type IN ('C','F', 'PK'); 

name                                  schema_name        type_desc
------------------------------------- ------------------ ----------------------
FK_Employee_Person_BusinessEntityID   HumanResources     FOREIGN_KEY_CONSTRAINT
PK_Employee_BusinessEntityID          HumanResources     PRIMARY_KEY_CONSTRAINT
CK_Employee_BirthDate                 HumanResources     CHECK_CONSTRAINT
CK_Employee_MaritalStatus             HumanResources     CHECK_CONSTRAINT
CK_Employee_HireDate                  HumanResources     CHECK_CONSTRAINT
CK_Employee_Gender                    HumanResources     CHECK_CONSTRAINT
CK_Employee_VacationHours             HumanResources     CHECK_CONSTRAINT
CK_Employee_SickLeaveHours            HumanResources     CHECK_CONSTRAINT

(7 row(s) affected)

name                                  schema_name        type_desc
------------------------------------- ------------------ ----------------------
FK_Employee_ID                        HumanResources     FOREIGN_KEY_CONSTRAINT
PK_Employee_ID                        HumanResources     PRIMARY_KEY_CONSTRAINT
CK_BirthDate                          HumanResources     CHECK_CONSTRAINT
CK_Employee_MaritalStatus             HumanResources     CHECK_CONSTRAINT
CK_Employee_HireDate                  HumanResources     CHECK_CONSTRAINT
CK_Employee_Gender                    HumanResources     CHECK_CONSTRAINT
CK_Employee_VacationHours             HumanResources     CHECK_CONSTRAINT
CK_Employee_SickLeaveHours            HumanResources     CHECK_CONSTRAINT

(7 row(s) affected)

F. 重命名统计信息

下面的示例创建一个名为 contactMail1 的统计信息对象，然后使用 sp_rename 将统计信息重命名为 NewContact。重命名统计信息时，必须采用格式 schema.table.statistics_name 指定该对象。

CREATE STATISTICS ContactMail1
    ON Person.Person (BusinessEntityID, EmailPromotion)
    WITH SAMPLE 5 PERCENT;

sp_rename 'Person.Person.ContactMail1', 'NewContact','Statistics';

请参阅

参考

sys.sql_expression_dependencies (Transact-SQL)

sys.sql_modules (Transact-SQL)

系统存储过程 (Transact-SQL)

数据库引擎存储过程 (Transact-SQL)