Get-SPDatabase

Reference

Module:: sharepoint-server

Applies to:: SharePoint Server Subscription Edition

Retrieves all properties of a database.

Syntax

Get-SPDatabase
   [[-Identity] <SPDatabasePipeBind>]
   [-AssignmentCollection <SPAssignmentCollection>]
   [<CommonParameters>]

Get-SPDatabase
   -ServerInstance <SPDatabaseServiceInstancePipeBind>
   [-AssignmentCollection <SPAssignmentCollection>]
   [<CommonParameters>]

Get-SPDatabase
   [-AssignmentCollection <SPAssignmentCollection>]
   -Name <String>
   [<CommonParameters>]

Description

This cmdlet contains more than one parameter set. You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. For more information about how to use parameter sets, see Cmdlet parameter sets.

The Get-SPDatabase cmdlet displays all public properties of a database to the current window. If the Identity parameter is specified, only properties of that ID are displayed.

For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at SharePoint Server Cmdlets.

Examples

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

Get-SPDatabase | ?{$_.TypeName -eq 'Microsoft.Office.Server.Administration.ProfileDatabase'}

This example gets the Profile database used by the User Profile Service Application.

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

Get-SPDatabase -Name 'Profile DB'

This example gets the Profile database by name. Applies to SharePoint Server 2016, SharePoint Server 2019 only.

Parameters

-AssignmentCollection

Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.

When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.

Type:	SPAssignmentCollection
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-Identity

Specifies the name of the database to display public properties.

The type must be a valid GUID, in the form 1234-3456-567kg.

Type:	SPDatabasePipeBind
Position:	1
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-Name

Specifies the name of the database.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-ServerInstance

Specifies the name of the SQL instance that contains the database in either the form "Server" for a default SQL instance or "Server\Instance" for a named SQL instance.

Type:	SPDatabaseServiceInstancePipeBind
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

Share via