Set-SPServerScaleOutDatabaseDataSubRange

Creates a subrange for a specified scale-out database.

Syntax

Set-SPServerScaleOutDatabaseDataSubRange
   -ConnectionString <String>
   -IsUpperSubRange <Boolean>
   -Range <SPScaleOutDataRange>
   -SubRangeMode <SPScaleOutDatabaseSubRangeMode>
   [-AssignmentCollection <SPAssignmentCollection>]
   [-Confirm]
   [-IgnoreSubRangePointOnBoundary]
   [-IsAzureDatabase]
   [-SubRangePoint <Byte[]>]
   [-WhatIf]
   [<CommonParameters>]
Set-SPServerScaleOutDatabaseDataSubRange
   -Database <SPDatabasePipeBind>
   -IsUpperSubRange <Boolean>
   -Range <SPScaleOutDataRange>
   -SubRangeMode <SPScaleOutDatabaseSubRangeMode>
   [-AssignmentCollection <SPAssignmentCollection>]
   [-Confirm]
   [-IgnoreSubRangePointOnBoundary]
   [-SubRangePoint <Byte[]>]
   [-WhatIf]
   [<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.

Examples

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

$databases = Get-SPServerScaleOutDatabase -ServiceApplication $serviceApplication
$database = $databases[0]
$state = Get-SPServerScaleOutDatabaseDataState -Database $database
Set-SPServerScaleOutDatabaseDataSubRange -Database $database -Range $state.Range -SubRangePoint $state.Range.RangeEnd -SubRangeMode ReadOnly -IsUpperSubRange $false

This example creates a read-only subrange that starts from the data range start point and ends at the data range end point on the first scale-out database of the specified service application.

Required Parameters

-ConnectionString

Specifies the connection string for the scale-out database to create the new data sub-range.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016
-Database

Specifies the scale-out database to create the data subrange.

Type:SPDatabasePipeBind
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016
-IsUpperSubRange

Specifies whether to create the data subrange on the upper or lower side of the data range.

Type:Boolean
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016
-Range

Specifies the expected current range of the scale-out database prior to this operation.

Type:SPScaleOutDataRange
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016
-SubRangeMode
Type:SPScaleOutDatabaseSubRangeMode
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016

Optional 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.

Note: 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
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016
-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016
-IgnoreSubRangePointOnBoundary

Specifies whether to complete without any errors if the new subrange’s start and end points are the same. If this parameter is specified, no errors are displayed.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016
-IsAzureDatabase

Specifies whether the database is hosted on SQL Azure.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016
-SubRangePoint

Specifies the start or end point of the data subrange to be created as defined by the following criteria:

--The start point if the data sub-range is created on the upper side of the data range. --The end point if the data sub-range is created on the lower side of the data range.

The maximum value is NULL.

Type:Byte[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016
-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016

Inputs

Microsoft.SharePoint.PowerShell.SPDatabasePipeBind

Microsoft.SharePoint.PowerShell.SPAssignmentCollection

Outputs

System.Object