about_Hash_Tables

Descripción breve

Describe cómo crear, usar y ordenar tablas hash en PowerShell.

Descripción larga

Una tabla hash, también conocida como diccionario o matriz asociativa, es una estructura de datos compacta que almacena uno o varios pares clave-valor. Por ejemplo, una tabla hash puede contener una serie de direcciones IP y nombres de equipo, donde las direcciones IP son las claves y los nombres de equipo son los valores, o viceversa.

En PowerShell, cada tabla hash es un objeto Hashtable (System.Collections.Hashtable). Puede usar las propiedades y los métodos de objetos Hashtable en PowerShell.

A partir de PowerShell 3.0, puede usar el atributo [ordenado] para crear un diccionario ordenado (System.Collections.Specialized.OrderedDictionary) en PowerShell.

Los diccionarios ordenados difieren de las tablas hash en que las claves siempre aparecen en el orden en que se enumeran. No se determina el orden de las claves de una tabla hash.

Las claves y el valor de las tablas hash también son objetos .NET. Suelen ser cadenas o enteros, pero pueden tener cualquier tipo de objeto. También puede crear tablas hash anidadas, en las que el valor de una clave es otra tabla hash.

Las tablas hash se usan con frecuencia porque son muy eficaces para buscar y recuperar datos. Puede usar tablas hash para almacenar listas y crear propiedades calculadas en PowerShell. Además, PowerShell tiene un cmdlet, ConvertFrom-StringData, que convierte cadenas en una tabla hash.

Sintaxis

La sintaxis de una tabla hash es la siguiente:

@{ <name> = <value>; [<name> = <value> ] ...}

La sintaxis de un diccionario ordenado es la siguiente:

[ordered]@{ <name> = <value>; [<name> = <value> ] ...}

El atributo [ordenado] se introdujo en PowerShell 3.0.

Creación de tablas hash

Para crear una tabla hash, siga estas instrucciones:

  • Comience la tabla hash con un signo at (@).
  • Incluya la tabla hash entre llaves ({}).
  • Escriba uno o varios pares clave-valor para el contenido de la tabla hash.
  • Use un signo igual (=) para separar cada clave de su valor.
  • Use un punto y coma (;) o un salto de línea para separar los pares clave-valor.
  • Las claves que contienen espacios deben ir entre comillas. Los valores deben ser expresiones válidas de PowerShell. Las cadenas deben aparecer entre comillas, aunque no incluyan espacios.
  • Para administrar la tabla hash, guárdela en una variable.
  • Al asignar una tabla hash ordenada a una variable, coloque el atributo [ordenado] delante del @ símbolo. Si lo coloca antes del nombre de la variable, se produce un error en el comando.

Para crear una tabla hash vacía en el valor de $hash, escriba:

$hash = @{}

También puede agregar claves y valores a una tabla hash al crearla. Por ejemplo, la siguiente instrucción crea una tabla hash con tres claves.

$hash = @{ Number = 1; Shape = "Square"; Color = "Blue"}

Crear diccionarios ordenados

Puede crear un diccionario ordenado agregando un objeto del tipo OrderedDictionary , pero la manera más fácil de crear un diccionario ordenado es usar el [ordered] atributo .

El [ordered] atributo se introduce en PowerShell 3.0.

Coloque el atributo inmediatamente antes del símbolo "@".

$hash = [ordered]@{ Number = 1; Shape = "Square"; Color = "Blue"}

Puede usar diccionarios ordenados de la misma manera que las tablas hash. Cualquier tipo se puede usar como valor de parámetros que toman una tabla hash o un diccionario (iDictionary).

No se puede usar el [ordered] atributo para convertir o convertir una tabla hash. Si coloca el atributo ordenado antes del nombre de la variable, el comando produce el siguiente mensaje de error.

[ordered]$hash = @{}
ParserError:
Line |
   1 |  [ordered]$hash = @{}
     |  ~~~~~~~~~~~~~~
     | The ordered attribute can be specified only on a hash literal node.

Para corregir la expresión, mueva el atributo [ordenado].

$hash = [ordered]@{}

Puede convertir un diccionario ordenado en una tabla hash, pero no puede recuperar el atributo ordenado, aunque borre la variable y escriba nuevos valores. Para volver a establecer el orden, debe quitar y volver a crear la variable.

[hashtable]$hash = [ordered]@{
  Number = 1; Shape = "Square"; Color = "Blue"}
$hash
Name                           Value
----                           -----
Color                          Blue
Shape                          Square
Number                         1

