Exemples de DynamoDB utilisant Tools for V4 PowerShell

Les exemples de code suivants vous montrent comment effectuer des actions et implémenter des scénarios courants à l'aide de la version Outils AWS pour PowerShell V4 avec DynamoDB.

Les actions sont des extraits de code de programmes plus larges et doivent être exécutées dans leur contexte. Alors que les actions vous indiquent comment appeler des fonctions de service individuelles, vous pouvez les voir en contexte dans leurs scénarios associés.

Chaque exemple inclut un lien vers le code source complet, où vous trouverez des instructions sur la façon de configurer et d'exécuter le code en contexte.

Rubriques

Actions

Actions

L'exemple de code suivant montre comment utiliserAdd-DDBIndexSchema.

Outils pour PowerShell V4

Exemple 1 : crée un TableSchema objet vide et y ajoute une nouvelle définition d'index secondaire local avant d'écrire l' TableSchema objet dans le pipeline.


$schema | Add-DDBIndexSchema -IndexName "LastPostIndex" -RangeKeyName "LastPostDateTime" -RangeKeyDataType "S" -ProjectionType "keys_only"
$schema = New-DDBTableSchema

Sortie :


AttributeSchema                             KeySchema                                   LocalSecondaryIndexSchema
---------------                             ---------                                   -------------------------
{LastPostDateTime}                          {}                                          {LastPostIndex}

Exemple 2 : ajoute une nouvelle définition d'index secondaire local à l' TableSchema objet fourni avant de réécrire l' TableSchema objet dans le pipeline. L' TableSchema objet peut également être fourni à l'aide du paramètre -Schema.


New-DDBTableSchema | Add-DDBIndexSchema -IndexName "LastPostIndex" -RangeKeyName "LastPostDateTime" -RangeKeyDataType "S" -ProjectionType "keys_only"

Sortie :


AttributeSchema                             KeySchema                                   LocalSecondaryIndexSchema
---------------                             ---------                                   -------------------------
{LastPostDateTime}                          {}                                          {LastPostIndex}

Pour plus de détails sur l'API, consultez DDBIndexAdd-Schema dans la référence des Outils AWS pour PowerShell applets de commande (V4).

L'exemple de code suivant montre comment utiliserAdd-DDBKeySchema.

Outils pour PowerShell V4

Exemple 1 : crée un TableSchema objet vide et y ajoute des entrées de définition de clé et d'attribut en utilisant les données clés spécifiées avant d'écrire l' TableSchema objet dans le pipeline. Le type de clé est déclaré « HASH » par défaut ; utilisez le KeyType paramètre - avec la valeur « RANGE » pour déclarer une clé de plage.


$schema = New-DDBTableSchema
$schema | Add-DDBKeySchema -KeyName "ForumName" -KeyDataType "S"

Sortie :


AttributeSchema                             KeySchema                                   LocalSecondaryIndexSchema
---------------                             ---------                                   -------------------------
{ForumName}                                 {ForumName}                                 {}

Exemple 2 : ajoute de nouvelles entrées de définition de clé et d'attribut à l' TableSchema objet fourni avant d'écrire l' TableSchema objet dans le pipeline. Le type de clé est déclaré « HASH » par défaut ; utilisez le KeyType paramètre - avec la valeur « RANGE » pour déclarer une clé de plage. L' TableSchema objet peut également être fourni à l'aide du paramètre -Schema.


New-DDBTableSchema | Add-DDBKeySchema -KeyName "ForumName" -KeyDataType "S"

Sortie :


AttributeSchema                             KeySchema                                   LocalSecondaryIndexSchema
---------------                             ---------                                   -------------------------
{ForumName}                                 {ForumName}                                 {}

Pour plus de détails sur l'API, consultez DDBKeyAdd-Schema dans la référence des Outils AWS pour PowerShell applets de commande (V4).

L'exemple de code suivant montre comment utiliserConvertFrom-DDBItem.

Outils pour PowerShell V4

Exemple 1 : ConvertFrom - DDBItem est utilisé pour convertir le résultat d'une table de hachage Get-DDBItem de AttributeValues DynamoDB en une table de hachage de types courants tels que string et double.


@{
    SongTitle = 'Somewhere Down The Road'
    Artist    = 'No One You Know'
} | ConvertTo-DDBItem

Get-DDBItem -TableName 'Music' -Key $key | ConvertFrom-DDBItem

Sortie :


