Compare-Object
Compara dois conjuntos de objetos.
Syntax
Compare-Object
[-ReferenceObject] <PSObject[]>
[-DifferenceObject] <PSObject[]>
[-SyncWindow <Int32>]
[-Property <Object[]>]
[-ExcludeDifferent]
[-IncludeEqual]
[-PassThru]
[-Culture <String>]
[-CaseSensitive]
[<CommonParameters>]Description
O Compare-Object cmdlet compara dois conjuntos de objetos. Um conjunto de objetos é a referência e o outro conjunto de objetos é a diferença.
Compare-Object verifica se há métodos disponíveis para comparar um objeto inteiro. Se ele não conseguir encontrar um método adequado, ele chamará os métodos ToString() dos objetos de entrada e comparará os resultados da cadeia de caracteres. Você pode fornecer uma ou mais propriedades a serem usadas para comparação. Quando as propriedades são fornecidas, o cmdlet compara apenas os valores dessas propriedades.
O resultado da comparação indica se um valor de propriedade apareceu apenas no objeto de referência (<=) ou apenas no objeto de diferença (=>). Se o parâmetro IncludeEqual for usado, (==) indicará que o valor está em ambos os objetos.
Se a referência ou os objetos de diferença forem nulos ($null), Compare-Object gerará um erro de encerramento.
Alguns exemplos usam o splatting para reduzir o comprimento de linha dos exemplos de código. Para obter mais informações, consulte about_Splatting.
Exemplos
Exemplo 1 – Comparar o conteúdo de dois arquivos de texto
Este exemplo compara o conteúdo de dois arquivos de texto. O exemplo usa os dois arquivos de texto a seguir, com cada valor em uma linha separada.
Testfile1.txtcontém os valores: cachorro, esquilo e pássaro.Testfile2.txtcontém os valores: gato, pássaro e guaxinim.
A saída exibe apenas as linhas que são diferentes entre os arquivos. Testfile1.txt é o objeto de referência (<=) e Testfile2.txté o objeto de diferença (=>). Linhas com conteúdo que aparecem em ambos os arquivos não são exibidas.
Compare-Object -ReferenceObject (Get-Content -Path C:\Test\Testfile1.txt) -DifferenceObject (Get-Content -Path C:\Test\Testfile2.txt)
InputObject SideIndicator
----------- -------------
cat =>
racoon =>
dog <=
squirrel <=Exemplo 2 – Comparar cada linha de conteúdo e excluir as diferenças
Este exemplo usa os parâmetros IncludeEqual e ExcludeDifferent para comparar cada linha de conteúdo em dois arquivos de texto.
Como o comando usa o parâmetro ExcludeDifferent , a saída contém apenas linhas contidas em ambos os arquivos, conforme mostrado pelo SideIndicator (==).
$objects = @{
ReferenceObject = (Get-Content -Path C:\Test\Testfile1.txt)
DifferenceObject = (Get-Content -Path C:\Test\Testfile2.txt)
}
Compare-Object @objects -IncludeEqual -ExcludeDifferent
InputObject SideIndicator
----------- -------------
bird ==Exemplo 3 – Mostrar a diferença ao usar o parâmetro PassThru
Normalmente, Compare-Object retorna um tipo PSCustomObject com as seguintes propriedades:
- O InputObject que está sendo comparado
- A propriedade SideIndicator mostrando a qual objeto de entrada a saída pertence
Quando você usa o parâmetro PassThru , o tipo do objeto não é alterado, mas a instância do objeto retornado tem um NoteProperty adicionado chamado SideIndicator. SideIndicator mostra a qual objeto de entrada a saída pertence.
Os exemplos a seguir mostram os diferentes tipos de saída.
$a = $True
Compare-Object -IncludeEqual $a $a
(Compare-Object -IncludeEqual $a $a) | Get-Member
InputObject SideIndicator
----------- -------------
True ==
TypeName: System.Management.Automation.PSCustomObject
Name MemberType Definition
---- ---------- ----------
Equals Method bool Equals(System.Object obj)
GetHashCode Method int GetHashCode()
GetType Method type GetType()
ToString Method string ToString()
InputObject NoteProperty System.Boolean InputObject=True
SideIndicator NoteProperty string SideIndicator===
Compare-Object -IncludeEqual $a $a -PassThru
(Compare-Object -IncludeEqual $a $a -PassThru) | Get-Member
True
TypeName: System.Boolean
Name MemberType Definition
---- ---------- ----------
CompareTo Method int CompareTo(System.Object obj), int CompareTo(bool value), int IComparable.CompareTo(Syst
Equals Method bool Equals(System.Object obj), bool Equals(bool obj), bool IEquatable[bool].Equals(bool ot
GetHashCode Method int GetHashCode()
GetType Method type GetType()
GetTypeCode Method System.TypeCode GetTypeCode(), System.TypeCode IConvertible.GetTypeCode()
ToBoolean Method bool IConvertible.ToBoolean(System.IFormatProvider provider)
ToByte Method byte IConvertible.ToByte(System.IFormatProvider provider)
ToChar Method char IConvertible.ToChar(System.IFormatProvider provider)
ToDateTime Method datetime IConvertible.ToDateTime(System.IFormatProvider provider)
ToDecimal Method decimal IConvertible.ToDecimal(System.IFormatProvider provider)
ToDouble Method double IConvertible.ToDouble(System.IFormatProvider provider)
ToInt16 Method short IConvertible.ToInt16(System.IFormatProvider provider)
ToInt32 Method int IConvertible.ToInt32(System.IFormatProvider provider)
ToInt64 Method long IConvertible.ToInt64(System.IFormatProvider provider)
ToSByte Method sbyte IConvertible.ToSByte(System.IFormatProvider provider)
ToSingle Method float IConvertible.ToSingle(System.IFormatProvider provider)
ToString Method string ToString(), string ToString(System.IFormatProvider provider), string IConvertible.To
ToType Method System.Object IConvertible.ToType(type conversionType, System.IFormatProvider provider)
ToUInt16 Method ushort IConvertible.ToUInt16(System.IFormatProvider provider)
ToUInt32 Method uint IConvertible.ToUInt32(System.IFormatProvider provider)
ToUInt64 Method ulong IConvertible.ToUInt64(System.IFormatProvider provider)
TryFormat Method bool TryFormat(System.Span[char] destination, [ref] int charsWritten)
SideIndicator NoteProperty string SideIndicator===Ao usar PassThru, o tipo de objeto original (System.Boolean) é retornado. Observe como a saída exibida pelo formato padrão para objetos System.Boolean não exibiu a propriedade SideIndicator . No entanto, o objeto System.Boolean retornado tem o NoteProperty adicionado.
Exemplo 4 – Comparar dois objetos simples usando propriedades
Neste exemplo, comparamos duas cadeias de caracteres diferentes que têm o mesmo comprimento.
Compare-Object -ReferenceObject 'abc' -DifferenceObject 'xyz' -Property Length -IncludeEqual
Length SideIndicator
------ -------------
3 ==Exemplo 5 – Comparando objetos complexos usando propriedades
Este exemplo mostra o comportamento ao comparar objetos complexos. Neste exemplo, armazenamos dois objetos de processo diferentes para instâncias diferentes do PowerShell. Ambas as variáveis contêm objetos de processo com o mesmo nome. Quando os objetos são comparados sem especificar o parâmetro Property , o cmdlet considera os objetos iguais. Observe que o valor do InputObject é o mesmo que o resultado do método ToString( ). Como a classe System.Diagnostics.Process não tem a interface IComparable , o cmdlet converte os objetos em cadeias de caracteres e compara os resultados.
PS> Get-Process pwsh
NPM(K) PM(M) WS(M) CPU(s) Id SI ProcessName
------ ----- ----- ------ -- -- -----------
101 123.32 139.10 35.81 11168 1 pwsh
89 107.55 66.97 11.44 17600 1 pwsh
PS> $a = Get-Process -Id 11168
PS> $b = Get-Process -Id 17600
PS> $a.ToString()
System.Diagnostics.Process (pwsh)
PS> $b.ToString()
System.Diagnostics.Process (pwsh)
PS> Compare-Object $a $b -IncludeEqual
InputObject SideIndicator
----------- -------------
System.Diagnostics.Process (pwsh) ==
PS> Compare-Object $a $b -Property ProcessName, Id, CPU
ProcessName Id CPU SideIndicator
----------- -- --- -------------
pwsh 17600 11.4375 =>
pwsh 11168 36.203125 <=Quando você especifica as propriedades a serem comparadas, o cmdlet mostra as diferenças.
Exemplo 6 – Comparando objetos complexos que implementam IComparable
Se o objeto implementar IComparable, o cmdlet procurará maneiras de comparar os objetos. Se os objetos forem tipos diferentes, o objeto Difference será convertido no tipo do ReferenceObject , em seguida, comparado.
Neste exemplo, estamos comparando uma cadeia de caracteres com um objeto TimeSpan . No primeiro caso, a cadeia de caracteres é convertida em um TimeSpan para que os objetos sejam iguais.
Compare-Object ([TimeSpan]"0:0:1") "0:0:1" -IncludeEqual
InputObject SideIndicator
----------- -------------
00:00:01 ==
Compare-Object "0:0:1" ([TimeSpan]"0:0:1")
InputObject SideIndicator
----------- -------------
00:00:01 =>
0:0:1 <=No segundo caso, o TimeSpan é convertido em uma cadeia de caracteres para que o objeto seja diferente.
Parâmetros
-CaseSensitive
Indica que as comparações devem diferenciar maiúsculas de minúsculas.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Culture
Especifica a cultura a ser usada para as comparações.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DifferenceObject
Especifica os objetos que são comparados aos objetos de referência .
| Type: | PSObject[] |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ExcludeDifferent
Indica que esse cmdlet exibe apenas as características de objetos comparados que são iguais. As diferenças entre os objetos são descartadas.
Use ExcludeDifferent com IncludeEqual para exibir apenas as linhas que correspondem entre os objetos de referência e de diferença .
Se ExcludeDifferent for especificado sem IncludeEqual, não haverá saída.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-IncludeEqual
IncludeEqual exibe as correspondências entre os objetos de referência e diferença .
Por padrão, a saída também inclui as diferenças entre os objetos de referência e diferença .
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PassThru
Quando você usa o parâmetro PassThru , Compare-Object omite o wrapper PSCustomObject ao redor dos objetos comparados e retorna os objetos diferentes, inalterados.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Property
Especifica uma matriz de propriedades dos objetos de referência e diferença a serem comparados.
O valor do parâmetro Property pode ser uma nova propriedade calculada. A propriedade calculada pode ser um bloco de script ou uma tabela de hash. Pares chave-valor válidos são:
- Expressão –
<string>ou<script block>
Para obter mais informações, consulte about_Calculated_Properties.
| Type: | Object[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ReferenceObject
Especifica uma matriz de objetos usada como referência para comparação.
| Type: | PSObject[] |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SyncWindow
Especifica o número de objetos adjacentes que Compare-Object inspecionam ao procurar uma correspondência em uma coleção de objetos. Compare-Object examina objetos adjacentes quando ele não encontra o objeto na mesma posição em uma coleção. O valor padrão é [Int32]::MaxValue, o que significa que Compare-Object examina toda a coleção de objetos.
| Type: | Int32 |
| Position: | Named |
| Default value: | [Int32]::MaxValue |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Entradas
Você pode enviar um objeto pelo pipeline para o parâmetro DifferenceObject .
Saídas
None
Se o objeto de referência e o objeto de diferença forem iguais, não haverá saída, a menos que você use o parâmetro IncludeEqual .
Se os objetos forem diferentes, Compare-Object encapsula os objetos diferentes em um PSCustomObject wrapper com uma propriedade SideIndicator para referenciar as diferenças.
Quando você usa o parâmetro PassThru , o tipo do objeto não é alterado, mas a instância do objeto retornado tem um NoteProperty adicionado chamado SideIndicator. SideIndicator mostra a qual objeto de entrada a saída pertence.
Observações
Ao usar o parâmetro PassThru , a saída exibida no console pode não incluir a propriedade SideIndicator . A exibição de formato padrão da saída do tipo de objeto não Compare-Object inclui a propriedade SideIndicator . Para obter mais informações, consulte o Exemplo 3 neste artigo.