Get-DbaDbSpace

Want to see the source code for this command? Check out Get-DbaDbSpace on GitHub.
Want to see the Bill Of Health for this command? Check out Get-DbaDbSpace.

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.

File free space script borrowed and modified from Glenn Berry's DMV scripts (http://www.sqlskills.com/blogs/glenn/category/dmv-queries/)

Syntax

Get-DbaDbSpace
    [[-SqlInstance] <DbaInstanceParameter[]>]
    [[-SqlCredential] <PSCredential>]
    [[-Database] <String[]>]
    [[-ExcludeDatabase] <String[]>]
    [-IncludeSystemDBs]
    [[-InputObject] <Database[]>]
    [-EnableException]
    [<CommonParameters>]

Examples

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

Optional Parameters

-SqlInstance

The target SQL Server instance or instances.

-SqlCredential

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.

-Database

Specifies the database(s) to process. Options for this list are auto-populated from the server. If unspecified, all databases will be processed.

-ExcludeDatabase

Specifies the database(s) to exclude from processing. Options for this list are auto-populated from the server.

-IncludeSystemDBs

Deprecated - if filtering is needed, please pipe filtered results from Get-DbaDatabase

-InputObject

A piped collection of database objects from Get-DbaDatabase

-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.