Name                           Value
----                           -----
Genre                          Country
Artist                         No One You Know
Price                          1.94
CriticRating                   9
SongTitle                      Somewhere Down The Road
AlbumTitle                     Somewhat Famous

Pour plus de détails sur l'API, reportez-vous à la section ConvertFrom- DDBItem dans la référence des Outils AWS pour PowerShell applets de commande (V4).

L'exemple de code suivant montre comment utiliserConvertTo-DDBItem.

Outils pour PowerShell V4

Exemple 1 : exemple de conversion d'une table de hachage en dictionnaire de valeurs d'attributs DynamoDB.


@{
    SongTitle = 'Somewhere Down The Road'
    Artist    = 'No One You Know'
} | ConvertTo-DDBItem

Key       Value
---       -----
SongTitle Amazon.DynamoDBv2.Model.AttributeValue
Artist    Amazon.DynamoDBv2.Model.AttributeValue

Exemple 2 : exemple de conversion d'une table de hachage en dictionnaire de valeurs d'attributs DynamoDB.


@{
    MyMap        = @{
        MyString = 'my string'
    }
    MyStringSet  = [System.Collections.Generic.HashSet[String]]@('my', 'string')
    MyNumericSet = [System.Collections.Generic.HashSet[Int]]@(1, 2, 3)
    MyBinarySet  = [System.Collections.Generic.HashSet[System.IO.MemoryStream]]@(
        ([IO.MemoryStream]::new([Text.Encoding]::UTF8.GetBytes('my'))),
        ([IO.MemoryStream]::new([Text.Encoding]::UTF8.GetBytes('string')))
    )
    MyList1      = @('my', 'string')
    MyList2      = [System.Collections.Generic.List[Int]]@(1, 2)
    MyList3      = [System.Collections.ArrayList]@('one', 2, $true)
} | ConvertTo-DDBItem

Sortie :


Key          Value
---          -----
MyStringSet  Amazon.DynamoDBv2.Model.AttributeValue
MyList1      Amazon.DynamoDBv2.Model.AttributeValue
MyNumericSet Amazon.DynamoDBv2.Model.AttributeValue
MyList2      Amazon.DynamoDBv2.Model.AttributeValue
MyBinarySet  Amazon.DynamoDBv2.Model.AttributeValue
MyMap        Amazon.DynamoDBv2.Model.AttributeValue
MyList3      Amazon.DynamoDBv2.Model.AttributeValue

Pour plus de détails sur l'API, reportez-vous à la section ConvertTo- DDBItem dans la référence des Outils AWS pour PowerShell applets de commande (V4).

L'exemple de code suivant montre comment utiliserGet-DDBBatchItem.

Outils pour PowerShell V4

Exemple 1 : extrait l'élément SongTitle « Somewhere Down The Road » des tables DynamoDB « Music » et « Songs ».


$key = @{
    SongTitle = 'Somewhere Down The Road'
    Artist = 'No One You Know'
} | ConvertTo-DDBItem

$keysAndAttributes = New-Object Amazon.DynamoDBv2.Model.KeysAndAttributes
$list = New-Object 'System.Collections.Generic.List[System.Collections.Generic.Dictionary[String, Amazon.DynamoDBv2.Model.AttributeValue]]'
$list.Add($key)
$keysAndAttributes.Keys = $list

$requestItem = @{
    'Music' = [Amazon.DynamoDBv2.Model.KeysAndAttributes]$keysAndAttributes
    'Songs' = [Amazon.DynamoDBv2.Model.KeysAndAttributes]$keysAndAttributes
}

$batchItems = Get-DDBBatchItem -RequestItem $requestItem
$batchItems.GetEnumerator() | ForEach-Object {$PSItem.Value} | ConvertFrom-DDBItem

Sortie :


Name                           Value
----                           -----
Artist                         No One You Know
SongTitle                      Somewhere Down The Road
AlbumTitle                     Somewhat Famous
CriticRating                   10
Genre                          Country
Price                          1.94
Artist                         No One You Know
SongTitle                      Somewhere Down The Road
AlbumTitle                     Somewhat Famous
CriticRating                   10
Genre                          Country
Price                          1.94

Pour plus de détails sur l'API, reportez-vous BatchGetItemà la section Référence des Outils AWS pour PowerShell applets de commande (V4).

L'exemple de code suivant montre comment utiliserGet-DDBItem.

Outils pour PowerShell V4

Exemple 1 : renvoie l'élément DynamoDB avec la clé de partition et la SongTitle clé de tri Artist.


$key = @{
  SongTitle = 'Somewhere Down The Road'
  Artist = 'No One You Know'
} | ConvertTo-DDBItem

