Skip to content

Find DbColumn

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

SYNOPSIS

Searches for database columns.

SYNTAX

Find-DbColumn [-SqlInstance] <DbaInstanceParameter> [-Database] <String> [-IncludeSchemata <String[]>]
 [-ExcludeSchemata <String[]>] [-IncludeTables <String[]>] [-ExcludeTables <String[]>]
 [-IncludeColumns <String[]>] [-ExcludeColumns <String[]>] [-DataType <String>] [-MinLength <Int32>]
 [-MaxLength <Int32>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

{{ Fill in the Description }}

EXAMPLES

EXAMPLE 1

Find-DbColumn -SqlInstance '(localdb)\ProjectsV13' -Database AdventureWorks2016 -IncludeColumns %price% |Format-Table -AutoSize

TableSchema TableName ColumnName DataType Nullable DefaultValue


Production Product ListPrice money False Production ProductListPriceHistory ListPrice money False Purchasing ProductVendor StandardPrice money False Purchasing PurchaseOrderDetail UnitPrice money False Sales SalesOrderDetail UnitPrice money False Sales SalesOrderDetail UnitPriceDiscount money False ((0.0))

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

-IncludeSchemata

A like-pattern of database schemata to include (will only include these).

Type: String[]
Parameter Sets: (All)
Aliases:

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

-ExcludeSchemata

A like-pattern of database schemata to exclude.

Type: String[]
Parameter Sets: (All)
Aliases:

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

-IncludeTables

A like-pattern of database tables to include (will only include these).

Type: String[]
Parameter Sets: (All)
Aliases:

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

-ExcludeTables

A like-pattern of database tables to exclude.

Type: String[]
Parameter Sets: (All)
Aliases:

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

-IncludeColumns

A like-pattern of database columns to include (will only include these).

Type: String[]
Parameter Sets: (All)
Aliases:

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

-ExcludeColumns

A like-pattern of database columns to exclude.

Type: String[]
Parameter Sets: (All)
Aliases:

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

-DataType

The basic datatype to search for.

Type: String
Parameter Sets: (All)
Aliases:

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

-MinLength

The minimum character column length.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-MaxLength

The maximum character column length.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: 0
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 for each found column:

* TableSchema

* TableName

* ColumnName

* DataType

* Nullable

* DefaultValue

NOTES

RELATED LINKS

https://dbatools.io/

Clone this wiki locally