functions/Get-DbaDatabaseSpace.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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
function Get-DbaDatabaseSpace {
<#
    .SYNOPSIS
        Returns database file space information for database files on a SQL instance.
     
    .DESCRIPTION
        This function returns database file space information for a SQL Instance or group of SQL
        Instances. Information is based on a query against sys.database_files and the FILEPROPERTY
        function to query and return information. The function can accept a single instance or
        multiple instances. By default, only user dbs will be shown, but using the IncludeSystemDBs
        switch will include system databases
         
        File free space script borrowed and modified from Glenn Berry's DMV scripts (http://www.sqlskills.com/blogs/glenn/category/dmv-queries/)
     
    .PARAMETER SqlInstance
        SqlInstance name or SMO object representing the SQL Server to connect to. This can be a collection and receive pipeline input
     
    .PARAMETER SqlCredential
        PSCredential object to connect under. If not specified, current Windows login will be used.
     
    .PARAMETER Database
        The database(s) to process - this list is auto-populated from the server. If unspecified, all databases will be processed.
     
    .PARAMETER ExcludeDatabase
        The database(s) to exclude - this list is auto-populated from the server
     
    .PARAMETER IncludeSystemDBs
        Switch parameter that when used will display system database information
     
    .PARAMETER Silent
        Replaces user friendly yellow warnings with bloody red exceptions of doom!
        Use this if you want the function to throw terminating errors you want to catch.
     
    .EXAMPLE
        Get-DbaDatabaseSpace -SqlInstance localhost
         
        Returns all user database files and free space information for the local host
     
    .EXAMPLE
        Get-DbaDatabaseSpace -SqlInstance localhost | Where-Object {$_.PercentUsed -gt 80}
         
        Returns all user database files and free space information for the local host. Filters
        the output object by any files that have a percent used of greater than 80%.
     
    .EXAMPLE
        'localhost','localhost\namedinstance' | Get-DbaDatabaseSpace
         
        Returns all user database files and free space information for the localhost and
        localhost\namedinstance SQL Server instances. Processes data via the pipeline.
     
    .EXAMPLE
        Get-DbaDatabaseSpace -SqlInstance localhost -Database db1, db2
         
        Returns database files and free space information for the db1 and db2 on localhost.
     
    .NOTES
        Original Author: Michael Fal (@Mike_Fal), http://mikefal.net
        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/Get-DbaDatabaseSpace
#>

    [CmdletBinding()]
    param ([parameter(ValueFromPipeline, Mandatory = $true)]
        [Alias("ServerInstance", "SqlServer")]
        [DbaInstanceParameter[]]
        $SqlInstance,
        
        [System.Management.Automation.PSCredential]
        $SqlCredential,
        
        [Alias("Databases")]
        [object[]]
        $Database,
        
        [object[]]
        $ExcludeDatabase,
        
        [switch]
        $IncludeSystemDBs,
        
        [switch]
        $Silent
    )
    
    begin {
        Write-Message -Level System -Message "Bound parameters: $($PSBoundParameters.Keys -join ", ")"
        
        $sql = "SELECT SERVERPROPERTY('MachineName') AS ComputerName,
                                   ISNULL(SERVERPROPERTY('InstanceName'), 'MSSQLSERVER') AS InstanceName,
                                   SERVERPROPERTY('ServerName') AS SqlInstance,
                    DB_NAME() as DBName
                    ,f.name AS [FileName]
                    ,fg.name AS [Filegroup]
                    ,f.physical_name AS [PhysicalName]
                    ,f.type_desc AS [FileType]
                    ,CAST(CAST(FILEPROPERTY(f.name, 'SpaceUsed') AS int)/128.0 AS FLOAT) as [UsedSpaceMB]
                    ,CAST(f.size/128.0 - CAST(FILEPROPERTY(f.name, 'SpaceUsed') AS int)/128.0 AS FLOAT) AS [FreeSpaceMB]
                    ,CAST((f.size/128.0) AS FLOAT) AS [FileSizeMB]
                    ,CAST((FILEPROPERTY(f.name, 'SpaceUsed')/(f.size/1.0)) * 100 as FLOAT) as [PercentUsed]
                    ,CAST((f.growth/128.0) AS FLOAT) AS [GrowthMB]
                    ,CASE is_percent_growth WHEN 1 THEN 'pct' WHEN 0 THEN 'MB' ELSE 'Unknown' END AS [GrowthType]
                    ,CASE f.max_size WHEN -1 THEN 2147483648. ELSE CAST((f.max_size/128.0) AS FLOAT) END AS [MaxSizeMB]
                    ,CAST((f.size/128.0) AS FLOAT) - CAST(CAST(FILEPROPERTY(f.name, 'SpaceUsed') AS int)/128.0 AS FLOAT) AS [SpaceBeforeAutoGrow]
                    ,CASE f.max_size WHEN (-1)
                                        THEN CAST(((2147483648.) - CAST(FILEPROPERTY(f.name, 'SpaceUsed') AS int))/128.0 AS FLOAT)
                                        ELSE CAST((f.max_size - CAST(FILEPROPERTY(f.name, 'SpaceUsed') AS int))/128.0 AS FLOAT)
                                        END AS [SpaceBeforeMax]
                    ,CASE f.growth WHEN 0 THEN 0.00
                                    ELSE CASE f.is_percent_growth WHEN 0
                                                    THEN CASE f.max_size
                                                            WHEN (-1)
                                                            THEN CAST(((((2147483648.)-f.Size)/f.Growth)*f.Growth)/128.0 AS FLOAT)
                                                            ELSE CAST((((f.max_size-f.Size)/f.Growth)*f.Growth)/128.0 AS FLOAT)
                                                            END
                                                    WHEN 1
                                                    THEN CASE f.max_size
                                                            WHEN (-1)
                                                            THEN CAST(CONVERT([int],f.Size*power((1)+CONVERT([float],f.Growth)/(100),CONVERT([int],log10(CONVERT([float],(2147483648.))/CONVERT([float],f.Size))/log10((1)+CONVERT([float],f.Growth)/(100)))))/128.0 AS FLOAT)
                                                            ELSE CAST(CONVERT([int],f.Size*power((1)+CONVERT([float],f.Growth)/(100),CONVERT([int],log10(CONVERT([float],f.Max_Size)/CONVERT([float],f.Size))/log10((1)+CONVERT([float],f.Growth)/(100)))))/128.0 AS FLOAT)
                                                            END
                                                    ELSE (0)
                                                    END
                                    END AS [PossibleAutoGrowthMB]
                    , CASE f.growth WHEN 0 THEN CASE f.max_size
                                                WHEN (-1)
                                                THEN CAST(((2147483648.) - CAST(FILEPROPERTY(f.name, 'SpaceUsed') AS int))/128.0 AS FLOAT)
                                                ELSE CAST((f.max_size - CAST(FILEPROPERTY(f.name, 'SpaceUsed') AS int))/128.0 AS FLOAT)
                                                END
                                    ELSE CAST((f.max_size - f.size - ( CASE f.is_percent_growth
                                                WHEN 0
                                                THEN CASE f.max_size
                                                        WHEN (-1)
                                                        THEN CONVERT(FLOAT,((((2147483648.)-f.Size)/f.Growth)*f.Growth))
                                                        ELSE CONVERT(FLOAT,(((f.max_size-f.Size)/f.Growth)*f.Growth))
                                                        END
                                                WHEN 1
                                                THEN CASE f.max_size
                                                        WHEN (-1)
                                                        THEN CONVERT([int],f.Size*power((1)+CONVERT([float],f.Growth)/(100),CONVERT([int],log10(CONVERT([float],(2147483648.))/CONVERT([float],f.Size))/log10((1)+CONVERT([float],f.Growth)/(100)))))
                                                        ELSE CONVERT([int],f.Size*power((1)+CONVERT([float],f.Growth)/(100),CONVERT([int],log10(CONVERT([float],f.Max_Size)/CONVERT([float],f.Size))/log10((1)+CONVERT([float],f.Growth)/(100)))))
                                                        END
                                                        ELSE (0)
                                                        END ))/128.0 AS FLOAT)
                                    END AS [UnusableSpaceMB]
  
                FROM sys.database_files AS f WITH (NOLOCK)
                LEFT OUTER JOIN sys.filegroups AS fg WITH (NOLOCK)
                ON f.data_space_id = fg.data_space_id"

    }
    
    process {
        
        foreach ($instance in $SqlInstance) {
            try {
                Write-Message -Level VeryVerbose -Message "Connecting to $instance" -Target $instance
                $server = Connect-SqlInstance -SqlInstance $instance -SqlCredential $SqlCredential
            }
            catch {
                Stop-Function -Message "Failed to process Instance $Instance" -ErrorRecord $_ -Target $instance -Continue
            }
            
            if ($server.VersionMajor -lt 9) {
                Write-Message -Level Warning -Message "SQL Server 2000 not supported. $server skipped."
                continue
            }
            
            #If IncludeSystemDBs is true, include systemdbs
            #look at all databases, online/offline/accessible/inaccessible and tell user if a db can't be queried.
            try {
                if (Test-Bound "Database") {
                    $dbs = $server.Databases | Where-Object Name -In $Database
                }
                elseif ($IncludeSystemDBs) {
                    $dbs = $server.Databases | Where-Object Status -eq 'Normal'
                }
                else {
                    $dbs = $server.Databases | Where-Object { $_.status -eq 'Normal' -and $_.IsSystemObject -eq 0 }
                }
                
                if (Test-Bound "ExcludeDatabase") {
                    $dbs = $dbs | Where-Object Name -NotIn $ExcludeDatabase
                }
            }
            catch {
                Stop-Function -Message "Unable to gather databases for $instance" -ErrorRecord $_ -Continue
            }
            
            foreach ($db in $dbs) {
                try {
                    Write-Message -Level Verbose -Message "Querying $instance - $db"
                    If ($db.status -ne 'Normal' -or $db.IsAccessible -eq $false) {
                        Write-Message -Level Warning -Message "$db is not accessible." -Target $db
                        continue
                    }
                    #Execute query against individual database and add to output
                    foreach ($row in ($db.ExecuteWithResults($sql)).Tables.Rows) {
                        If ($row.UsedSpaceMB -is [System.DBNull]) { $UsedMB = 0 }
                        Else { $UsedMB = [Math]::Round($row.UsedSpaceMB) }
                        If ($row.FreeSpaceMB -is [System.DBNull]) { $FreeMB = 0 }
                        Else { $FreeMB = [Math]::Round($row.FreeSpaceMB) }
                        If ($row.PercentUsed -is [System.DBNull]) { $PercentUsed = 0 }
                        Else { $PercentUsed = [Math]::Round($row.PercentUsed) }
                        If ($row.SpaceBeforeMax -is [System.DBNull]) { $SpaceUntilMax = 0 }
                        Else { $SpaceUntilMax = [Math]::Round($row.SpaceBeforeMax) }
                        If ($row.UnusableSpaceMB -is [System.DBNull]) { $UnusableSpace = 0 }
                        Else { $UnusableSpace = [Math]::Round($row.UnusableSpaceMB) }
                        
                        [pscustomobject]@{
                            ComputerName = $server.NetName
                            InstanceName = $server.ServiceName
                            SqlInstance = $server.DomainInstanceName
                            Database = $row.DBName
                            FileName = $row.FileName
                            FileGroup = $row.FileGroup
                            PhysicalName = $row.PhysicalName
                            FileType = $row.FileType
                            UsedSpaceMB = $UsedMB
                            FreeSpaceMB = $FreeMB
                            FileSizeMB = $row.FileSizeMB
                            PercentUsed = $PercentUsed
                            AutoGrowth = $row.GrowthMB
                            AutoGrowType = $row.GrowthType
                            SpaceUntilMaxSizeMB = $SpaceUntilMax
                            AutoGrowthPossibleMB = $row.PossibleAutoGrowthMB
                            UnusableSpaceMB = $UnusableSpace
                        }
                    }
                }
                catch {
                    Stop-Function -Message "Unable to query $instance - $db" -Target $db -ErrorRecord $_ -Continue
                }
            }
        }
    }
    
    end {
        Test-DbaDeprecation -DeprecatedOn "1.0.0" -Alias Get-DbaDatabaseFreeSpace 
    }
}