Disable‑SqlDscDatabaseSnapshotIsolation - dsccommunity/SqlServerDsc GitHub Wiki

SYNOPSIS

Disables snapshot isolation for a database in a SQL Server Database Engine instance.

SYNTAX

ServerObjectSet (Default)

Disable-SqlDscDatabaseSnapshotIsolation -ServerObject <Server> -Name <String> [-Refresh] [-Force] [-PassThru]
 [-WhatIf] [-Confirm] [<CommonParameters>]

DatabaseObjectSet

Disable-SqlDscDatabaseSnapshotIsolation -DatabaseObject <Database> [-Force] [-PassThru]
 [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

This command disables snapshot isolation for a database in a SQL Server Database Engine instance. Disabling snapshot isolation removes row-versioning and snapshot isolation settings for the database.

The command uses the SetSnapshotIsolation() method on the SMO Database object to disable row-versioning and snapshot isolation settings.

EXAMPLES

EXAMPLE 1

$serverObject = Connect-SqlDscDatabaseEngine -InstanceName 'MyInstance'
Disable-SqlDscDatabaseSnapshotIsolation -ServerObject $serverObject -Name 'MyDatabase'

Disables snapshot isolation for the database named MyDatabase.

EXAMPLE 2

$serverObject = Connect-SqlDscDatabaseEngine -InstanceName 'MyInstance'
$databaseObject = $serverObject | Get-SqlDscDatabase -Name 'MyDatabase'
Disable-SqlDscDatabaseSnapshotIsolation -DatabaseObject $databaseObject -Force

Disables snapshot isolation for the database using a database object without prompting for confirmation.

EXAMPLE 3

$serverObject = Connect-SqlDscDatabaseEngine -InstanceName 'MyInstance'
Disable-SqlDscDatabaseSnapshotIsolation -ServerObject $serverObject -Name 'MyDatabase' -PassThru

Disables snapshot isolation and returns the updated database object.

PARAMETERS

-DatabaseObject

Specifies the database object to modify (from Get-SqlDscDatabase).

Type: Database
Parameter Sets: DatabaseObjectSet
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Force

Specifies that snapshot isolation should be disabled without any confirmation.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Name

Specifies the name of the database to modify.

Type: String
Parameter Sets: ServerObjectSet
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PassThru

Specifies that the database object should be returned after modification.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Refresh

Specifies that the ServerObject's databases should be refreshed before trying to get the database object. This is helpful when databases could have been modified outside of the ServerObject, for example through T-SQL. But on instances with a large amount of databases it might be better to make sure the ServerObject is recent enough.

This parameter is only used when setting snapshot isolation using ServerObject and Name parameters.

Type: SwitchParameter
Parameter Sets: ServerObjectSet
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-ServerObject

Specifies current server connection object.

Type: Server
Parameter Sets: ServerObjectSet
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

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

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

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

INPUTS

Microsoft.SqlServer.Management.Smo.Database

The database object to modify (from Get-SqlDscDatabase).

OUTPUTS

None.

By default, no output is returned.

Microsoft.SqlServer.Management.Smo.Database

When PassThru is specified, the updated database object is returned.

NOTES

RELATED LINKS

⚠️ **GitHub.com Fallback** ⚠️