< Back
Get-DbaDbFile
Post
NAME Get-DbaDbFile
SYNOPSIS
Returns detailed information about database files.
SYNTAX
Get-DbaDbFile [[-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>] [[-SqlCredential]
<Pscredential>] [[-Database] <System.Object[]>] [[-ExcludeDatabase] <System.Object[]>] [[-InputObject]
<Microsoft.SqlServer.Management.Smo.Database[]>] [-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
Returns detailed information about database files. Does not use SMO - SMO causes enumeration and this command
avoids that.
PARAMETERS
-Database [<System.Object[]>]
The database(s) to process - this list is 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.Object[]>]
The database(s) to exclude - this list is auto-populated from the server
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
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
Author: Stuart Moore (@napalmgram), stuart-moore.com
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-DbaDbFile -SqlInstance sql2016
Will return an object containing all file groups and their contained files for every database on the sql2016 SQL
Server instance
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-DbaDbFile -SqlInstance sql2016 -Database Impromptu
Will return an object containing all file groups and their contained files for the Impromptu Database on the
sql2016 SQL Server instance
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Get-DbaDbFile -SqlInstance sql2016 -Database Impromptu, Trading
Will return an object containing all file groups and their contained files for the Impromptu and Trading databases
on the sql2016 SQL Server instance
-------------------------- EXAMPLE 4 --------------------------
PS C:\\>Get-DbaDatabase -SqlInstance sql2016 -Database Impromptu, Trading | Get-DbaDbFile
Will accept piped input from Get-DbaDatabase and return an object containing all file groups and their contained
files for the Impromptu and Trading databases on the sql2016 SQL Server instance
RELATED LINKS
SYNOPSIS
Returns detailed information about database files.
SYNTAX
Get-DbaDbFile [[-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>] [[-SqlCredential]
<Pscredential>] [[-Database] <System.Object[]>] [[-ExcludeDatabase] <System.Object[]>] [[-InputObject]
<Microsoft.SqlServer.Management.Smo.Database[]>] [-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
Returns detailed information about database files. Does not use SMO - SMO causes enumeration and this command
avoids that.
PARAMETERS
-Database [<System.Object[]>]
The database(s) to process - this list is 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.Object[]>]
The database(s) to exclude - this list is auto-populated from the server
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
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
Author: Stuart Moore (@napalmgram), stuart-moore.com
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-DbaDbFile -SqlInstance sql2016
Will return an object containing all file groups and their contained files for every database on the sql2016 SQL
Server instance
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-DbaDbFile -SqlInstance sql2016 -Database Impromptu
Will return an object containing all file groups and their contained files for the Impromptu Database on the
sql2016 SQL Server instance
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Get-DbaDbFile -SqlInstance sql2016 -Database Impromptu, Trading
Will return an object containing all file groups and their contained files for the Impromptu and Trading databases
on the sql2016 SQL Server instance
-------------------------- EXAMPLE 4 --------------------------
PS C:\\>Get-DbaDatabase -SqlInstance sql2016 -Database Impromptu, Trading | Get-DbaDbFile
Will accept piped input from Get-DbaDatabase and return an object containing all file groups and their contained
files for the Impromptu and Trading databases on the sql2016 SQL Server instance
RELATED LINKS