Get-DbaDbStoredProcedure

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.

Synopsis

Gets database Stored Procedures

Description

Gets database Stored Procedures

Syntax

Get-DbaDbStoredProcedure
    [[-SqlInstance] <DbaInstanceParameter[]>]
    [[-SqlCredential] <PSCredential>]
    [[-Database] <Object[]>]
    [[-ExcludeDatabase] <Object[]>]
    [-ExcludeSystemSp]
    [[-Name] <String[]>]
    [[-Schema] <String[]>]
    [[-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

Example: 7

PS C:\> Get-DbaDbStoredProcedure -SqlInstance Server1 -Database db1 -Name schema1.proc1

Gets the Stored Procedure proc1 in the schema1 schema in the db1 database

Example: 8

PS C:\> Get-DbaDbStoredProcedure -SqlInstance Server1 -Name db1.schema1.proc1

Gets the Stored Procedure proc1 in the schema1 schema in the db1 database

Example: 9

PS C:\> Get-DbaDbStoredProcedure -SqlInstance Server1 -Database db1 -Name proc1

Gets the Stored Procedure proc1 in the db1 database

Example: 10

PS C:\> Get-DbaDbStoredProcedure -SqlInstance Server1 -Database db1 -Schema schema1

Gets the Stored Procedures in schema1 for the db1 database

Optional Parameters

-SqlInstance

The target SQL Server instance or instances

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

-Database

To get Stored Procedures from specific database(s)

-ExcludeDatabase

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

-ExcludeSystemSp

This switch removes all system objects from the Stored Procedure collection

-Name

Name(s) of the stored procedure(s) to return. It is possible to specify two-part names such as schemaname.procname and three-part names such as dbname.schemaname.procname.

-Schema

Only return procedures from the specified schema.

-InputObject

Enables piping from Get-DbaDatabase

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