commands

^

Get-DbaDbUdf

Author Klaas Vandenberghe (@PowerDbaKlaas)
Availability Windows, Linux, macOS

 

Synopsis

Gets database User Defined Functions

Description

Gets database User Defined Functions

Syntax

Get-DbaDbUdf
    [-SqlInstance] <DbaInstanceParameter[]>
    [[-SqlCredential] <PSCredential>]
    [[-Database] <Object[]>]
    [[-ExcludeDatabase] <Object[]>]
    [-ExcludeSystemUdf]
    [[-Schema] <String[]>]
    [[-ExcludeSchema] <String[]>]
    [[-Name] <String[]>]
    [[-ExcludeName] <String[]>]
    [-EnableException]
    [<CommonParameters>]

 

Examples

 

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

Gets all database User Defined Functions

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

Gets the User Defined Functions for the db1 database

Example: 3
PS C:\> Get-DbaDbUdf -SqlInstance Server1 -ExcludeDatabase db1

Gets the User Defined Functions for all databases except db1

Example: 4
PS C:\> Get-DbaDbUdf -SqlInstance Server1 -ExcludeSystemUdf

Gets the User Defined Functions for all databases that are not system objects (there can be 100+ system User Defined Functions in each DB)

Example: 5
PS C:\> 'Sql1','Sql2/sqlexpress' | Get-DbaDbUdf

Gets the User Defined Functions for the databases on Sql1 and Sql2/sqlexpress

Required Parameters

-SqlInstance

The target SQL Server instance or instances

Alias
Required True
Pipeline true (ByValue)
Default Value

Optional Parameters

-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 User Defined Functions 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
-ExcludeSystemUdf

This switch removes all system objects from the UDF collection

Alias
Required False
Pipeline false
Default Value False
-Schema

The schema(s) to process. If unspecified, all schemas will be processed.

Alias
Required False
Pipeline false
Default Value
-ExcludeSchema

The schema(s) to exclude.

Alias
Required False
Pipeline false
Default Value
-Name

The name(s) of the user defined functions to process. If unspecified, all user defined functions will be processed.

Alias
Required False
Pipeline false
Default Value
-ExcludeName

The name(s) of the user defined functions to exclude.

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

 

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