• Статья

sp_rename (Transact-SQL)

Изменяет имя пользовательского объекта в текущей базе данных. Этот объект может быть таблицей, индексом, столбцом, псевдонимом типа данных или определяемым пользователем типом среды CLR Microsoft .NET Framework.

ПредупреждениеВнимание!

Изменение любой части имени объекта может разрушить сценарии и хранимые процедуры. Не рекомендуется использовать эту инструкцию для переименования хранимых процедур, триггеров, определяемых пользователем функций или представлений; следует удалить объект и создать его повторно с новым именем.

Значок ссылки на разделСоглашение о синтаксисе 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 имеет тип nvarchar(776) и не имеет значения по умолчанию.

  • [ @newname = ] 'new_name'
    Новое имя для указанного объекта. Имя new_name должно быть однокомпонентным, и соответствовать правилам для идентификаторов. Аргумент newname имеет тип sysname и не имеет значения по умолчанию.

    ПримечаниеПримечание

    Имена триггеров не могут начинаться с символов # или ##.

  • [ @objtype = ] 'object_type'
    Тип объекта, который будет переименован. Аргумент object_type имеет тип varchar(13), не имеет значения по умолчанию и может принимать одно из следующих значений:

    Значение

    Описание

    COLUMN

    Столбец, который будет переименован.

    DATABASE

    Пользовательская база данных. Этот тип объекта необходим при переименовании базы данных.

    INDEX

    Пользовательский индекс.

    OBJECT

    Элемент типа, отслеживаемого в представлении каталогов sys.objects. Например, значение OBJECT может быть использовано для переименования объектов с ограничениями (CHECK, FOREIGN KEY, PRIMARY/UNIQUE KEY) пользовательских таблиц и правил.

    USERDATATYPE

    Псевдоним типа данных или определяемые пользователем типы среды CLR, добавленные выполнением инструкции CREATE TYPE или процедуры sp_addtype.

Значения кода возврата

0 (успешное завершение) или ненулевое значение (неуспешное завершение)

Замечания

Изменить имя объекта или типа данных можно только в текущей базе данных. Имена большинства системных типов данных и системных объектов изменить нельзя.

Процедура sp_rename автоматически переименовывает ассоциированный индекс каждый раз при переименовании ограничения PRIMARY KEY или UNIQUE. Если переименованный индекс привязан к ограничению PRIMARY KEY, то ограничение PRIMARY KEY также автоматически переименовывается хранимой процедурой sp_rename.

Процедура sp_rename может использоваться для переименования первичных и вторичных XML-индексов.

Переименование хранимой процедуры, функции, представления или триггера не изменит имени соответствующего объекта в определении столбца представления каталога sys.sql_modules. Поэтому не рекомендуется использовать процедуру sp_rename для переименования объектов этих типов. Лучше удалить и создать объект повторно с новым именем.

Переименование такого объекта, как таблица или столбец не приводит к автоматическому переименованию ссылок на этот объект. Необходимо вручную изменить любые объекты, которые ссылаются на переименованный объект. Например, если переименован столбец таблицы и на этот столбец имеется ссылка в триггере, то необходимо изменить триггер, указав новое имя столбца. Используйте представление каталога sys.sql_expression_dependencies, чтобы составить список зависимостей для объекта перед его переименованием.

Разрешения

Для переименования объектов, столбцов и индексов требуется разрешение ALTER на объект. Для переименования определенных пользователем типов требуется разрешение CONTROL на тип. Для переименования базы данных требуется членство в предопределенных ролях сервера sysadmin или dbcreator.

Примеры

А. Переименование таблицы

В следующем примере столбец SalesTerritory в таблице SalesTerr переименовывается в Sales.

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

Б. Переименование столбца

В следующем примере столбец TerritoryID в таблице SalesTerritory переименовывается в TerrID.

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

В. Переименование индекса

В следующем примере индекс IX_ProductVendor_VendorID переименовывается в IX_VendorID.

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

Г. Переименование псевдонима типа данных

В следующем примере псевдоним типа данных Phone переименовывается в Telephone.

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