functions/Test-DbaDatabaseCompatibility.ps1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
function Test-DbaDatabaseCompatibility {
    <#
  .SYNOPSIS
   Compares Database Compatibility level to Server Compatibility
 
  .DESCRIPTION
   Compares Database Compatibility level to Server Compatibility
 
  .PARAMETER SqlInstance
   The SQL Server that you're connecting to.
 
  .PARAMETER Credential
   Allows you to login to servers using SQL Logins instead of Windows Authentication (AKA Integrated or Trusted). To use:
 
   $scred = Get-Credential, then pass $scred object to the -Credential parameter.
 
   Windows Authentication will be used if Credential is not specified. SQL Server does not accept Windows credentials being passed as credentials.
 
   To connect as a different Windows user, run PowerShell as that user.
 
  .PARAMETER Database
   Specifies the database(s) to process. Options for this list are auto-populated from the server. If unspecified, all databases will be processed.
   
  .PARAMETER ExcludeDatabase
   Specifies the database(s) to exclude from processing. Options for this list are auto-populated from the server.
   
  .PARAMETER Detailed
   If this switch is enabled, full details about database & server compatibility levels and whether they match is returned.
 
  .PARAMETER 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.
 
  .NOTES
   Tags:
   Website: https://dbatools.io
   Copyright: (C) Chrissy LeMaire, clemaire@gmail.com
   License: GNU GPL v3 https://opensource.org/licenses/GPL-3.0
 
  .LINK
   https://dbatools.io/Test-DbaDatabaseCompatibility
 
  .EXAMPLE
   Test-DbaDatabaseCompatibility -SqlInstance sqlserver2014a
 
   Returns server name, database name and true/false if the compatibility level match for all databases on sqlserver2014a.
 
  .EXAMPLE
   Test-DbaDatabaseCompatibility -SqlInstance sqlserver2014a -Database db1, db2
 
   Returns server name, database name and true/false if the compatibility level match for the db1 and db2 databases on sqlserver2014a.
 
  .EXAMPLE
   Test-DbaDatabaseCompatibility -SqlInstance sqlserver2014a, sql2016 -Detailed -Exclude db1
 
   Returns detailed information for database and server compatibility level for all databases except db1 on sqlserver2014a and sql2016.
 
  .EXAMPLE
   Get-DbaRegisteredServer -SqlInstance sql2014 | Test-DbaDatabaseCompatibility
 
   Returns db/server compatibility information for every database on every server listed in the Central Management Server on sql2016.
 #>

    [CmdletBinding()]
    [OutputType("System.Collections.ArrayList")]
    Param (
        [parameter(Mandatory = $true, ValueFromPipeline = $true)]
        [Alias("ServerInstance", "SqlServer")]
        [DbaInstanceParameter[]]$SqlInstance,
        [PSCredential]$Credential,
        [Alias("Databases")]
        [object[]]$Database,
        [object[]]$ExcludeDatabase,
        [switch]$Detailed,
        [Alias('Silent')]
        [switch]$EnableException
    )

    begin {
        $collection = New-Object System.Collections.ArrayList
    }

    process {
        foreach ($instance in $SqlInstance) {
            Write-Message -Level Verbose -Message "Connecting to $instance."
            try {
                $server = Connect-SqlInstance -SqlInstance $instance -SqlCredential $SqlCredential -MinimumVersion 10
            }
            catch {
                Stop-Function -Message "Failure" -Category ConnectionError -ErrorRecord $_ -Target $instance -Continue
            }

            $serverversion = "Version$($server.VersionMajor)0"
            $dbs = $server.Databases

            if ($Database) {
                $dbs = $dbs | Where-Object { $Database -contains $_.Name }
            }

            if ($ExcludeDatabase) {
                $dbs = $dbs | Where-Object Name -NotIn $ExcludeDatabase
            }

            foreach ($db in $dbs) {
                Write-Message -Level Verbose -Message "Processing $($db.name) on $instance."
                $null = $collection.Add([PSCustomObject]@{
                        Server                = $server.name
                        ServerLevel           = $serverversion
                        Database              = $db.name
                        DatabaseCompatibility = $db.CompatibilityLevel
                        IsEqual               = $db.CompatibilityLevel -eq $serverversion
                    })
            }
        }
    }

    end {
        if ($Detailed -eq $true) {
            return $collection
        }

        if ($Database.count -eq 1) {
            if ($SqlInstance.count -eq 1) {
                return $collection.IsEqual
            }
            else {
                return ($collection | Select-Object Server, isEqual)
            }
        }
        else {
            return ($collection | Select-Object Server, Database, IsEqual)
        }
    }
}