Skip to content

Invoke-DbaBalanceDataFiles - Add -TargetFileGroup parameter #10296

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
andreasjordan wants to merge 1 commit into
base: development
Choose a base branch
from
+58 −5
Open

Invoke-DbaBalanceDataFiles - Add -TargetFileGroup parameter #10296

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 57 additions & 5 deletions public/Invoke-DbaBalanceDataFiles.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@ function Invoke-DbaBalanceDataFiles {
A file group would have at least have 2 data files and should be writable.
If a table is within such a file group it will be subject for processing. If not the table will be skipped.

When the -TargetFileGroup parameter is specified, indexes can be moved from their current filegroup
to the specified target filegroup regardless of how many data files the current filegroup contains.
This allows consolidating or migrating data between filegroups.

Note: this command does not perform a disk space check for non-Windows machines so make sure you have enough space on the disk.

.PARAMETER SqlInstance
Expand All @@ -38,6 +42,12 @@ function Invoke-DbaBalanceDataFiles {
Specifies which tables to balance data for within the target databases. Only tables with clustered indexes in file groups containing multiple data files will be processed.
When omitted, all eligible tables in the database will be processed. Use this to target specific large tables that need data redistribution.

.PARAMETER TargetFileGroup
The name of the filegroup to rebuild indexes into. When specified, indexes can be moved from their current filegroup
to the target filegroup, regardless of how many data files the current filegroup contains.

When not specified, the function only processes tables in filegroups with at least 2 data files.

.PARAMETER RebuildOffline
Forces all clustered index rebuilds to occur offline, which redistributes data between files but blocks table access during the operation.
Use this switch when you need to balance data files but can accept downtime, or when working with SQL Server editions that don't support online index operations (Standard, Express, Web).
Expand Down Expand Up @@ -107,6 +117,16 @@ function Invoke-DbaBalanceDataFiles {
This command will consider the fact that there might be a SQL Server edition that does not support online rebuilds of indexes.
By supplying this parameter you give permission to do the rebuilds offline if the edition does not support it.

.EXAMPLE
PS C:\> Invoke-DbaBalanceDataFiles -SqlInstance sql1 -Database db1 -TargetFileGroup "SECONDARY"

This command will rebuild all clustered indexes into the SECONDARY filegroup, moving data from whatever filegroup each table currently resides in.

.EXAMPLE
PS C:\> Invoke-DbaBalanceDataFiles -SqlInstance sql1 -Database db1 -Table table1,table2 -TargetFileGroup "SECONDARY" -RebuildOffline

This command will rebuild the clustered indexes of table1 and table2 offline, moving them into the SECONDARY filegroup.

#>
[CmdletBinding(DefaultParameterSetName = "Default", SupportsShouldProcess, ConfirmImpact = "Medium")]
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseSingularNouns", "", Justification = "Singular Noun doesn't make sense")]
Expand All @@ -117,6 +137,7 @@ function Invoke-DbaBalanceDataFiles {
[object[]]$Database,
[Alias("Tables")]
[object[]]$Table,
[string]$TargetFileGroup,
[switch]$RebuildOffline,
[switch]$EnableException,
[switch]$Force
Expand Down Expand Up @@ -264,13 +285,30 @@ function Invoke-DbaBalanceDataFiles {
# ARray to hold the file groups with properties
$balanceableTables = @()

# Loop through each of the file groups
if ($TargetFileGroup) {
# Validate the target filegroup exists and is writable
$targetFG = $fileGroups[$TargetFileGroup]
if (-not $targetFG) {
Stop-Function -Message "FileGroup '$TargetFileGroup' does not exist in database $db on instance $instance" -Target $instance -Continue
continue
}
if ($targetFG.Readonly) {
Stop-Function -Message "FileGroup '$TargetFileGroup' is read-only in database $db on instance $instance" -Target $instance -Continue
continue
}

foreach ($fg in $fileGroups) {
# When a target filegroup is specified, all tables are eligible
Write-Message -Message "Target filegroup '$TargetFileGroup' specified - all tables with clustered indexes are eligible" -Level Verbose
$balanceableTables = $db.Tables
} else {
# Loop through each of the file groups

# If there is less than 2 files balancing out data is not possible
if (($fg.Files.Count -ge 2) -and ($fg.Readonly -eq $false)) {
$balanceableTables += $fg.EnumObjects() | Where-Object { $_.GetType().Name -eq 'Table' }
foreach ($fg in $fileGroups) {

# If there is less than 2 files balancing out data is not possible
if (($fg.Files.Count -ge 2) -and ($fg.Readonly -eq $false)) {
$balanceableTables += $fg.EnumObjects() | Where-Object { $_.GetType().Name -eq 'Table' }
}
}
}

Expand Down Expand Up @@ -313,6 +351,9 @@ function Invoke-DbaBalanceDataFiles {
# Get the original index operation
[bool]$originalIndexOperation = $ci.OnlineIndexOperation

# Save the original filegroup in case of error
$originalFileGroup = $ci.FileGroup

# Set the rebuild option to be either offline or online
if ($RebuildOffline) {
$ci.OnlineIndexOperation = $false
Expand All @@ -321,6 +362,12 @@ function Invoke-DbaBalanceDataFiles {
$ci.OnlineIndexOperation = $true
}

# Set the target filegroup if specified
if ($TargetFileGroup) {
Write-Message -Message "Setting filegroup for index $($ci.Name) to $TargetFileGroup" -Level Verbose
$ci.FileGroup = $TargetFileGroup
}

# Rebuild the index
try {
Write-Message -Message "Rebuilding index $($ci.Name)" -Level Verbose
Expand All @@ -332,6 +379,11 @@ function Invoke-DbaBalanceDataFiles {
# Set the original index operation back for the index
$ci.OnlineIndexOperation = $originalIndexOperation

# Restore the original filegroup if we changed it
if ($TargetFileGroup) {
$ci.FileGroup = $originalFileGroup
}

# Set the success flag
$success = $false

Expand Down
1 change: 1 addition & 0 deletions tests/Invoke-DbaBalanceDataFiles.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Describe $CommandName -Tag UnitTests {
"SqlCredential",
"Database",
"Table",
"TargetFileGroup",
"RebuildOffline",
"Force",
"EnableException"
Expand Down
Loading