Mostrar tablas hash

Para mostrar una tabla hash que se guarda en una variable, escriba el nombre de la variable. De forma predeterminada, las tablas hash se muestran como una tabla con una columna para las claves y otra para los valores.

$hash
Name                           Value
----                           -----
Shape                          Square
Color                          Blue
Number                         1

Las tablas hash tienen propiedades Keys y Values. Use la notación de puntos para mostrar todas las claves o todos los valores.

$hash.keys
Number
Shape
Color
$hash.values
1
Square
Blue

Cada nombre de clave también es una propiedad de la tabla hash y su valor es el valor de la propiedad key-name. Use el siguiente formato para mostrar los valores de propiedad.

$hashtable.<key>
<value>

Por ejemplo:

$hash.Number
1

$hash.Color
Blue

Si el nombre de clave entra en conflicto con uno de los nombres de propiedad del tipo HashTable, puede usar PSBase para acceder a esas propiedades. Por ejemplo, si el nombre de la clave es keys y desea devolver la colección de Claves, use esta sintaxis:

$hashtable.PSBase.Keys

Las tablas hash tienen una propiedad Count que indica el número de pares clave-valor en la tabla hash.

$hash.count
3

Las tablas hash no son matrices, por lo que no puede usar un entero como índice en la tabla hash, pero puede usar un nombre de clave para indexar en la tabla hash. Si la clave es un valor de cadena, incluya el nombre de la clave entre comillas.

Por ejemplo:

$hash["Number"]
1

Agregar y quitar claves y valores

Para agregar claves y valores a una tabla hash, use el siguiente formato de comando.

$hash["<key>"] = "<value>"

Por ejemplo, para agregar una clave "Time" con un valor de "Now" a la tabla hash, use el siguiente formato de instrucción.

$hash["Time"] = "Now"

También puede agregar claves y valores a una tabla hash mediante el método Add del objeto System.Collections.Hashtable. El método Add tiene la siguiente sintaxis:

Add(Key, Value)

Por ejemplo, para agregar una clave "Time" con un valor de "Now" a la tabla hash, use el siguiente formato de instrucción.

$hash.Add("Time", "Now")

Además, puede agregar claves y valores a una tabla hash mediante el operador de suma (+) para agregar una tabla hash a una tabla hash existente. Por ejemplo, la siguiente instrucción agrega una clave "Time" con un valor de "Now" a la tabla hash de la variable $hash.

$hash = $hash + @{Time="Now"}

También puede agregar valores almacenados en variables.

$t = "Today"
$now = (Get-Date)

$hash.Add($t, $now)

No puede usar un operador de resta para quitar un par clave-valor de una tabla hash, pero puede usar el método Remove del objeto Hashtable. El método Remove toma la clave como su valor.

El método Remove tiene la sintaxis siguiente:

Remove(Key)

Por ejemplo, para quitar el par clave-valor Time=Now de la tabla hash en el valor de la variable $hash, escriba:

$hash.Remove("Time")

Puede usar todas las propiedades y métodos de objetos Hashtable en PowerShell, incluidos Contains, Clear, Clone y CopyTo. Para obtener más información sobre los objetos Hashtable, vea System.Collections.Hashtable.

Tipos de objeto en HashTables

Las claves y los valores de una tabla hash pueden tener cualquier tipo de objeto .NET y una sola tabla hash puede tener claves y valores de varios tipos.

La instrucción siguiente crea una tabla hash de cadenas de nombre de proceso y valores de objeto de proceso y la guarda en la $p variable .

$p = @{"PowerShell" = (Get-Process PowerShell);
"Notepad" = (Get-Process notepad)}

Puede mostrar la tabla hash en $p y usar las propiedades key-name para mostrar los valores.

$p

Name                           Value
----                           -----
PowerShell                     System.Diagnostics.Process (PowerShell)
Notepad                        System.Diagnostics.Process (notepad)

$p.PowerShell

Handles  NPM(K)    PM(K)      WS(K) VM(M)   CPU(s)     Id ProcessName
-------  ------    -----      ----- -----   ------     -- -----------
    441      24    54196      54012   571     5.10   1788 PowerShell

$p.keys | foreach {$p.$_.handles}
441
251

Las claves de una tabla hash también pueden ser cualquier tipo de .NET. La siguiente instrucción agrega un par clave-valor a la tabla hash de la $p variable . La clave es un objeto Service que representa el servicio WinRM y el valor es el estado actual del servicio.

