Adds the MS_Description extended property to a table or column.
Add-Description [-Description] <String> [-SchemaName <String>] -TableName <String> [-ColumnName <String>] [<CommonParameters>]The sys.sp_addextendedproperty stored procedure is used to set a table/column's description (i.e. the MS_Description extended property), but the syntax is weird. This function hides that weirdness from you. You're welcome.
| Name | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Description | String | The value for the MS_Description extended property. |
true | false | |
| SchemaName | String | The schema. Defaults to |
false | false | dbo |
| TableName | String | The name of the table where the extended property is getting set. |
true | false | |
| ColumnName | String | The name of the column where the extended property is getting set. |
false | false |
Add-Description -Description 'Whoseit's whatsits table.' -TableName WhoseitsWhatsitsAdds a description (i.e. the MS_Description extended property) on the WhoseitsWhatsits table.
Add-Description -Description 'Is it a snarfblat?' -TableName WhoseitsWhatsits -ColumnName IsSnarfblatAdds a description (i.e. the MS_Description extended property) on the WhoseitsWhatsits table's IsSnarfblat column.
Add-Description -Description 'Whoseit's whatsits table.' -TableName WhoseitsWhatsits -ForTablePowerShell v2.0 doesn't parse the parameters correctly when setting a table name, so you have to explicitly tell it what to do. Upgrade to PowerShell 3!