Functions/Operations/Rename-Index.ps1
|
function Rename-Index { <# .SYNOPSIS Renames an index. .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. .LINK http://technet.microsoft.com/en-us/library/ms188351.aspx .LINK Rename-Column .LINK Rename-DataType .LINK Rename-Object .EXAMPLE Rename-Index -TableName 'FooBar' -Name 'IX_Fizz' -NewName 'Buzz' Changes the name of the `Fizz` index on the `FooBar` table to `Buzz`. .EXAMPLE 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 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. #> [CmdletBinding()] param( [Parameter(Mandatory=$true,Position=0)] [string] # The name of the table of the index to rename. $TableName, [Parameter(Mandatory=$true,Position=1)] [string] # The current name of the index. $Name, [Parameter(Mandatory=$true,Position=2)] [string] # The new name of the index. $NewName, [Parameter()] [string] # The schema of the table. Default is `dbo`. $SchemaName = 'dbo' ) Set-StrictMode -Version 'Latest' New-Object 'Rivet.Operations.RenameIndexOperation' $SchemaName, $TableName, $Name, $NewName } |