Renames a column.
Rename-Column [-TableName] <String> [-Name] <String> [-NewName] <String> [-SchemaName <String>] [<CommonParameters>]SQL Server ships with a stored procedure which is used to rename certain objects. This operation wraps that stored procedure.
Use Rename-DataType to rename a data type. Use Rename-Index to rename an index. Use Rename-Object to rename an object.
| Name | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| TableName | String | The name of the table of the column to rename. |
true | false | |
| Name | String | The current name of the column. |
true | false | |
| NewName | String | The new name of the column. |
true | false | |
| SchemaName | String | The schema of the table. Default is |
false | false | dbo |
Rename-Column -TableName 'FooBar' -Name 'Fizz' -NewName 'Buzz'Changes the name of the Fizz column in the FooBar table to Buzz.
Rename-Column -SchemaName 'fizz' -TableName 'FooBar' -Name 'Buzz' -NewName 'Baz'Demonstrates how to rename a column in a table that is in a schema other than dbo.
Rename-Column 'FooBar' 'Fizz' 'Buzz'Demonstrates how to use the short form to rename Fizz column in the FooBar table to Buzz: table name is first, then existing column name, then new column name.