Skip to content

Find DbIndexes

github-actions edited this page Jul 30, 2026 · 1 revision

external help file: Databaseline-help.xml Module Name: Databaseline online version: https://dbatools.io/ schema: 2.0.0

Find-DbIndexes

SYNOPSIS

Returns indexes using a column with the given name.

SYNTAX

Find-DbIndexes [-SqlInstance] <DbaInstanceParameter> [-Database] <String> [-ColumnName] <String>
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

{{ Fill in the Description }}

EXAMPLES

EXAMPLE 1

Find-DbIndexes -SqlInstance '(localdb)\ProjectsV13' -Database AdventureWorks2014 -ColumnName ErrorLogID

SchemaName : dbo TableName : ErrorLog IndexName : PK_ErrorLog_ErrorLogID IndexOrdinal : 1 IsUnique : 1 IsClustered : 1 IsDisabled : 0 ColumnsInIndex : 1

PARAMETERS

-SqlInstance

The server to use, by name or constructed via Connect-DbaInstance.

Type: DbaInstanceParameter
Parameter Sets: (All)
Aliases: Parent, ServerInstance

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Database

The the database to connect to on the server.

Type: String
Parameter Sets: (All)
Aliases: Name

Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ColumnName

The column name to search for.

Type: String
Parameter Sets: (All)
Aliases: ColName

Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

System.Management.Automation.PSCustomObject with these properties:

* SchemaName

* TableName

* IndexName

* IndexOrdinal

* IsUnique

* IsClustered

* IsDisabled

* ColumnsInIndex

NOTES

RELATED LINKS

https://dbatools.io/

https://docs.microsoft.com/sql/relational-databases/system-catalog-views/sys-index-columns-transact-sql

Clone this wiki locally