internal/functions/Select-DbaObject.ps1
|
function Select-DbaObject { <# .SYNOPSIS Wrapper around Select-Object, extends property parameter. .DESCRIPTION Wrapper around Select-Object, extends property parameter. This function allows specifying in-line transformation of the properties specified without needing to use complex hashtables. Without removing the ability to specify just those hashtables. See the description of the Property parameter for an exhaustive list of legal notations. .PARAMETER InputObject The object(s) to select from. .PARAMETER Property The properties to select. - Supports hashtables, which will be passed through to Select-Object. - Supports renaming as it is possible in SQL: "Length AS Size" will select the Length property but rename it to size. - Supports casting to a specified type: "Address to IPAddress" or "Length to int". Uses PowerShell type-conversion. - Supports parsing numbers to sizes: "Length size GB:2" Converts numeric input (presumed to be bytes) to gigabyte with two decimals. Also supports toggling on Unit descriptors by adding another element: "Length size GB:2:1" - Supports selecting properties from objects in other variables: "ComputerName from VarName" (Will insert the property 'ComputerName' from variable $VarName) - Supports filtering when selecting from outside objects: "ComputerName from VarName where ObjectId = Id" (Will insert the property 'ComputerName' from the object in variable $VarName, whose ObjectId property is equal to the inputs Id property) .PARAMETER ExcludeProperty Properties to not list. .PARAMETER ExpandProperty Properties to expand. .PARAMETER Unique Do not list multiples of the same value. .PARAMETER Last Select the last n items. .PARAMETER First Select the first n items. .PARAMETER Skip Skip the first (or last if used with -Last) n items. .PARAMETER SkipLast Skip the last n items. .PARAMETER Wait Indicates that the cmdlet turns off optimization.Windows PowerShell runs commands in the order that they appear in the command pipeline and lets them generate all objects. By default, if you include a Select-Object command with the First or Index parameters in a command pipeline, Windows PowerShell stops the command that generates the objects as soon as the selected number of objects is generated. .PARAMETER Index Specifies an array of objects based on their index values. Enter the indexes in a comma-separated list. #> [CmdletBinding(DefaultParameterSetName = 'DefaultParameter', RemotingCapability = 'None')] param ( [Parameter(ValueFromPipeline = $true)] [psobject] $InputObject, [Parameter(ParameterSetName = 'DefaultParameter', Position = 0)] [Parameter(ParameterSetName = 'SkipLastParameter', Position = 0)] [SqlCollaborative.Dbatools.Parameter.DbaSelectParameter[]] $Property, [Parameter(ParameterSetName = 'SkipLastParameter')] [Parameter(ParameterSetName = 'DefaultParameter')] [string[]] $ExcludeProperty, [Parameter(ParameterSetName = 'DefaultParameter')] [Parameter(ParameterSetName = 'SkipLastParameter')] [string] $ExpandProperty, [switch] $Unique, [Parameter(ParameterSetName = 'DefaultParameter')] [ValidateRange(0, 2147483647)] [int] $Last, [Parameter(ParameterSetName = 'DefaultParameter')] [ValidateRange(0, 2147483647)] [int] $First, [Parameter(ParameterSetName = 'DefaultParameter')] [ValidateRange(0, 2147483647)] [int] $Skip, [Parameter(ParameterSetName = 'SkipLastParameter')] [ValidateRange(0, 2147483647)] [int] $SkipLast, [Parameter(ParameterSetName = 'IndexParameter')] [Parameter(ParameterSetName = 'DefaultParameter')] [switch] $Wait, [Parameter(ParameterSetName = 'IndexParameter')] [ValidateRange(0, 2147483647)] [int[]] $Index ) begin { try { $outBuffer = $null if ($PSBoundParameters.TryGetValue('OutBuffer', [ref]$outBuffer)) { $PSBoundParameters['OutBuffer'] = 1 } $clonedParameters = @{ } foreach ($key in $PSBoundParameters.Keys) { if ($key -ne "Property") { $clonedParameters[$key] = $PSBoundParameters[$key] } } if (Test-Bound -ParameterName 'Property') { $clonedParameters['Property'] = $Property.Value } $wrappedCmd = $ExecutionContext.InvokeCommand.GetCommand('Microsoft.PowerShell.Utility\Select-Object', [System.Management.Automation.CommandTypes]::Cmdlet) $scriptCmd = { & $wrappedCmd @clonedParameters } $steppablePipeline = $scriptCmd.GetSteppablePipeline($myInvocation.CommandOrigin) $steppablePipeline.Begin($PSCmdlet) } catch { throw } } process { try { $steppablePipeline.Process($_) } catch { throw } } end { try { $steppablePipeline.End() } catch { throw } } } |