commands

^

Get-DbaDbSharePoint

Author Chrissy LeMaire (@cl), netnerds.net
Availability Windows, Linux, macOS

 

Synopsis

Returns databases that are part of a SharePoint Farm.

Description

Returns databases that are part of a SharePoint Farm, as found in the SharePoint Configuration database.

By default, this command checks SharePoint_Config. To use an alternate database, use the ConfigDatabase parameter.

Syntax

Get-DbaDbSharePoint
    [[-SqlInstance] <DbaInstanceParameter[]>]
    [[-SqlCredential] <PSCredential>]
    [[-ConfigDatabase] <String[]>]
    [[-InputObject] <Database[]>]
    [-EnableException]
    [<CommonParameters>]

 

Examples

 

Example: 1
PS C:\> Get-DbaDbSharePoint -SqlInstance sqlcluster

Returns databases that are part of a SharePoint Farm, as found in SharePoint_Config on sqlcluster

Example: 2
PS C:\> Get-DbaDatabase -SqlInstance sqlcluster -Database SharePoint_Config_2016 | Get-DbaDbSharePoint

Returns databases that are part of a SharePoint Farm, as found in SharePoint_Config_2016 on sqlcluster

Optional Parameters

-SqlInstance

The target SQL Server instance

Alias
Required False
Pipeline false
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
-ConfigDatabase

The name of the SharePoint Configuration database. Defaults to SharePoint_Config.

Alias
Required False
Pipeline false
Default Value SharePoint_Config
-InputObject

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