sp_rename

Description

Changes the name of a user-created object or user-defined datatype in the current database.

Syntax

sp_rename objname, newname [,“index” | “column”]

Parameters

objname: is the original name of the user-created object (table, view, column, stored procedure, index, trigger, default, rule, check constraint, referential constraint, or user-defined datatype). If the object to be renamed is a column in a table, objname must be in the form “table.column”. If the object is an index, objname must be in the form “table.indexname”.

newname: is the new name of the object or datatype. The name must conform to the rules for identifiers and must be unique to the current database.

index: specifies that the object you are renaming is an index, not a column. This argument allows you to rename an index that has the same name as a column, without dropping and re-creating the index.

column: specifies that the object you are renaming is a column, not an index. This argument is part of the same option as the index argument.

Examples

Example 1

Renames the titles table to books:

sp_rename titles, books

Example 2

Renames the title column in the books table to bookname:

sp_rename "books.title", bookname

Example 3

Renames the titleind index in the books table to titleindex:

sp_rename "books.titleind", titleindex

Example 4

Renames the user-defined datatype tid to bookid:

sp_rename tid, bookid

Example 5

Renames the title_id index in the titles table to isbn:

sp_rename "titles.title_id", isbn, "index"

Usage

sp_rename changes the name of a user-created object or datatype. You can change only the name of an object or datatype in the database in which you issue sp_rename.

When you are renaming a column or index, do not specify the table name in newname. See Examples 2, 3, and 5.

If a column and an index have the same name, use the [,“index” | “column”] argument, which specifies whether to rename the index or the column. In the following sample, assume that both an index and a column named idx exist:

sp_rename "t.idx", new_idx, "column"
-------------

Column name has been changed. (Return status = 0)

sp_rename "t.idx", new_idx, "index"
-------------

Index name has been changed. (Return status = 0)

If you change the name of a an object or column name referenced by a view, you see a warning message, such as:

Changing an object or column name could break
existing stored procedures, cached statements or
other compiled objects.

sp_engine can run in sessions using chained transaction mode if there are no open transactions.

You cannot change the names of system objects and system datatypes.

WARNING! Procedures, triggers, and views that depend on an object whose name has been changed will no longer work. Change the definitions of any dependent objects before you execute sp_rename. Find dependent objects with sp_depends.

Permissions

Only the database owner or a system administrator can use the setuser command to assume another database user’s identity to rename objects owned by other users. All users can execute sp_rename to rename their own objects.

Auditing

Values in event and extrainfo columns from the sysaudits table are:

Event	Audit option	Command or access audited	Information in extrainfo
38	exec_procedure	Execution of a procedure	Roles – Current active roles Keywords or options – NULL Previous value – NULL Current value – NULL Other information – All input parameters Proxy information – Original login name, if set proxy in effect