Get-SPScaleOutDatabase
Published: July 16, 2012
Applies to: SharePoint Foundation 2013 | SharePoint Server 2013 Enterprise
Returns all scale-out database objects.
Get-SPScaleOutDatabase -ServiceApplication <SPServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]]
Parameters
| Parameter | Required | Type | Description | ||
|---|---|---|---|---|---|
| ServiceApplication | Required | Microsoft.SharePoint.PowerShell.SPServiceApplicationPipeBind | Specifies the service application of the scale-out databases. | ||
| AssignmentCollection | Optional | Microsoft.SharePoint.PowerShell.SPAssignmentCollection | 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.
| ||
| Confirm | Optional | System.Management.Automation.SwitchParameter | Prompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparameters | ||
| WhatIf | Optional | System.Management.Automation.SwitchParameter | Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparameters |
Detailed Description
Use the Get-SPScaleOutDatabase cmdlet to returns all scale-out database objects for the specified service application.
A scale-out database is a database which implements the Shared Service Database Scale Out Generic Protocol. For additional information about the Database Scale Out Generic Protocol, see SharePoint Shared Service Database Scale Out Generic Protocol Specification
Input Types
Return Types
----------EXAMPLE--------------
$serviceApplication = Get-SPServiceApplication –Name "AppManagement"
Get-SPScaleOutDatabase -ServiceApplication $serviceApplication
This example gets all scale-out databases for the given service application by using the $serviceApplication variable.
Change History
| Date | Description |
|---|---|
| July 16, 2012 | Initial publication |

Note: