sp_rename (Transact-SQL)

Gilt für:yes SQL Server (alle unterstützten Versionen) YesAzure SQL-Datenbank yesAzure Synapse Analytics

Ändert den Namen eines vom Benutzer erstellten Objekts in der aktuellen Datenbank. Dieses Objekt kann ein tabellen-, Index-, Spalten-, Aliasdatentyp oder Microsoft .NET Framework common language runtime (CLR) benutzerdefinierter Typ sein.

Hinweis

In Azure Synapse Analytics befindet sich sp_rename in der Vorschau für dedizierte SQL Pools und kann nur verwendet werden, um eine SPALTE in einem Benutzerobjekt umzubenennen.

Achtung

Wenn Sie Teile eines Objektnamens ändern, können Skripts und gespeicherte Prozeduren funktionsunfähig werden. Es ist empfehlenswert, diese Anweisung nicht zum Umbenennen von gespeicherten Prozeduren, Triggern, benutzerdefinierten Funktionen oder Sichten zu verwenden. Löschen Sie stattdessen das Objekt, und erstellen Sie es neu mit dem neuen Namen.

Topic link iconTransact-SQL-Syntaxkonventionen

Syntax

-- Transact-SQL Syntax for sp_rename in SQL Server and Azure SQL Database
sp_rename [ @objname = ] 'object_name' , [ @newname = ] 'new_name'   
    [ , [ @objtype = ] 'object_type' ]   
-- Transact-SQL Syntax for sp_rename (preview) in Azure Synapse Analytics
sp_rename [ @objname = ] 'object_name' , [ @newname = ] 'new_name'   
    , [ @objtype = ] 'COLUMN'   

Argumente

[ @objname = ] 'object_name'
Der aktuelle qualifizierte oder nicht qualifizierte Name des Benutzerobjekts oder Datentyps. Wenn das zu benennende Objekt eine Spalte in einer Tabelle ist, muss object_name sich in der Spalte " form table.column " oder " schema.table.column" befinden. Wenn das zu benennende Objekt ein Index ist, muss object_name sich in der Form table.index oder schema.table.index.index befinden. Wenn das zu benennende Objekt eine Einschränkung ist, muss object_name im Formularschema.constraint enthalten sein.

Anführungszeichen sind nur dann notwendig, wenn ein qualifiziertes Objekt angegeben wird. Bei Angabe eines vollqualifizierten Namens, einschließlich eines Datenbanknamens, muss es sich bei dem Datenbanknamen um den Namen der aktuellen Datenbank handeln. object_name ist nvarchar(776) ohne Standard.

[ @newname = ] 'new_name'
Der neue Name für das angegebene Objekt. new_name müssen einteiliger Name sein und die Regeln für Bezeichner befolgen. newname ist sysname, ohne Standard.

Hinweis

Namen von Triggern können nicht mit # oder ## beginnen.

[ @objtype = ] 'object_type'
Der Typ des Objekts, das umbenannt wird. object_type ist varchar(13), mit einem Standardwert von NULL und kann eine dieser Werte sein.

Wert BESCHREIBUNG
COLUMN Eine umzubenennende Spalte.
DATABASE Eine benutzerdefinierte Datenbank. Dieser Objekttyp ist erforderlich, wenn Sie eine Datenbank umbenennen.
INDEX Ein benutzerdefinierter Index. Beim Umbenennen eines Indizes mit Statistiken werden die Statistiken auch automatisch umbenannt.
OBJECT Ein Element eines Typs, der in sys.objects nachverfolgt wird. Beispielsweise könnte OBJECT zum Umbenennen von Objekten mit Einschränkungen (CHECK, FOREIGN KEY, PRIMARY/UNIQUE KEY), Benutzertabellen und Regeln verwendet werden.
STATISTICS Gilt für: SQL Server 2012 (11.x) und höher und Azure SQL-Datenbank.

Explizit von einem Benutzer erstellte Statistiken oder implizit mit einem Index erstellt Beim Umbenennen der Statistiken eines Indizes wird der Index auch automatisch umbenannt.
USERDATATYPE Ein BEnutzerdefinierter CLR-Typ , der durch Ausführen von CREATE TYPE oder sp_addtype hinzugefügt wird.

[ @objtype = ] 'COLUMN' gilt für: Azure Synapse Analytics
In sp_rename (Vorschau) für Azure Synapse Analytics ist COLUMN ein obligatorischer Parameter, der angibt, dass der zu benennende Objekttyp eine Spalte ist. Es handelt sich um einen Varchar(13) ohne Standardwert und muss immer in die sp_rename -Anweisung (Vorschau) einbezogen werden. Eine Spalte kann nur umbenannt werden, wenn es sich um eine Nichtverteilungsspalte handelt.

Rückgabecodewerte

0 (Erfolg) oder eine Zahl ungleich Null (Fehler)

