Edit

Share via

Set-SPServerScaleOutDatabaseDataSubRange

Module:
SharePointServer module

Creates a subrange for a specified scale-out database.

Syntax

UnattachedDatabase 

Set-SPServerScaleOutDatabaseDataSubRange
    -ConnectionString <String>
    -IsUpperSubRange <Boolean>
    -Range <SPScaleOutDataRange>
    -SubRangeMode <SPScaleOutDatabaseSubRangeMode>
    [-AssignmentCollection <SPAssignmentCollection>]
    [-Confirm]
    [-IgnoreSubRangePointOnBoundary]
    [-IsAzureDatabase]
    [-SubRangePoint <Byte[]>]
    [-WhatIf]
    [<CommonParameters>]

AttachedDatabase 

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] (https://msdn.microsoft.com/library/dd878348(VS.85).aspx).

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.

Parameters

-AssignmentCollection

Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

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.

Parameter properties

Type:SPAssignmentCollection
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ConnectionString

Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UnattachedDatabase
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Database

Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

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

Parameter properties

Type:SPDatabasePipeBind
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

AttachedDatabase
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-IgnoreSubRangePointOnBoundary

Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

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.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-IsAzureDatabase

Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

Specifies whether the database is hosted on SQL Azure.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UnattachedDatabase
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-IsUpperSubRange

Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

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

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Range

Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

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

Parameter properties

Type:SPScaleOutDataRange
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SubRangeMode

Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

Parameter properties

Type:SPScaleOutDatabaseSubRangeMode
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SubRangePoint

Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

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.

Parameter properties

Type:

Byte[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Microsoft.SharePoint.PowerShell.SPDatabasePipeBind

Microsoft.SharePoint.PowerShell.SPAssignmentCollection

Outputs

System.Object