$p = $p + @{(Get-Service WinRM) = ((Get-Service WinRM).Status)}

Puede mostrar y acceder al nuevo par clave-valor mediante los mismos métodos que se usan para otros pares de la tabla hash.

$p

Name                           Value
----                           -----
PowerShell                     System.Diagnostics.Process (PowerShell)
Notepad                        System.Diagnostics.Process (notepad)
System.ServiceProcess.Servi... Running

$p.keys
PowerShell
Notepad

Status   Name               DisplayName
------   ----               -----------
Running  winrm              Windows Remote Management (WS-Manag...

$p.keys | foreach {$_.name}
winrm

Las claves y los valores de una tabla hash también pueden ser objetos Hashtable. La siguiente instrucción agrega el par clave-valor a la tabla hash de la variable en la $p que la clave es una cadena, Hash2 y el valor es una tabla hash con tres pares clave-valor.

$p = $p + @{"Hash2"= @{a=1; b=2; c=3}}

Puede mostrar y acceder a los nuevos valores mediante los mismos métodos.

$p

Name                           Value
----                           -----
PowerShell                     System.Diagnostics.Process (PowerShell)
Notepad                        System.Diagnostics.Process (notepad)
System.ServiceProcess.Servi... Running
Hash2                          {a, b, c}

$p.Hash2

Name                           Value
----                           -----
a                              1
b                              2
c                              3

$p.Hash2.b
2

Ordenar claves y valores

Los elementos de una tabla hash no están ordenados intrínsecamente. Los pares clave-valor pueden aparecer en un orden diferente cada vez que se muestran.

Aunque no puede ordenar una tabla hash, puede usar el método GetEnumerator de tablas hash para enumerar las claves y los valores y, a continuación, usar el cmdlet Sort-Object para ordenar los valores enumerados para mostrar.

Por ejemplo, los siguientes comandos enumeran las claves y los valores de la tabla hash de la $p variable y, a continuación, ordenan las claves en orden alfabético.

$p.GetEnumerator() | Sort-Object -Property key

Name                           Value
----                           -----
Notepad                        System.Diagnostics.Process (notepad)
PowerShell                     System.Diagnostics.Process (PowerShell)
System.ServiceProcess.Servi... Running

El comando siguiente usa el mismo procedimiento para ordenar los valores hash en orden descendente.

$p.getenumerator() | Sort-Object -Property Value -Descending

Name                           Value
----                           -----
PowerShell                     System.Diagnostics.Process (PowerShell)
Notepad                        System.Diagnostics.Process (notepad)
System.ServiceProcess.Servi... Running

Creación de objetos a partir de tablas hash

A partir de PowerShell 3.0, puede crear un objeto a partir de una tabla hash de propiedades y valores de propiedad.

La sintaxis es la siguiente:

[<class-name>]@{
  <property-name>=<property-value>
  <property-name>=<property-value>
}

Este método solo funciona para las clases que tienen un constructor NULL, es decir, un constructor que no tiene parámetros. Las propiedades del objeto deben ser públicas y configurables.

Para obtener más información, consulte about_Object_Creation.

ConvertFrom-StringData

El ConvertFrom-StringData cmdlet convierte una cadena o una cadena de pares clave-valor en una tabla hash. Puede usar el ConvertFrom-StringData cmdlet de forma segura en la sección Datos de un script y puede usarlo con el Import-LocalizedData cmdlet para mostrar mensajes de usuario en la referencia cultural de la interfaz de usuario (UI) del usuario actual.

Las cadenas aquí son especialmente útiles cuando los valores de la tabla hash incluyen comillas. Para obtener más información sobre las cadenas aquí, consulte about_Quoting_Rules.

En el ejemplo siguiente se muestra cómo crear una cadena here-string de los mensajes de usuario en el ejemplo anterior y cómo usar ConvertFrom-StringData para convertirlos de una cadena en una tabla hash.

El siguiente comando crea una cadena aquí de los pares clave-valor y, a continuación, la guarda en la $string variable .

$string = @"
Msg1 = Type "Windows".
Msg2 = She said, "Hello, World."
Msg3 = Enter an alias (or "nickname").
"@

Este comando usa el ConvertFrom-StringData cmdlet para convertir la cadena here en una tabla hash.

ConvertFrom-StringData $string

Name                           Value
----                           -----
Msg3                           Enter an alias (or "nickname").
Msg2                           She said, "Hello, World."
Msg1                           Type "Windows".

Para obtener más información sobre las cadenas aquí, consulte about_Quoting_Rules.

Vea también