Skip to content

Latest commit

 

History

History
170 lines (120 loc) · 4.41 KB

File metadata and controls

170 lines (120 loc) · 4.41 KB
external help file Microsoft.Office.Server.dll-help.xml
Module Name SharePointServer
online version https://learn.microsoft.com/powershell/module/microsoft.sharepoint.powershell/remove-spserverscaleoutdatabase
applicable SharePoint Server Subscription Edition
title Remove-SPServerScaleOutDatabase
schema 2.0.0

Remove-SPServerScaleOutDatabase

SYNOPSIS

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

-Database

Applicable: SharePoint Server Subscription Edition

Specifies the scale-out database to remove.

Type: SPDatabasePipeBind
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-ServiceApplication

Applicable: SharePoint Server Subscription Edition

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

Type: SPServiceApplicationPipeBind
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-AssignmentCollection

Applicable: SharePoint Server Subscription Edition

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
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Confirm

Applicable: SharePoint Server Subscription Edition

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-DeleteData

Applicable: SharePoint Server Subscription Edition

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

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Applicable: SharePoint Server Subscription Edition

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

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

Microsoft.SharePoint.PowerShell.SPDatabasePipeBind

Microsoft.SharePoint.PowerShell.SPAssignmentCollection

OUTPUTS

System.Object

NOTES

RELATED LINKS

Add-SPServerScaleOutDatabase

Get-SPServerScaleOutDatabase

Split-SPServerScaleOutDatabase