Le guide de API référence AWS SDK for JavaScript V3 décrit en détail toutes les API opérations de la AWS SDK for JavaScript version 3 (V3).

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Lecture et écriture d'un seul élément dans DynamoDB

Cet exemple de code Node.js présente :

Le scénario

Dans cet exemple, vous utilisez une série de modules Node.js pour lire et écrire un élément dans une table DynamoDB en utilisant les méthodes suivantes de la DynamoDB classe client :

Tâches préalables

Pour configurer et exécuter cet exemple, réalisez tout d'abord les tâches ci-après :

Écriture d'un élément

Créez un module Node.js nommé put-item.js. Assurez-vous de configurer le SDK comme indiqué précédemment, notamment en téléchargeant les clients et les packages requis. Pour accéder à DynamoDB, créez DynamoDB un objet de service client. Créez un JSON objet contenant les paramètres nécessaires pour ajouter un élément, qui, dans cet exemple, inclut le nom de la table et une carte qui définit les attributs à définir et les valeurs de chaque attribut. Appelez la PutItemCommand méthode de l'objet de service client DynamoDB.

import { PutItemCommand, DynamoDBClient } from "@aws-sdk/client-dynamodb";

const client = new DynamoDBClient({});

export const main = async () => {
  const command = new PutItemCommand({
    TableName: "Cookies",
    // For more information about data types,
    // see https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes and
    // https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Programming.LowLevelAPI.html#Programming.LowLevelAPI.DataTypeDescriptors
    Item: {
      Flavor: { S: "Chocolate Chip" },
      Variants: { SS: ["White Chocolate Chip", "Chocolate Chunk"] },
    },
  });

  const response = await client.send(command);
  console.log(response);
  return response;
};

Pour exécuter l'exemple, entrez ce qui suit à l'invite de commande.

node put-item.js

Cet exemple de code se trouve ici GitHub.

Mettre à jour un élément

Créez un module Node.js nommé update-item.js. Assurez-vous de configurer le SDK comme indiqué précédemment, notamment en téléchargeant les clients et les packages requis. Pour accéder à DynamoDB, créez DynamoDB un objet de service client. Créez un JSON objet contenant les paramètres nécessaires pour ajouter un élément, qui, dans cet exemple, inclut le nom de la table, la clé à mettre à jour et l'expression de date qui mappe les nouveaux noms d'attributs, ainsi que les valeurs de chaque nouvel attribut. Appelez la UpdateItemCommand méthode de l'objet de service client DynamoDB.

import { UpdateItemCommand, DynamoDBClient } from "@aws-sdk/client-dynamodb";

const client = new DynamoDBClient({});

export const main = async () => {
  const command = new UpdateItemCommand({
    TableName: "IceCreams",
    // For more information about data types,
    // see https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes and
    // https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Programming.LowLevelAPI.html#Programming.LowLevelAPI.DataTypeDescriptors
    Key: {
      Flavor: { S: "Vanilla" },
    },
    UpdateExpression: "set HasChunks = :chunks",
    ExpressionAttributeValues: {
      ":chunks": { BOOL: "false" },
    },
    ReturnValues: "ALL_NEW",
  });

  const response = await client.send(command);
  console.log(response);
  return response;
};

Pour exécuter l'exemple, entrez ce qui suit à l'invite de commande.

node update-item.js

Cet exemple de code se trouve ici GitHub.

Obtention d'un élément

Créez un module Node.js nommé get-item.js. Assurez-vous de configurer le SDK comme indiqué précédemment, notamment en téléchargeant les clients et les packages requis. Pour accéder à DynamoDB, créez DynamoDB un objet de service client. Pour déterminer l'élément à obtenir, vous devez fournir la valeur de la clé primaire de cet élément dans la table. Par défaut, la méthode GetItemCommand renvoie toutes les valeurs d'attribut définies pour l'élément. Pour obtenir uniquement un sous-ensemble de toutes les valeurs d'attribut possible, spécifiez une expression de projection.

Créez un JSON objet contenant les paramètres nécessaires pour obtenir un élément, qui, dans cet exemple, inclut le nom de la table, le nom et la valeur de la clé de l'élément que vous obtenez, ainsi qu'une expression de projection qui identifie l'attribut de l'élément que vous souhaitez récupérer. Appelez la GetItemCommand méthode de l'objet de service client DynamoDB.

L'exemple de code suivant extrait un élément d'une table avec une clé primaire composée uniquement d'une clé de partition et non d'une clé de partition et d'une clé de tri. Si la table possède une clé primaire composée d'une clé de partition et d'une clé de tri, vous devez également spécifier le nom et l'attribut de la clé de tri.

import { GetItemCommand, DynamoDBClient } from "@aws-sdk/client-dynamodb";

const client = new DynamoDBClient({});

export const main = async () => {
  const command = new GetItemCommand({
    TableName: "CafeTreats",
    // For more information about data types,
    // see https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes and
    // https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Programming.LowLevelAPI.html#Programming.LowLevelAPI.DataTypeDescriptors
    Key: {
      TreatId: { N: "101" },
    },
  });

  const response = await client.send(command);
  console.log(response);
  return response;
};

Pour exécuter l'exemple, entrez ce qui suit à l'invite de commande.

node get-item.js

Cet exemple de code se trouve ici GitHub.

Suppression d'un élément

Créez un module Node.js nommé delete-item.js. Assurez-vous de configurer le SDK comme indiqué précédemment, notamment en téléchargeant les clients et les packages requis. Pour accéder à DynamoDB, créez DynamoDB un objet de service client. Créez un JSON objet contenant les paramètres nécessaires pour supprimer un élément, qui, dans cet exemple, inclut le nom de la table ainsi que le nom clé et la valeur de l'élément que vous supprimez. Appelez la DeleteItemCommand méthode de l'objet de service client DynamoDB.

import { DeleteItemCommand, DynamoDBClient } from "@aws-sdk/client-dynamodb";

const client = new DynamoDBClient({});

export const main = async () => {
  const command = new DeleteItemCommand({
    TableName: "Drinks",
    // For more information about data types,
    // see https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes and
    // https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Programming.LowLevelAPI.html#Programming.LowLevelAPI.DataTypeDescriptors
    Key: {
      Name: { S: "Pumpkin Spice Latte" },
    },
  });

  const response = await client.send(command);
  console.log(response);
  return response;
};

Pour exécuter l'exemple, entrez ce qui suit à l'invite de commande.

node delete-item.js

Cet exemple de code se trouve ici GitHub.