Updates the MS_Description extended property of a table or column.
Update-Description [-Description] <String> [-SchemaName <String>] -TableName <String> [-ColumnName <String>] [<CommonParameters>]The sys.sp_updateextendedproperty stored procedure is used to update 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 updated. |
true | false | |
| ColumnName | String | The name of the column where the extended property is getting updated. |
false | false |
Update-Description -Description 'Whoseit's whatsits table.' -TableName WhoseitsWhatsitsUpdates the description (i.e. the MS_Description extended property) on the WhoseitsWhatsits table.
Update-Description -Description 'Is it a snarfblat?' -TableName WhoseitsWhatsits -ColumnName IsSnarfblatUpdates the description (i.e. the MS_Description extended property) on the WhoseitsWhatsits table's IsSnarfblat column.