commands

^

Get-DbaDbUserDefinedTableType

Author Ant Green (@ant_green)
Availability Windows, Linux, macOS

 

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

Synopsis

Gets database user defined table types

Description

Gets database user defined table types

Syntax

Get-DbaDbUserDefinedTableType
    [[-SqlInstance] <DbaInstanceParameter[]>]
    [[-SqlCredential] <PSCredential>]
    [[-Database] <Object[]>]
    [[-ExcludeDatabase] <Object[]>]
    [[-Type] <String[]>]
    [-EnableException]
    [<CommonParameters>]

 

Examples

 

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

Gets all database user defined table types in all the databases

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

Gets all the user defined table types for the db1 database

Example: 3
PS C:\> Get-DbaDbUserDefinedTableType -SqlInstance Server1 -Database db1 -Type type1

Gets type1 user defined table type from db1 database

Optional Parameters

-SqlInstance

The target SQL Server instance or instances

Alias
Required False
Pipeline true (ByValue)
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

To get Stored Procedures from specific database(s)

Alias
Required False
Pipeline false
Default Value
-ExcludeDatabase

The database(s) to exclude - this list is auto populated from the server

Alias
Required False
Pipeline false
Default Value
-Type

[OPTIONAL] When provided, the output will be filtered to return only the types given otherwise returns all the table types.

Alias
Required False
Pipeline false
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