Set-SPScaleOutDatabaseDataSubRange
Creates a subrange for a specified scale-out database.
Syntax
UnattachedDatabase
Set-SPScaleOutDatabaseDataSubRange
-ConnectionString <String>
-IsUpperSubRange <Boolean>
-Range <SPScaleOutDataRange>
-SubRangeMode <SPScaleOutDatabaseSubRangeMode>
[-AssignmentCollection <SPAssignmentCollection>]
[-Confirm]
[-IgnoreSubRangePointOnBoundary]
[-IsAzureDatabase]
[-SubRangePoint <Byte[]>]
[-WhatIf]
[<CommonParameters>]
AttachedDatabase
Set-SPScaleOutDatabaseDataSubRange
-Database <SPDatabasePipeBind>
-IsUpperSubRange <Boolean>
-Range <SPScaleOutDataRange>
-SubRangeMode <SPScaleOutDatabaseSubRangeMode>
[-AssignmentCollection <SPAssignmentCollection>]
[-Confirm]
[-IgnoreSubRangePointOnBoundary]
[-SubRangePoint <Byte[]>]
[-WhatIf]
[<CommonParameters>]
Description
Use the Set-SPScaleOutDatabaseDataSubRange cmdlet to create a subrange with the specified parameters for a specified scale-out database or a database which will be connected with a specified connection string.
A subrange is a subset of a range of data.
For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at SharePoint Server Cmdlets.
Examples
EXAMPLE
C:\PS>$databases = Get-SPScaleOutDatabase -ServiceApplication $serviceApplication
C:\PS>$database = $databases[0]
C:\PS>$state = Get-SPScaleOutDatabaseDataState -Database $database
Set-SPScaleOutDatabaseDataSubRange -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.
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 executing the command.
For more information, type the following command: get-help about_commonparameters
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
Specifies the mode of the data subrange to be created. The data subrange mode values are the following:
--NULL- The data subrange on the specified side (lower or upper) of the data range will be removed. --ReadOnly - The partitions which are inside the new data subrange can be read, but cannot be modified. --Changing -The partitions which are inside the new data subrange cannot be read or modified --Deleted- The partitions which are inside the new data subrange cannot be read or modified
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
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
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.