Get-DDBItem -TableName 'Music' -Key $key | ConvertFrom-DDBItem

Sortie :


Name                           Value
----                           -----
Genre                          Country
SongTitle                      Somewhere Down The Road
Price                          1.94
Artist                         No One You Know
CriticRating                   9
AlbumTitle                     Somewhat Famous

Pour plus de détails sur l'API, reportez-vous GetItemà la section Référence des Outils AWS pour PowerShell applets de commande (V4).

L'exemple de code suivant montre comment utiliserGet-DDBTable.

Outils pour PowerShell V4

Exemple 1 : renvoie les détails de la table spécifiée.


Get-DDBTable -TableName "myTable"

Pour plus de détails sur l'API, reportez-vous DescribeTableà la section Référence des Outils AWS pour PowerShell applets de commande (V4).

L'exemple de code suivant montre comment utiliserGet-DDBTableList.

Outils pour PowerShell V4

Exemple 1 : renvoie les détails de toutes les tables, en itérant automatiquement jusqu'à ce que le service indique qu'aucune autre table n'existe.


Get-DDBTableList

Pour plus de détails sur l'API, reportez-vous ListTablesà la section Référence des Outils AWS pour PowerShell applets de commande (V4).

L'exemple de code suivant montre comment utiliserInvoke-DDBQuery.

Outils pour PowerShell V4

Exemple 1 : invoque une requête qui renvoie des éléments DynamoDB avec les valeurs spécifiées et Artist. SongTitle


$invokeDDBQuery = @{
    TableName = 'Music'
    KeyConditionExpression = ' SongTitle = :SongTitle and Artist = :Artist'
    ExpressionAttributeValues = @{
        ':SongTitle' = 'Somewhere Down The Road'
        ':Artist' = 'No One You Know'
    } | ConvertTo-DDBItem
}
Invoke-DDBQuery @invokeDDBQuery | ConvertFrom-DDBItem

Sortie :


Name                           Value
----                           -----
Genre                          Country
Artist                         No One You Know
Price                          1.94
CriticRating                   9
SongTitle                      Somewhere Down The Road
AlbumTitle                     Somewhat Famous

Pour plus de détails sur l'API, consultez la section Reference des requêtes dans les Outils AWS pour PowerShell applets de commande (V4).

L'exemple de code suivant montre comment utiliserInvoke-DDBScan.

Outils pour PowerShell V4

Exemple 1 : renvoie tous les éléments de la table Musique.


Invoke-DDBScan -TableName 'Music' | ConvertFrom-DDBItem

Sortie :


Name                           Value
----                           -----
Genre                          Country
Artist                         No One You Know
Price                          1.94
CriticRating                   9
SongTitle                      Somewhere Down The Road
AlbumTitle                     Somewhat Famous
Genre                          Country
Artist                         No One You Know
Price                          1.98
CriticRating                   8.4
SongTitle                      My Dog Spot
AlbumTitle                     Hey Now

Exemple 2 : renvoie les éléments du tableau Musique dont le score est CriticRating supérieur ou égal à neuf.


$scanFilter = @{
        CriticRating = [Amazon.DynamoDBv2.Model.Condition]@{
            AttributeValueList = @(@{N = '9'})
            ComparisonOperator = 'GE'
        }
    }
    Invoke-DDBScan -TableName 'Music' -ScanFilter $scanFilter | ConvertFrom-DDBItem

Sortie :


Name                           Value
----                           -----
Genre                          Country
Artist                         No One You Know
Price                          1.94
CriticRating                   9
SongTitle                      Somewhere Down The Road
AlbumTitle                     Somewhat Famous

Pour plus de détails sur l'API, voir Scan in Outils AWS pour PowerShell Cmdlet Reference (V4).

L'exemple de code suivant montre comment utiliserNew-DDBTable.

Outils pour PowerShell V4

Exemple 1 : Cet exemple crée une table nommée Thread dont la clé primaire est composée de « ForumName » (hachage de type de clé) et de « Subject » (plage de types de clés). Le schéma utilisé pour construire la table peut être redirigé vers chaque applet de commande comme indiqué ou spécifié à l'aide du paramètre -Schema.


$schema = New-DDBTableSchema
$schema | Add-DDBKeySchema -KeyName "ForumName" -KeyDataType "S"
$schema | Add-DDBKeySchema -KeyName "Subject" -KeyType RANGE -KeyDataType "S"
$schema | New-DDBTable -TableName "Thread" -ReadCapacity 10 -WriteCapacity 5

