Remove-Description

Removes the MS_Description extended property for a table or column.

Syntax

Remove-Description [-SchemaName <String>] -TableName <String> [-ColumnName <String>] [<CommonParameters>]

Description

The sys.sp_dropextendedproperty stored procedure is used to remove 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.

Parameters

Name Type Description Required? Pipeline Input Default Value
SchemaName String

The schema. Defaults to dbo.

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

EXAMPLE 1

Remove-Description -TableName WhoseitsWhatsits

Removes the description (i.e. the MS_Description extended property) for the WhoseitsWhatsits table.

EXAMPLE 2

Remove-Description -TableName WhoseitsWhatsits -ColumnName IsSnarfblat

Removes the description (i.e. the MS_Description extended property) for the WhoseitsWhatsits table's IsSnarfblat column.