commands

^

Get-DbaDbStoredProcedure

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

 

Synopsis

Gets database Stored Procedures

Description

Gets database Stored Procedures

Syntax

Get-DbaDbStoredProcedure
    [[-SqlInstance] <DbaInstanceParameter[]>]
    [[-SqlCredential] <PSCredential>]
    [[-Database] <Object[]>]
    [[-ExcludeDatabase] <Object[]>]
    [-ExcludeSystemSp]
    [[-InputObject] <Database[]>]
    [-EnableException]
    [<CommonParameters>]

 

Examples

 

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

Gets all database Stored Procedures

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

Gets the Stored Procedures for the db1 database

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

Gets the Stored Procedures for all databases except db1

Example: 4
PS C:\> Get-DbaDbStoredProcedure -SqlInstance Server1 -ExcludeSystemSp

Gets the Stored Procedures for all databases that are not system objects

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

Gets the Stored Procedures for the databases on Sql1 and Sql2/sqlexpress

Example: 6
PS C:\> Get-DbaDatabase -SqlInstance Server1 -ExcludeSystem | Get-DbaDbStoredProcedure

Pipe the databases from Get-DbaDatabase into Get-DbaDbStoredProcedure

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
-ExcludeSystemSp

This switch removes all system objects from the Stored Procedure collection

Alias
Required False
Pipeline false
Default Value False
-InputObject

Enables piping from Get-DbaDatabase

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-DbaDbStoredProcedure on GitHub.
Want to see the Bill Of Health for this command? Check out Get-DbaDbStoredProcedure.