Sortie :


AttributeDefinitions   : {ForumName, Subject}
TableName              : Thread
KeySchema              : {ForumName, Subject}
TableStatus            : CREATING
CreationDateTime       : 10/28/2013 4:39:49 PM
ProvisionedThroughput  : Amazon.DynamoDBv2.Model.ProvisionedThroughputDescription
TableSizeBytes         : 0
ItemCount              : 0
LocalSecondaryIndexes  : {}

Exemple 2 : Cet exemple crée une table nommée Thread dont la clé primaire est composée de « ForumName » (hachage de type de clé) et de « Subject » (plage de types de clés). Un index secondaire local est également défini. La clé de l'index secondaire local sera définie automatiquement à partir de la clé de hachage principale de la table (ForumName). Le schéma utilisé pour construire la table peut être redirigé vers chaque applet de commande comme indiqué ou spécifié à l'aide du paramètre -Schema.


$schema = New-DDBTableSchema
$schema | Add-DDBKeySchema -KeyName "ForumName" -KeyDataType "S"
$schema | Add-DDBKeySchema -KeyName "Subject" -KeyDataType "S"
$schema | Add-DDBIndexSchema -IndexName "LastPostIndex" -RangeKeyName "LastPostDateTime" -RangeKeyDataType "S" -ProjectionType "keys_only"
$schema | New-DDBTable -TableName "Thread" -ReadCapacity 10 -WriteCapacity 5

Sortie :


AttributeDefinitions   : {ForumName, LastPostDateTime, Subject}
TableName              : Thread
KeySchema              : {ForumName, Subject}
TableStatus            : CREATING
CreationDateTime       : 10/28/2013 4:39:49 PM
ProvisionedThroughput  : Amazon.DynamoDBv2.Model.ProvisionedThroughputDescription
TableSizeBytes         : 0
ItemCount              : 0
LocalSecondaryIndexes  : {LastPostIndex}

Exemple 3 : Cet exemple montre comment utiliser un pipeline unique pour créer une table nommée Thread qui possède une clé primaire composée de « ForumName » (hachage de type de clé) et de « Subject » (plage de types de clés) et un index secondaire local. Les options Add- DDBKey Schema et Add- DDBIndex Schema créent un nouvel TableSchema objet pour vous si aucun objet n'est fourni par le pipeline ou le paramètre -Schema.


