< Back
Get-DbaDbSpace
Post
NAME Get-DbaDbSpace
SYNOPSIS
Returns database file space information for database files on a SQL instance.
SYNTAX
Get-DbaDbSpace [[-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>] [[-SqlCredential]
<Pscredential>] [[-Database] <System.String[]>] [[-ExcludeDatabase] <System.String[]>] [-IncludeSystemDBs
<Switch>] [[-InputObject] <Microsoft.SqlServer.Management.Smo.Database[]>] [-EnableException <Switch>]
[<CommonParameters>]
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.
File free space script borrowed and modified from Glenn Berry's DMV scripts
(http://www.sqlskills.com/blogs/glenn/ca ... v-queries/)
PARAMETERS
-Database [<System.String[]>]
Specifies the database(s) to process. Options for this list are auto-populated from the server. If
unspecified, all databases will be processed.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-EnableException [<Switch>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-ExcludeDatabase [<System.String[]>]
Specifies the database(s) to exclude from processing. Options for this list are auto-populated from the server.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-IncludeSystemDBs [<Switch>]
Deprecated - if filtering is needed, please pipe filtered results from Get-DbaDatabase
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-InputObject [<Microsoft.SqlServer.Management.Smo.Database[]>]
A piped collection of database objects from Get-DbaDatabase
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlCredential [<Pscredential>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlInstance [<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
The target SQL Server instance or instances.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
Tags: Database, Space
Author: Michael Fal (@Mike_Fal), http://mikefal.net
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-DbaDbSpace -SqlInstance localhost
Returns all user database files and free space information for the localhost.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-DbaDbSpace -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 3 --------------------------
PS C:\\>'localhost','localhost\\namedinstance' | Get-DbaDbSpace
Returns all user database files and free space information for the localhost and localhost\\namedinstance SQL
Server instances. Processes data via the pipeline.
-------------------------- EXAMPLE 4 --------------------------
PS C:\\>Get-DbaDbSpace -SqlInstance localhost -Database db1, db2 | Where-Object { $_.SpaceUntilMaxSize.Megabyte -lt
1 }
Returns database files and free space information for the db1 and db2 on localhost where there is only 1MB left
until the space is maxed out
-------------------------- EXAMPLE 5 --------------------------
PS C:\\>Get-DbaDbSpace -SqlInstance localhost -Database db1, db2 | Where-Object { $_.SpaceUntilMaxSize.Gigabyte -lt
1 }
Returns database files and free space information for the db1 and db2 on localhost where there is only 1GB left
until the space is maxed out
RELATED LINKS
https://dbatools.io/Get-DbaDbSpace
SYNOPSIS
Returns database file space information for database files on a SQL instance.
SYNTAX
Get-DbaDbSpace [[-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>] [[-SqlCredential]
<Pscredential>] [[-Database] <System.String[]>] [[-ExcludeDatabase] <System.String[]>] [-IncludeSystemDBs
<Switch>] [[-InputObject] <Microsoft.SqlServer.Management.Smo.Database[]>] [-EnableException <Switch>]
[<CommonParameters>]
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.
File free space script borrowed and modified from Glenn Berry's DMV scripts
(http://www.sqlskills.com/blogs/glenn/ca ... v-queries/)
PARAMETERS
-Database [<System.String[]>]
Specifies the database(s) to process. Options for this list are auto-populated from the server. If
unspecified, all databases will be processed.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-EnableException [<Switch>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-ExcludeDatabase [<System.String[]>]
Specifies the database(s) to exclude from processing. Options for this list are auto-populated from the server.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-IncludeSystemDBs [<Switch>]
Deprecated - if filtering is needed, please pipe filtered results from Get-DbaDatabase
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-InputObject [<Microsoft.SqlServer.Management.Smo.Database[]>]
A piped collection of database objects from Get-DbaDatabase
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlCredential [<Pscredential>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlInstance [<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
The target SQL Server instance or instances.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
Tags: Database, Space
Author: Michael Fal (@Mike_Fal), http://mikefal.net
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-DbaDbSpace -SqlInstance localhost
Returns all user database files and free space information for the localhost.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-DbaDbSpace -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 3 --------------------------
PS C:\\>'localhost','localhost\\namedinstance' | Get-DbaDbSpace
Returns all user database files and free space information for the localhost and localhost\\namedinstance SQL
Server instances. Processes data via the pipeline.
-------------------------- EXAMPLE 4 --------------------------
PS C:\\>Get-DbaDbSpace -SqlInstance localhost -Database db1, db2 | Where-Object { $_.SpaceUntilMaxSize.Megabyte -lt
1 }
Returns database files and free space information for the db1 and db2 on localhost where there is only 1MB left
until the space is maxed out
-------------------------- EXAMPLE 5 --------------------------
PS C:\\>Get-DbaDbSpace -SqlInstance localhost -Database db1, db2 | Where-Object { $_.SpaceUntilMaxSize.Gigabyte -lt
1 }
Returns database files and free space information for the db1 and db2 on localhost where there is only 1GB left
until the space is maxed out
RELATED LINKS
https://dbatools.io/Get-DbaDbSpace