commands

^

Set-DbaDbFileGroup

Author Adam Lancaster https://github.com/lancasteradam
Availability Windows, Linux, macOS

 

Synopsis

Sets the options for a filegroup.

Description

Sets the options for a filegroup for the specified database(s).

Syntax

Set-DbaDbFileGroup
    [[-SqlInstance] <DbaInstanceParameter[]>]
    [[-SqlCredential] <PSCredential>]
    [[-Database] <String[]>]
    [[-FileGroup] <String[]>]
    [-Default]
    [-ReadOnly]
    [-AutoGrowAllFiles]
    [[-InputObject] <Object[]>]
    [-EnableException]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

 

Examples

 

Example: 1
PS C:\> Set-DbaDbFileGroup -SqlInstance sqldev1 -Database TestDb -FileGroup HRFG1 -Default -AutoGrowAllFiles

Sets the HRFG1 filegroup to auto grow all files and makes it the default filegroup on the TestDb database on the sqldev1 instance.

Example: 2
PS C:\> Set-DbaDbFileGroup -SqlInstance sqldev1 -Database TestDb -FileGroup HRFG1 -AutoGrowAllFiles:$false

Sets the HRFG1 filegroup to not auto grow all files on the TestDb database on the sqldev1 instance.

Example: 3
PS C:\> Set-DbaDbFileGroup -SqlInstance sqldev1 -Database TestDb -FileGroup HRFG1 -ReadOnly

Sets the HRFG1 filegroup to read only on the TestDb database on the sqldev1 instance.

Example: 4
PS C:\> Set-DbaDbFileGroup -SqlInstance sqldev1 -Database TestDb -FileGroup HRFG1 -ReadOnly:$false

Sets the HRFG1 filegroup to read/write on the TestDb database on the sqldev1 instance.

Example: 5
PS C:\> Get-DbaDatabase -SqlInstance sqldev1 -Database TestDb | Set-DbaDbFileGroup -FileGroup HRFG1 -AutoGrowAllFiles

Passes in the TestDB database from the sqldev1 instance and sets the HRFG1 filegroup to auto grow all files.

Example: 6
PS C:\> Get-DbaDbFileGroup -SqlInstance sqldev1 -Database TestDb -FileGroup HRFG1 | Set-DbaDbFileGroup -AutoGrowAllFiles

Passes in the HRFG1 filegroup from the TestDB database on the sqldev1 instance and sets it to auto grow all files.

Optional Parameters

-SqlInstance

The target SQL Server instance or instances. This can be a collection and receive pipeline input to allow the function to be executed against multiple SQL Server instances.

Alias
Required False
Pipeline false
Default Value
-SqlCredential

Login to the target instance using alternative credentials. Accepts PowerShell credentials (Get-Credential). Windows Authentication, SQL Server Authentication, Active Directory - Password, and Active Directory - Integrated are all supported. For MFA support, please use Connect-DbaInstance.

Alias
Required False
Pipeline false
Default Value
-Database

The target database(s).

Alias
Required False
Pipeline false
Default Value
-FileGroup

The name(s) of the filegroup(s).

Alias
Required False
Pipeline false
Default Value
-Default

Specifies if the filegroup should be the default. Only one filegroup in a database can be specified as the default.

Alias
Required False
Pipeline false
Default Value False
-ReadOnly

Specifies the filegroup should be readonly. To change the filegroup to readwrite use -ReadOnly:$false

Alias
Required False
Pipeline false
Default Value False
-AutoGrowAllFiles

Specifies the filegroup should auto grow all files if one file has met the threshold to auto grow. To revert this setting use -AutoGrowAllFiles:$false

Alias
Required False
Pipeline false
Default Value False
-InputObject

Allows piping from Get-DbaDatabase and Get-DbaDbFileGroup.

Alias
Required False
Pipeline true (ByValue)
Default Value
-EnableException

By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message. This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting. Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.

Alias
Required False
Pipeline false
Default Value False
-WhatIf

Shows what would happen if the command were to run. No actions are actually performed.

Alias wi
Required False
Pipeline false
Default Value
-Confirm

Prompts you for confirmation before executing any changing operations within the command.

Alias cf
Required False
Pipeline false
Default Value

 

Want to see the source code for this command? Check out Set-DbaDbFileGroup on GitHub.
Want to see the Bill Of Health for this command? Check out Set-DbaDbFileGroup.