New-DDBTableSchema |
  Add-DDBKeySchema -KeyName "ForumName" -KeyDataType "S" |
  Add-DDBKeySchema -KeyName "Subject" -KeyDataType "S" |
  Add-DDBIndexSchema -IndexName "LastPostIndex" `
                     -RangeKeyName "LastPostDateTime" `
                     -RangeKeyDataType "S" `
                     -ProjectionType "keys_only" |
  New-DDBTable -TableName "Thread" -ReadCapacity 10 -WriteCapacity 5

Sortie :


AttributeDefinitions   : {ForumName, LastPostDateTime, Subject}
TableName              : Thread
KeySchema              : {ForumName, Subject}
TableStatus            : CREATING
CreationDateTime       : 10/28/2013 4:39:49 PM
ProvisionedThroughput  : Amazon.DynamoDBv2.Model.ProvisionedThroughputDescription
TableSizeBytes         : 0
ItemCount              : 0
LocalSecondaryIndexes  : {LastPostIndex}

Pour plus de détails sur l'API, reportez-vous CreateTableà la section Référence des Outils AWS pour PowerShell applets de commande (V4).

L'exemple de code suivant montre comment utiliserNew-DDBTableSchema.

Outils pour PowerShell V4

Exemple 1 : crée un TableSchema objet vide prêt à accepter les définitions de clé et d'index à utiliser lors de la création d'une nouvelle table Amazon DynamoDB. L'objet renvoyé peut être redirigé vers les DDBTable applets de commande Add- DDBKey Schema, Add- DDBIndex Schema et New- ou leur être transmis à l'aide du paramètre -Schema de chaque applet de commande.


New-DDBTableSchema

Sortie :


AttributeSchema                             KeySchema                                   LocalSecondaryIndexSchema
---------------                             ---------                                   -------------------------
{}                                          {}                                          {}

Pour plus de détails sur l'API, consultez New- DDBTable Schema dans la référence des Outils AWS pour PowerShell applets de commande (V4).

L'exemple de code suivant montre comment utiliserRemove-DDBItem.

Outils pour PowerShell V4

Exemple 1 : Supprime l'élément DynamoDB correspondant à la clé fournie.


$key = @{
    SongTitle = 'Somewhere Down The Road'
    Artist = 'No One You Know'
} | ConvertTo-DDBItem
Remove-DDBItem -TableName 'Music' -Key $key -Confirm:$false

Pour plus de détails sur l'API, reportez-vous DeleteItemà la section Référence des Outils AWS pour PowerShell applets de commande (V4).

L'exemple de code suivant montre comment utiliserRemove-DDBTable.

Outils pour PowerShell V4

Exemple 1 : Supprime la table spécifiée. Vous êtes invité à confirmer avant que l'opération ne se poursuive.


Remove-DDBTable -TableName "myTable"

Exemple 2 : Supprime la table spécifiée. Aucune confirmation ne vous est demandée avant le début de l'opération.


Remove-DDBTable -TableName "myTable" -Force

Pour plus de détails sur l'API, reportez-vous DeleteTableà la section Référence des Outils AWS pour PowerShell applets de commande (V4).

L'exemple de code suivant montre comment utiliserSet-DDBBatchItem.

Outils pour PowerShell V4

Exemple 1 : crée un nouvel élément ou remplace un élément existant par un nouvel élément dans les tables DynamoDB Music et Songs.


$item = @{
    SongTitle = 'Somewhere Down The Road'
    Artist = 'No One You Know'
        AlbumTitle = 'Somewhat Famous'
        Price = 1.94
        Genre = 'Country'
        CriticRating = 10.0
} | ConvertTo-DDBItem

$writeRequest = New-Object Amazon.DynamoDBv2.Model.WriteRequest
$writeRequest.PutRequest = [Amazon.DynamoDBv2.Model.PutRequest]$item

Sortie :


$requestItem = @{
    'Music' = [Amazon.DynamoDBv2.Model.WriteRequest]($writeRequest)
    'Songs' = [Amazon.DynamoDBv2.Model.WriteRequest]($writeRequest)
}

Set-DDBBatchItem -RequestItem $requestItem

Pour plus de détails sur l'API, reportez-vous BatchWriteItemà la section Référence des Outils AWS pour PowerShell applets de commande (V4).

L'exemple de code suivant montre comment utiliserSet-DDBItem.

Outils pour PowerShell V4

Exemple 1 : crée un nouvel article ou remplace un article existant par un nouvel article.


$item = @{
  SongTitle = 'Somewhere Down The Road'
  Artist = 'No One You Know'
        AlbumTitle = 'Somewhat Famous'
        Price = 1.94
        Genre = 'Country'
        CriticRating = 9.0
} | ConvertTo-DDBItem
Set-DDBItem -TableName 'Music' -Item $item

Pour plus de détails sur l'API, reportez-vous PutItemà la section Référence des Outils AWS pour PowerShell applets de commande (V4).

L'exemple de code suivant montre comment utiliserUpdate-DDBItem.

Outils pour PowerShell V4

Exemple 1 : définit l'attribut genre sur « Rap » sur l'élément DynamoDB avec la clé de partition et la SongTitle clé de tri Artist.


$key = @{
    SongTitle = 'Somewhere Down The Road'
    Artist = 'No One You Know'
} | ConvertTo-DDBItem

$updateDdbItem = @{
    TableName = 'Music'
    Key = $key
    UpdateExpression = 'set Genre = :val1'
    ExpressionAttributeValue = (@{
        ':val1' = ([Amazon.DynamoDBv2.Model.AttributeValue]'Rap')
    })
}
Update-DDBItem @updateDdbItem

Sortie :


Name                           Value
----                           -----
Genre                          Rap

Pour plus de détails sur l'API, reportez-vous UpdateItemà la section Référence des Outils AWS pour PowerShell applets de commande (V4).

L'exemple de code suivant montre comment utiliserUpdate-DDBTable.

Outils pour PowerShell V4

Exemple 1 : met à jour le débit provisionné pour la table donnée.


Update-DDBTable -TableName "myTable" -ReadCapacity 10 -WriteCapacity 5

Pour plus de détails sur l'API, reportez-vous UpdateTableà la section Référence des Outils AWS pour PowerShell applets de commande (V4).

Avertissement JavaScript est désactivé ou n'est pas disponible dans votre navigateur.

Pour que vous puissiez utiliser la documentation AWS, Javascript doit être activé. Vous trouverez des instructions sur les pages d'aide de votre navigateur.

Conventions de rédaction

AWS DMS

Amazon EC2