Rename-Index

Renames an index.

Syntax

Rename-Index [-TableName] <String> [-Name] <String> [-NewName] <String> [-SchemaName <String>] [<CommonParameters>]

Description

SQL Server ships with a stored procedure which is used to rename certain objects. This operation wraps that stored procedure.

Use Rename-Column to rename a column. Use Rename-DataType to rename a data type. Use Rename-Object to rename an object.

Related Commands

Parameters

Name	Type	Description	Required?	Pipeline Input	Default Value
TableName	String	The name of the table of the index to rename.	true	false
Name	String	The current name of the index.	true	false
NewName	String	The new name of the index.	true	false
SchemaName	String	The schema of the table. Default is `dbo`.	false	false	dbo

EXAMPLE 1

Rename-Index -TableName 'FooBar' -Name 'IX_Fizz' -NewName 'Buzz'

Changes the name of the Fizz index on the FooBar table to Buzz.

EXAMPLE 2

Rename-Index -SchemaName 'fizz' -TableName 'FooBar' -Name 'IX_Buzz' -NewName 'Fizz'

Demonstrates how to rename an index on a table that is in a schema other than dbo.

EXAMPLE 3

Rename-Index 'FooBar' 'IX_Fizz' 'Buzz'

Demonstrates how to use the short form to rename the Fizz index on the FooBar table to Buzz: table name is first, then existing index name, then new index name.