Edit

Remove-SPServerScaleOutDatabase

  • Reference
Module:
sharepoint-server
Applies to:
SharePoint Server Subscription Edition

Removes a specific scale-out database.

Syntax

Remove-SPServerScaleOutDatabase
      -Database <SPDatabasePipeBind>
      -ServiceApplication <SPServiceApplicationPipeBind>
      [-AssignmentCollection <SPAssignmentCollection>]
      [-Confirm]
      [-DeleteData]
      [-WhatIf]
      [<CommonParameters>]

Description

Use the Remove-SPServerScaleOutDatabase cmdlet to remove a specific scale-out database from a specified service application.

Examples

-----------------------EXAMPLE-----------------------------

$sa = Get-SPServiceApplication | ?{$_.TypeName -eq 'Managed Metadata Service'}
$database = Get-SPServerScaleOutDatabase -ServiceApplication $sa
Remove-SPServerScaleOutDatabase -Database $database -ServiceApplication $sa

This example removes the specified scale-out database from the Managed Metadata Service application.

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

-Confirm

Prompts you for confirmation before running the cmdlet.

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

-Database

Specifies the scale-out database to remove.

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

-DeleteData

Specifies whether to delete data when the scale out database is removed.

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

-ServiceApplication

Specifies the service application of the scale-out database to remove.

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

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

Inputs

Microsoft.SharePoint.PowerShell.SPDatabasePipeBind

Microsoft.SharePoint.PowerShell.SPAssignmentCollection

Outputs

System.Object