Set-SqlDscDatabaseProperty: Refactor command

CHANGELOG.md

@@ -10,9 +10,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - BREAKING CHANGE: Removed public command `Test-SqlDscDatabase`. Use
   `Test-SqlDscIsDatabase` to check existence. For property checks, use
   `Test-SqlDscDatabaseProperty`. See [issue #2201](https://github.com/dsccommunity/SqlServerDsc/issues/2201).
+- BREAKING CHANGE: `Set-SqlDscDatabase`
+  - Removed parameter `OwnerName`. Use the new command `Set-SqlDscDatabaseOwner`
+    to change database ownership instead.
 
 ### Added
 
+- Added public command `Set-SqlDscDatabaseOwner` to change the owner of a SQL Server
+  database. This command uses the SMO `SetOwner()` method and supports both
+  `ServerObject` and `DatabaseObject` parameter sets. It replaces the `OwnerName`
+  parameter that was removed from `Set-SqlDscDatabase`.
 - Added public command `Test-SqlDscIsDatabase` to test if a database exists on a
   SQL Server Database Engine instance ([issue #2201](https://github.com/dsccommunity/SqlServerDsc/issues/2201)).
 - Added public command `Get-SqlDscSetupLog` to retrieve SQL Server setup bootstrap
@@ -220,6 +227,26 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
+- `Set-SqlDscDatabase`
+  - BREAKING CHANGE: Completely refactored to support all 85+ settable SMO Database
+    properties as parameters. The command now uses a generic property-setting loop
+    instead of hard-coded property handling. This allows setting any writable
+    property of the `Microsoft.SqlServer.Management.Smo.Database` class, including:
+    - 46 Boolean properties (e.g., `AnsiNullDefault`, `AutoClose`, `AutoShrink`,
+      `IsSystemObject`, `RecursiveTriggersEnabled`)
+    - 8 Int32 properties (e.g., `AutoCreateStatisticsIncremental`, `DataSpaceUsage`,
+      `IndexSpaceUsage`, `TargetRecoveryTime`)
+    - 1 Int64 property (`MaxSizeInBytes`)
+    - 19 String properties (e.g., `Collation`, `DefaultFileGroup`, `DefaultSchema`,
+      `PrimaryFilePath`)
+    - 11 Enum properties (e.g., `CompatibilityLevel`, `PageVerify`, `RecoveryModel`,
+      `UserAccess`)
+  - Removed all property-specific validation logic - SMO now handles validation
+  - Removed individual property update messages - now uses generic
+    `Database_UpdatingProperty` message
+  - Added check to skip updating properties that are already set to the desired value
+  - Properties are only modified if they differ from the current value, reducing
+    unnecessary database operations
 - `Remove-SqlDscAgentAlert`
   - Now uses `$PSCmdlet.ThrowTerminatingError()` instead of exception helper
     functions for proper terminating error handling ([issue #2193](https://github.com/dsccommunity/SqlServerDsc/issues/2193)).

source/Public/Set-SqlDscDatabaseOwner.ps1

@@ -0,0 +1,151 @@
+<#
+    .SYNOPSIS
+        Sets the owner of a database in a SQL Server Database Engine instance.
+
+    .DESCRIPTION
+        This command sets the owner of a database in a SQL Server Database Engine instance.
+
+        The owner must be a valid login on the SQL Server instance. The command uses
+        the SetOwner() method on the SMO Database object to change the ownership.
+
+    .PARAMETER ServerObject
+        Specifies current server connection object.
+
+    .PARAMETER Name
+        Specifies the name of the database to modify.
+
+    .PARAMETER DatabaseObject
+        Specifies the database object to modify (from Get-SqlDscDatabase).
+
+    .PARAMETER 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 owner using **ServerObject** and
+        **Name** parameters.
+
+    .PARAMETER OwnerName
+        Specifies the name of the login that should be the owner of the database.
+
+    .PARAMETER Force
+        Specifies that the database owner should be modified without any confirmation.
+
+    .PARAMETER PassThru
+        Specifies that the database object should be returned after modification.
+
+    .EXAMPLE
+        $serverObject = Connect-SqlDscDatabaseEngine -InstanceName 'MyInstance'
+        Set-SqlDscDatabaseOwner -ServerObject $serverObject -Name 'MyDatabase' -OwnerName 'sa'
+
+        Sets the owner of the database named **MyDatabase** to **sa**.
+
+    .EXAMPLE
+        $serverObject = Connect-SqlDscDatabaseEngine -InstanceName 'MyInstance'
+        $databaseObject = $serverObject | Get-SqlDscDatabase -Name 'MyDatabase'
+        Set-SqlDscDatabaseOwner -DatabaseObject $databaseObject -OwnerName 'DOMAIN\SqlAdmin' -Force
+
+        Sets the owner of the database using a database object without prompting for confirmation.
+
+    .EXAMPLE
+        $serverObject = Connect-SqlDscDatabaseEngine -InstanceName 'MyInstance'
+        Set-SqlDscDatabaseOwner -ServerObject $serverObject -Name 'MyDatabase' -OwnerName 'sa' -PassThru
+
+        Sets the owner and returns the updated database object.
+
+    .INPUTS
+        `[Microsoft.SqlServer.Management.Smo.Database]`
+
+        The database object to modify (from Get-SqlDscDatabase).
+
+    .OUTPUTS
+        None. But when **PassThru** is specified the output is `[Microsoft.SqlServer.Management.Smo.Database]`.
+#>
+function Set-SqlDscDatabaseOwner
+{
+    [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('UseSyntacticallyCorrectExamples', '', Justification = 'Because the rule does not yet support parsing the code when a parameter type is not available. The ScriptAnalyzer rule UseSyntacticallyCorrectExamples will always error in the editor due to https://github.com/indented-automation/Indented.ScriptAnalyzerRules/issues.')]
+    [OutputType()]
+    [OutputType([Microsoft.SqlServer.Management.Smo.Database])]
+    [CmdletBinding(DefaultParameterSetName = 'ServerObjectSet', SupportsShouldProcess = $true, ConfirmImpact = 'Medium')]
+    param
+    (
+        [Parameter(ParameterSetName = 'ServerObjectSet', Mandatory = $true)]
+        [Microsoft.SqlServer.Management.Smo.Server]
+        $ServerObject,
+
+        [Parameter(ParameterSetName = 'ServerObjectSet', Mandatory = $true)]
+        [ValidateNotNullOrEmpty()]
+        [System.String]
+        $Name,
+
+        [Parameter(ParameterSetName = 'ServerObjectSet')]
+        [System.Management.Automation.SwitchParameter]
+        $Refresh,
+
+        [Parameter(ParameterSetName = 'DatabaseObjectSet', Mandatory = $true, ValueFromPipeline = $true)]
+        [Microsoft.SqlServer.Management.Smo.Database]
+        $DatabaseObject,
+
+        [Parameter(Mandatory = $true)]
+        [ValidateNotNullOrEmpty()]
+        [System.String]
+        $OwnerName,
+
+        [Parameter()]
+        [System.Management.Automation.SwitchParameter]
+        $Force,
+
+        [Parameter()]
+        [System.Management.Automation.SwitchParameter]
+        $PassThru
+    )
+
+    begin
+    {
+        if ($Force.IsPresent -and -not $Confirm)
+        {
+            $ConfirmPreference = 'None'
+        }
+    }
+
+    process
+    {
+        # Get the database object based on the parameter set
+        switch ($PSCmdlet.ParameterSetName)
+        {
+            'ServerObjectSet'
+            {
+                $previousErrorActionPreference = $ErrorActionPreference
+                $ErrorActionPreference = 'Stop'
+
+                $sqlDatabaseObject = $ServerObject |
+                    Get-SqlDscDatabase -Name $Name -Refresh:$Refresh -ErrorAction 'Stop'
+
+                $ErrorActionPreference = $previousErrorActionPreference
+            }
+
+            'DatabaseObjectSet'
+            {
+                $sqlDatabaseObject = $DatabaseObject
+            }
+        }
+
+        $verboseDescriptionMessage = $script:localizedData.DatabaseOwner_Set_ShouldProcessVerboseDescription -f $sqlDatabaseObject.Name, $OwnerName, $sqlDatabaseObject.Parent.InstanceName
+        $verboseWarningMessage = $script:localizedData.DatabaseOwner_Set_ShouldProcessVerboseWarning -f $sqlDatabaseObject.Name, $OwnerName
+        $captionMessage = $script:localizedData.DatabaseOwner_Set_ShouldProcessCaption
+
+        if ($PSCmdlet.ShouldProcess($verboseDescriptionMessage, $verboseWarningMessage, $captionMessage))
+        {
+            Write-Debug -Message ($script:localizedData.DatabaseOwner_Updating -f $sqlDatabaseObject.Name, $OwnerName)
+            $sqlDatabaseObject.SetOwner($OwnerName)
+            Write-Debug -Message ($script:localizedData.DatabaseOwner_Updated -f $sqlDatabaseObject.Name, $OwnerName)
+
+            if ($PassThru.IsPresent)
+            {
+                return $sqlDatabaseObject
+            }
+        }
+    }
+}

source/en-US/SqlServerDsc.strings.psd1

@@ -367,14 +367,23 @@ ConvertFrom-StringData @'
     Database_Updating = Updating database '{0}'.
     Database_Updated = Database '{0}' was updated successfully.
     Database_SetFailed = Failed to set properties of database '{0}' on instance '{1}'.
-    Database_UpdatingCollation = Changing the database collation to '{0}'.
-    Database_UpdatingCompatibilityLevel = Changing the database compatibility level to '{0}'.
-    Database_UpdatingRecoveryModel = Changing the database recovery model to '{0}'.
-    Database_UpdatingOwner = Changing the database owner to '{0}'.
+    Database_UpdatingProperty = Setting property '{0}' to '{1}'.
+    Database_PropertyAlreadySet = Property '{0}' is already set to '{1}'.
+    Database_NoPropertiesChanged = No properties were changed for database '{0}'.
     Database_Set_ShouldProcessVerboseDescription = Setting properties of the database '{0}' on the instance '{1}'.
     Database_Set_ShouldProcessVerboseWarning = Are you sure you want to modify the database '{0}'?
     # This string shall not end with full stop (.) since it is used as a title of ShouldProcess messages.
     Database_Set_ShouldProcessCaption = Set database properties on instance
+    Set_SqlDscDatabase_InvalidCompatibilityLevel = The specified compatibility level '{0}' is not a valid compatibility level for the instance '{1}'.
+    Set_SqlDscDatabase_InvalidCollation = The specified collation '{0}' is not a valid collation for the instance '{1}'.
+
+    ## Set-SqlDscDatabaseOwner
+    DatabaseOwner_Updating = Setting owner of database '{0}' to '{1}'.
+    DatabaseOwner_Updated = Owner of database '{0}' was set to '{1}'.
+    DatabaseOwner_Set_ShouldProcessVerboseDescription = Setting the owner of the database '{0}' to '{1}' on the instance '{2}'.
+    DatabaseOwner_Set_ShouldProcessVerboseWarning = Are you sure you want to change the owner of the database '{0}' to '{1}'?
+    # This string shall not end with full stop (.) since it is used as a title of ShouldProcess messages.
+    DatabaseOwner_Set_ShouldProcessCaption = Set database owner on instance
 
     ## Remove-SqlDscDatabase
     Database_RemoveFailed = Failed to remove database '{0}' from instance '{1}'.

tests/Integration/Commands/README.md

@@ -92,6 +92,7 @@ Get-SqlDscDatabase | 4 | 1 (Install-SqlDscServer), 0 (Prerequisites) | DSCSQLTES
 ConvertFrom-SqlDscDatabasePermission | 4 | 0 (Prerequisites) | - | -
 New-SqlDscDatabase | 4 | 1 (Install-SqlDscServer), 0 (Prerequisites) | DSCSQLTEST | SqlDscIntegrationTestDatabase_Persistent database
 Set-SqlDscDatabase | 4 | 1 (Install-SqlDscServer), 0 (Prerequisites) | DSCSQLTEST | -
+Set-SqlDscDatabaseOwner | 4 | 1 (Install-SqlDscServer), 0 (Prerequisites) | DSCSQLTEST | -
 Test-SqlDscIsDatabase | 4 | 1 (Install-SqlDscServer), 0 (Prerequisites) | DSCSQLTEST | -
 Test-SqlDscDatabaseProperty | 4 | 1 (Install-SqlDscServer), 0 (Prerequisites) | DSCSQLTEST | -
 Get-SqlDscDatabasePermission | 4 | 1 (Install-SqlDscServer), 0 (Prerequisites) | DSCSQLTEST | Test database, Test user

tests/Integration/Commands/Set-SqlDscDatabase.Integration.Tests.ps1

@@ -76,21 +76,68 @@ Describe 'Set-SqlDscDatabase' -Tag @('Integration_SQL2017', 'Integration_SQL2019
             $updatedDb.RecoveryModel | Should -Be 'Simple'
         }
 
-        It 'Should set owner name successfully' {
-            $null = Set-SqlDscDatabase -ServerObject $script:serverObject -Name $script:testDatabaseName -OwnerName ('{0}\SqlAdmin' -f $script:mockComputerName) -Force -ErrorAction 'Stop'
+        It 'Should set compatibility level successfully' {
+            $null = Set-SqlDscDatabase -ServerObject $script:serverObject -Name $script:testDatabaseName -CompatibilityLevel 'Version150' -Force -ErrorAction 'Stop'
 
             # Verify the change
-            $updatedDb = Get-SqlDscDatabase -ServerObject $script:serverObject -Name $script:testDatabaseName -ErrorAction 'Stop'
-            $updatedDb.Owner | Should -Be ('{0}\SqlAdmin' -f $script:mockComputerName)
+            $updatedDb = Get-SqlDscDatabase -ServerObject $script:serverObject -Name $script:testDatabaseName
+            $updatedDb.CompatibilityLevel | Should -Be 'Version150'
+        }
+
+        It 'Should set AutoClose successfully' {
+            $null = Set-SqlDscDatabase -ServerObject $script:serverObject -Name $script:testDatabaseName -AutoClose $true -Force -ErrorAction 'Stop'
+
+            # Verify the change
+            $updatedDb = Get-SqlDscDatabase -ServerObject $script:serverObject -Name $script:testDatabaseName
+            $updatedDb.AutoClose | Should -Be $true
+
+            # Reset to default
+            $null = Set-SqlDscDatabase -ServerObject $script:serverObject -Name $script:testDatabaseName -AutoClose $false -Force -ErrorAction 'Stop'
+        }
+
+        It 'Should set AutoShrink successfully' {
+            $null = Set-SqlDscDatabase -ServerObject $script:serverObject -Name $script:testDatabaseName -AutoShrink $true -Force -ErrorAction 'Stop'
+
+            # Verify the change
+            $updatedDb = Get-SqlDscDatabase -ServerObject $script:serverObject -Name $script:testDatabaseName
+            $updatedDb.AutoShrink | Should -Be $true
+
+            # Reset to default
+            $null = Set-SqlDscDatabase -ServerObject $script:serverObject -Name $script:testDatabaseName -AutoShrink $false -Force -ErrorAction 'Stop'
+        }
+
+        It 'Should set PageVerify successfully' {
+            $null = Set-SqlDscDatabase -ServerObject $script:serverObject -Name $script:testDatabaseName -PageVerify 'TornPageDetection' -Force -ErrorAction 'Stop'
+
+            # Verify the change
+            $updatedDb = Get-SqlDscDatabase -ServerObject $script:serverObject -Name $script:testDatabaseName
+            $updatedDb.PageVerify | Should -Be 'TornPageDetection'
+
+            # Reset to default
+            $null = Set-SqlDscDatabase -ServerObject $script:serverObject -Name $script:testDatabaseName -PageVerify 'Checksum' -Force -ErrorAction 'Stop'
         }
 
         It 'Should set multiple properties successfully' {
-            $null = Set-SqlDscDatabase -ServerObject $script:serverObject -Name $script:testDatabaseName -RecoveryModel 'Full' -OwnerName ('{0}\SqlAdmin' -f $script:mockComputerName) -Force -ErrorAction 'Stop'
+            $null = Set-SqlDscDatabase -ServerObject $script:serverObject -Name $script:testDatabaseName -RecoveryModel 'Full' -AutoClose $false -AutoShrink $false -PageVerify 'Checksum' -Force -ErrorAction 'Stop'
 
             # Verify the changes
             $updatedDb = Get-SqlDscDatabase -ServerObject $script:serverObject -Name $script:testDatabaseName -ErrorAction 'Stop'
             $updatedDb.RecoveryModel | Should -Be 'Full'
-            $updatedDb.Owner | Should -Be ('{0}\SqlAdmin' -f $script:mockComputerName)
+            $updatedDb.AutoClose | Should -Be $false
+            $updatedDb.AutoShrink | Should -Be $false
+            $updatedDb.PageVerify | Should -Be 'Checksum'
+        }
+
+        It 'Should be idempotent when property is already set' {
+            # Set property
+            $null = Set-SqlDscDatabase -ServerObject $script:serverObject -Name $script:testDatabaseName -RecoveryModel 'Simple' -Force -ErrorAction 'Stop'
+
+            # Set same property again - should not throw
+            $null = Set-SqlDscDatabase -ServerObject $script:serverObject -Name $script:testDatabaseName -RecoveryModel 'Simple' -Force -ErrorAction 'Stop'
+
+            # Verify the value is still correct
+            $updatedDb = Get-SqlDscDatabase -ServerObject $script:serverObject -Name $script:testDatabaseName
+            $updatedDb.RecoveryModel | Should -Be 'Simple'
         }
 
         It 'Should throw error when trying to set properties of non-existent database' {
@@ -110,23 +157,37 @@ Describe 'Set-SqlDscDatabase' -Tag @('Integration_SQL2017', 'Integration_SQL2019
             $updatedDb.RecoveryModel | Should -Be 'Simple'
         }
 
-        It 'Should set owner name using database object' {
+        It 'Should set AutoClose using database object' {
             $databaseObject = Get-SqlDscDatabase -ServerObject $script:serverObject -Name $script:testDatabaseNameForObject -ErrorAction 'Stop'
 
-            $null = Set-SqlDscDatabase -DatabaseObject $databaseObject -OwnerName ('{0}\SqlAdmin' -f $script:mockComputerName) -Force -ErrorAction 'Stop'
+            $null = Set-SqlDscDatabase -DatabaseObject $databaseObject -AutoClose $true -Force -ErrorAction 'Stop'
 
             # Verify the change
             $updatedDb = Get-SqlDscDatabase -ServerObject $script:serverObject -Name $script:testDatabaseNameForObject -ErrorAction 'Stop'
-            $updatedDb.Owner | Should -Be ('{0}\SqlAdmin' -f $script:mockComputerName)
+            $updatedDb.AutoClose | Should -Be $true
+
+            # Reset to default
+            $null = Set-SqlDscDatabase -DatabaseObject $databaseObject -AutoClose $false -Force -ErrorAction 'Stop'
+        }
+
+        It 'Should set multiple properties using database object' {
+            $databaseObject = Get-SqlDscDatabase -ServerObject $script:serverObject -Name $script:testDatabaseNameForObject -ErrorAction 'Stop'
+
+            $null = Set-SqlDscDatabase -DatabaseObject $databaseObject -RecoveryModel 'Full' -PageVerify 'TornPageDetection' -Force -ErrorAction 'Stop'
+
+            # Verify the changes
+            $updatedDb = Get-SqlDscDatabase -ServerObject $script:serverObject -Name $script:testDatabaseNameForObject -ErrorAction 'Stop'
+            $updatedDb.RecoveryModel | Should -Be 'Full'
+            $updatedDb.PageVerify | Should -Be 'TornPageDetection'
         }
 
         It 'Should support pipeline input with database object' {
             $databaseObject = Get-SqlDscDatabase -ServerObject $script:serverObject -Name $script:testDatabaseNameForObject -ErrorAction 'Stop'
-            $null = $databaseObject | Set-SqlDscDatabase -RecoveryModel 'Full' -Force -ErrorAction 'Stop'
+            $null = $databaseObject | Set-SqlDscDatabase -RecoveryModel 'BulkLogged' -Force -ErrorAction 'Stop'
 
             # Verify the change
             $updatedDb = Get-SqlDscDatabase -ServerObject $script:serverObject -Name $script:testDatabaseNameForObject -ErrorAction 'Stop'
-            $updatedDb.RecoveryModel | Should -Be 'Full'
+            $updatedDb.RecoveryModel | Should -Be 'BulkLogged'
         }
     }