Hinweise

Gilt für SQL Server (alle unterstützten Versionen) und Azure SQL-Datenbank
sp_rename sorgt dafür, dass beim Umbenennen einer PRIMARY KEY- oder UNIQUE-Einschränkung automatisch auch der zugehörige Index umbenannt wird. Wenn ein umbenannter Index an eine PRIMARY KEY-Einschränkung gebunden ist, wird auch die PRIMARY KEY-Einschränkung automatisch von sp_rename umbenannt.

Gilt für SQL Server (alle unterstützten Versionen) und Azure SQL-Datenbank
sp_rename kann zum Umbenennen von primären und sekundären XML-Indizes verwendet werden.

Gilt für SQL Server (alle unterstützten Versionen) und Azure SQL-Datenbank
Durch das Umbenennen einer gespeicherten Prozedur, funktion, Ansicht oder Trigger wird der Name des entsprechenden Objekts weder in der Definitionsspalte der sys.sql_modules Katalogansicht geändert noch mithilfe der integrierten OBJECT_DEFINITION-Funktion abgerufen. Daher ist es empfehlenswert, sp_rename nicht zum Umbenennen dieser Objekttypen zu verwenden. Löschen Sie stattdessen das Objekt, und erstellen Sie es neu mit dem neuen Namen.

Gilt für SQL Server (alle unterstützten Versionen), Azure SQL-Datenbank und Azure Synapse Analytics
Beim Umbenennen eines Objekts, wie z. B. einer Tabelle oder Spalte, werden Verweise auf das Objekt nicht automatisch umbenannt. Sie müssen Objekte, die auf das umbenannte Objekt verweisen, manuell ändern. Wenn Sie z. B. eine Tabellenspalte umbenennen und in einem Trigger auf diese Spalte verwiesen wird, müssen Sie den Trigger ändern, sodass er den neuen Spaltennamen wiedergibt. Verwenden Sie sys.sql_expression_dependencies , um Abhängigkeiten vom Objekt aufzulisten, bevor Sie es umbenennen.

Gilt für SQL Server (alle unterstützten Versionen), Azure SQL-Datenbank und Azure Synapse Analytics
Sie können Objekte und Datentypen nur in der aktuellen Datenbank umbenennen. Die Namen der meisten Systemdatentypen und -objekte können nicht geändert werden.

Berechtigungen

Zum Umbenennen von Objekten, Spalten und Indizes ist die ALTER-Berechtigung für das entsprechende Objekt erforderlich. Zum Umbenennen von Benutzertypen ist die CONTROL-Berechtigung für den entsprechenden Typ erforderlich. Zum Umbenennen einer Datenbank ist die Mitgliedschaft in der festen Serverrolle sysadmin oder dbcreator erforderlich.

Beispiele

A. Umbenennen einer Tabelle

Im folgenden Beispiel wird die SalesTerritory -Tabelle im Schema SalesTerr in Sales umbenannt.

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

B. Umbenennen einer Spalte

Im folgenden Beispiel wird die TerritoryID Spalte in der SalesTerritory Tabelle in " umbenannt TerrID.

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

C. Umbenennen eines Indexes

Im folgenden Beispiel wird der IX_ProductVendor_VendorID-Index in IX_VendorID umbenannt.

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

D: Umbenennen eines Aliasdatentyps

Im folgenden Beispiel wird der Phone-Aliasdatentyp in Telephone umbenannt.

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

E. Umbenennen von Einschränkungen

In den folgenden Beispielen wird eine PRIMARY KEY-Einschränkung, CHECK-Einschränkung und FOREIGN KEY-Einschränkung umbenannt. Beim Umbenennen einer Einschränkung muss das Schema angegeben werden, dem die Einschränkung angehört.

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. Umbenennen von Statistiken

Im folgenden Beispiel wird ein Statistikobjekt namens contactMail1 erstellt und dann mithilfe von sp_rename in NewContact umbenannt. Bei der Umbenennung von Statistiken muss das Objekt im Format schema.table.statistics_name angegeben werden.

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

Beispiele: Azure Synapse Analytics

G. Umbenennen einer Spalte

Im folgenden Beispiel wird die c1 Spalte in der table1 Tabelle in " umbenannt col1.

Hinweis

Dieses Azure Synapse Analytics-Feature befindet sich weiterhin in der Vorschau für dedizierte SQL Pools und ist derzeit nur für Objekte im dbo-Schema verfügbar.

CREATE TABLE table1 (c1 INT, c2 INT);
EXEC sp_rename 'table1.c1', 'col1', 'COLUMN';
GO  

Weitere Informationen

sys.sql_expression_dependencies (Transact-SQL)
sys.sql_modules (Transact-SQL)
Gespeicherte Systemprozeduren (Transact-SQL)
Gespeicherte Prozeduren für die Datenbank-Engine (Transact-SQL)