commands

^

Get-DbaExtendedProperty

Author Chrissy LeMaire (@cl), netnerds.net
Availability Windows, Linux, macOS

 

Synopsis

Gets extended properties

Description

Gets extended properties

This command works out of the box with databases but you can add or get extended properties from any object. Just pipe it in it'll grab the properties and print them out.

You can get extended properties on all these different types of objects:

Aggregate Assembly Column Constraint Contract Database Event Notification Filegroup Function Index Logical File Name Message Type Parameter Partition Function Partition Scheme Procedure Queue Remote Service Binding Route Rule Schema Service Synonym Table Trigger Type View Xml Schema Collection

Syntax

Get-DbaExtendedProperty
    [[-SqlInstance] <DbaInstanceParameter[]>]
    [[-SqlCredential] <PSCredential>]
    [[-Database] <String[]>]
    [[-Name] <String[]>]
    [[-InputObject] <PSObject[]>]
    [-EnableException]
    [<CommonParameters>]

 

Examples

 

Example: 1
PS C:\> Get-DbaExtendedProperty -SqlInstance sql2016

Gets all extended properties on all databases

Example: 2
PS C:\> Get-DbaExtendedProperty -SqlInstance Server1 -Database db1

Gets the extended properties for the db1 database

Example: 3
PS C:\> Get-DbaExtendedProperty -SqlInstance Server1 -Database db1 -Name info1, info2

Gets the info1 and info2 extended properties within the db1 database

Example: 4
PS C:\> Get-DbaDbStoredProcedure -SqlInstance localhost -Database tempdb | Get-DbaExtendedProperty

Get the extended properties for all stored procedures in the tempdb database

Example: 5
PS C:\> Get-DbaDbTable -SqlInstance localhost -Database mydb -Table mytable | Get-DbaExtendedProperty

Get the extended properties for the mytable table in the mydb database

Optional Parameters

-SqlInstance

The target SQL Server instance

Alias
Required False
Pipeline false
Default Value
-SqlCredential

Login to the target instance using alternative credentials. Accepts PowerShell credentials (Get-Credential). Windows Authentication, SQL Server Authentication, Active Directory - Password, and Active Directory - Integrated are all supported. For MFA support, please use Connect-DbaInstance.

Alias
Required False
Pipeline false
Default Value
-Database

Get extended properties from specific database

Alias
Required False
Pipeline false
Default Value
-Name

Get specific extended properties by name

Alias Property
Required False
Pipeline false
Default Value
-InputObject

Enables piping from Get-Dba* commands

Alias
Required False
Pipeline true (ByValue)
Default Value
-EnableException

By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message. This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting. Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.

Alias
Required False
Pipeline false
Default Value False

 

Want to see the source code for this command? Check out Get-DbaExtendedProperty on GitHub.
Want to see the Bill Of Health for this command? Check out Get-DbaExtendedProperty.