< Back

Find-DbaStoredProcedure

Mon Jan 13, 2020 10:12 am

NAME Find-DbaStoredProcedure



SYNOPSIS

Returns all stored procedures that contain a specific case-insensitive string or regex pattern.





SYNTAX

Find-DbaStoredProcedure [-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>

[[-SqlCredential] <Pscredential>] [[-Database] <System.Object[]>] [[-ExcludeDatabase] <System.Object[]>]

[-Pattern] <String> [-IncludeSystemObjects <Switch>] [-IncludeSystemDatabases <Switch>] [-EnableException

<Switch>] [<CommonParameters>]





DESCRIPTION

This function can either run against specific databases or all databases searching all user or user and system

stored procedures.





PARAMETERS

-Database [<System.Object[]>]

The database(s) to process - this list is auto-populated from the server. If unspecified, all databases will

be processed.



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-EnableException [<Switch>]

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.



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-ExcludeDatabase [<System.Object[]>]

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



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-IncludeSystemDatabases [<Switch>]

By default system databases are ignored but you can include them within the search using this parameter



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-IncludeSystemObjects [<Switch>]

By default, system stored procedures are ignored but you can include them within the search using this

parameter.



Warning - this will likely make it super slow if you run it on all databases.



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-Pattern [<String>]

String pattern that you want to search for in the stored procedure text body



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-SqlCredential [<Pscredential>]

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.



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-SqlInstance [<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]

The target SQL Server instance or instances. This can be a collection and receive pipeline input



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS



NOTES





Tags: StoredProcedure, Proc

Author: Stephen Bennett, https://sqlnotesfromtheunderground.wordpress.com/



Website: https://dbatools.io

Copyright: (c) 2018 by dbatools, licensed under MIT

License: MIT https://opensource.org/licenses/MIT



-------------------------- EXAMPLE 1 --------------------------



PS C:\\>Find-DbaStoredProcedure -SqlInstance DEV01 -Pattern whatever



Searches all user databases stored procedures for "whatever" in the text body

-------------------------- EXAMPLE 2 --------------------------



PS C:\\>Find-DbaStoredProcedure -SqlInstance sql2016 -Pattern '\\w+@\\w+\\.\\w+'



Searches all databases for all stored procedures that contain a valid email pattern in the text body

-------------------------- EXAMPLE 3 --------------------------



PS C:\\>Find-DbaStoredProcedure -SqlInstance DEV01 -Database MyDB -Pattern 'some string' -Verbose



Searches in "mydb" database stored procedures for "some string" in the text body

-------------------------- EXAMPLE 4 --------------------------



PS C:\\>Find-DbaStoredProcedure -SqlInstance sql2016 -Database MyDB -Pattern RUNTIME -IncludeSystemObjects



Searches in "mydb" database stored procedures for "runtime" in the text body



RELATED LINKS

https://dbatools.io/Find-DbaStoredProcedure