commands

^

Remove-DbaDbUdf

Author Mikey Bronowski (@MikeyBronowski), https://bronowski.it
Availability Windows, Linux, macOS

 

Synopsis

Removes a database user defined function(s) from each database and SQL Server instance.

Description

Removes a database user defined function(s), with supported piping from Get-DbaDbUdf.

Syntax

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

Remove-DbaDbUdf -InputObject <UserDefinedFunction[]>
    [-EnableException]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

 

Examples

 

Example: 1
PS C:\> Remove-DbaDbUdf -SqlInstance localhost, sql2016 -Database db1, db2 -Name udf1, udf2, udf3

Removes udf1, udf2, udf3 from db1 and db2 on the local and sql2016 SQL Server instances.

Example: 2
PS C:\> $udfs = Get-DbaDbUdf -SqlInstance localhost, sql2016 -Database db1, db2 -Name udf1, udf2, udf3
PS C:\> $udfs | Remove-DbaDbUdf

Removes udf1, udf2, udf3 from db1 and db2 on the local and sql2016 SQL Server instances.

Required Parameters

-SqlInstance

The target SQL Server instance or instances.

Alias
Required True
Pipeline false
Default Value
-InputObject

Allows piping from Get-DbaDbUdf.

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

The target 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
-WhatIf

Shows what would happen if the command were to run. No actions are actually performed.

Alias wi
Required False
Pipeline false
Default Value
-Confirm

Prompts you for confirmation before executing any changing operations within the command. This is the default. Use -Confirm:$false to suppress these prompts.

Alias cf
Required False
Pipeline false
Default Value

 

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