< Back

Get-DbaDbCompression

Mon Jan 13, 2020 10:38 am

NAME Get-DbaDbCompression



SYNOPSIS

Gets tables and indexes size and current compression settings.





SYNTAX

Get-DbaDbCompression [-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]> [[-SqlCredential]

<Pscredential>] [[-Database] <System.Object[]>] [[-ExcludeDatabase] <System.Object[]>] [-EnableException <Switch>]

[<CommonParameters>]





DESCRIPTION

This function gets the current size and compression for all objects in the specified database(s), if no database

is specified it will return all objects in all user databases.





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



-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. This can be a collection and receive pipeline input to allow the

function to be executed against multiple SQL Server 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: Compression, Table, Database

Author: Jess Pomfret (@jpomfret), jesspomfret.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-DbaDbCompression -SqlInstance localhost



Returns objects size and current compression level for all user databases.

-------------------------- EXAMPLE 2 --------------------------



PS C:\\>Get-DbaDbCompression -SqlInstance localhost -Database TestDatabase



Returns objects size and current compression level for objects within the TestDatabase database.

-------------------------- EXAMPLE 3 --------------------------



PS C:\\>Get-DbaDbCompression -SqlInstance localhost -ExcludeDatabase TestDatabases



Returns objects size and current compression level for objects in all databases except the TestDatabase database.



RELATED LINKS