Get-DbaDbPartitionFunction

Synopsis

Retrieves partition function definitions and metadata from SQL Server databases.

Description

Retrieves partition function definitions and their metadata from one or more SQL Server databases. Partition functions define how table or index data is distributed across multiple partitions based on the values of a partitioning column. This function returns details like creation date, function name, and number of partitions, making it useful for documenting partitioning schemes, analyzing partition distribution strategies, and auditing partitioned table configurations before maintenance operations.

Syntax

Get-DbaDbPartitionFunction
    [-SqlInstance] <DbaInstanceParameter[]>
    [[-SqlCredential] <PSCredential>]
    [[-Database] <Object[]>]
    [[-ExcludeDatabase] <Object[]>]
    [[-PartitionFunction] <String[]>]
    [-EnableException]
    [<CommonParameters>]

Examples

Example: 1

PS C:\> Get-DbaDbPartitionFunction -SqlInstance sql2016

Gets all database partition functions.

Example: 2

PS C:\> Get-DbaDbPartitionFunction -SqlInstance Server1 -Database db1

Gets the partition functions for the db1 database.

Example: 3

PS C:\> Get-DbaDbPartitionFunction -SqlInstance Server1 -ExcludeDatabase db1

Gets the partition functions for all databases except db1.

Example: 4

PS C:\> 'Sql1','Sql2/sqlexpress' | Get-DbaDbPartitionFunction

Gets the partition functions for the databases on Sql1 and Sql2/sqlexpress.

Example: 5

PS C:\> Get-DbaDbPartitionFunction -SqlInstance localhost -Database TestDB -PartitionFunction partFun01

Gets the partition function partFun01 for the TestDB on localhost.

Required Parameters

-SqlInstance

The target SQL Server instance or instances.

Optional Parameters

-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 which databases to search for partition functions. Accepts multiple database names as an array.
Use this when you need to examine partition functions in specific databases rather than scanning all accessible databases on the instance.

-ExcludeDatabase

Specifies which databases to skip when searching for partition functions. Accepts multiple database names as an array.
Use this to avoid scanning system databases or databases where you know partition functions don’t exist, improving performance on instances with many databases.

-PartitionFunction

Specifies which partition functions to retrieve by name. Accepts multiple function names as an array and supports wildcards.
Use this when you need details about specific partition functions rather than retrieving all partition functions from the target databases.

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