.png)
Set-SPScaleOutDatabaseDataSubRange
Published: July 16, 2012
Applies to: SharePoint Foundation 2013 | SharePoint Server 2013 Enterprise
Creates a subrange for a specified scale-out database.
Set-SPScaleOutDatabaseDataSubRange -Database <SPDatabasePipeBind> -IsUpperSubRange <$true | $false> -Range <SPScaleOutDataRange> -SubRangeMode <ReadWrite | ReadOnly | Changing | Deleted> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-IgnoreSubRangePointOnBoundary <SwitchParameter>] [-SubRangePoint <Byte[]>] [-WhatIf [<SwitchParameter>]]
Set-SPScaleOutDatabaseDataSubRange -ConnectionString <String> -IsUpperSubRange <$true | $false> -Range <SPScaleOutDataRange> -SubRangeMode <ReadWrite | ReadOnly | Changing | Deleted> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-IgnoreSubRangePointOnBoundary <SwitchParameter>] [-IsAzureDatabase <SwitchParameter>] [-SubRangePoint <Byte[]>] [-WhatIf [<SwitchParameter>]]
Parameters
1| Parameter | Required | Type | Description | ||
| Database | Required | Microsoft.SharePoint.PowerShell.SPDatabasePipeBind | Specifies the scale-out database to create the data subrange. | ||
| IsUpperSubRange | Required | System.Boolean | Specifies whether to create the data subrange on the upper or lower side of the data range. | ||
| Range | Required | Microsoft.SharePoint.SPScaleOutDataRange | Specifies the expected current range of the scale-out database prior to this operation. | ||
| SubRangeMode | Required | Microsoft.SharePoint.SPScaleOutDatabaseSubRangeMode | 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 | ||
| AssignmentCollection | Optional | Microsoft.SharePoint.PowerShell.SPAssignmentCollection | 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.
| ||
| Confirm | Optional | System.Management.Automation.SwitchParameter | Prompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparameters | ||
| IgnoreSubRangePointOnBoundary | Optional | System.Management.Automation.SwitchParameter | 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. | ||
| SubRangePoint | Optional | System.Byte[] | 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. | ||
| WhatIf | Optional | System.Management.Automation.SwitchParameter | 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 |
Note: | Parameter | Required | Type | Description | ||
| ConnectionString | Required | System.String | Specifies the connection string for the scale-out database to create the new data sub-range. | ||
| IsUpperSubRange | Required | System.Boolean | Specifies whether to create the data subrange on the upper or lower side of the data range. | ||
| Range | Required | Microsoft.SharePoint.SPScaleOutDataRange | Specifies the expected current range of the scale-out database prior to this operation. | ||
| SubRangeMode | Required | Microsoft.SharePoint.SPScaleOutDatabaseSubRangeMode | 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 | ||
| AssignmentCollection | Optional | Microsoft.SharePoint.PowerShell.SPAssignmentCollection | 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.
| ||
| Confirm | Optional | System.Management.Automation.SwitchParameter | Prompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparameters | ||
| IgnoreSubRangePointOnBoundary | Optional | System.Management.Automation.SwitchParameter | 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. | ||
| IsAzureDatabase | Optional | System.Management.Automation.SwitchParameter | Specifies whether the database is hosted on SQL Azure. | ||
| SubRangePoint | Optional | System.Byte[] | 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. | ||
| WhatIf | Optional | System.Management.Automation.SwitchParameter | 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 |
Detailed 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.
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.
Input Types
Return Types
--------------EXAMPLE-------------
$databases = Get-SPScaleOutDatabase -ServiceApplication $serviceApplication
$database = $databases[0]
$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.
Change History
| Date | Description |
|---|---|
| July 16, 2012 | Initial publication |
