API DynamoDB - Amazon DynamoDB

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.

API DynamoDB

Pour opérer avec Amazon DynamoDB, votre application doit utiliser quelques opérations d'API simples. Voici un résumé de ces opérations, classées par catégorie.

Note

Pour obtenir la liste complète des opérations d'API, consultez la Référence API Amazon DynamoDB.

Plan de contrôle

Les opérations de plan de contrôle vous permettent de créer et gérer des tables DynamoDB. Elles vous permettent également d'utiliser les index, les flux et autres objets qui dépendent des tables.

  • CreateTable – Crée une table. Vous pouvez créer un ou plusieurs index secondaires, puis activer DynamoDB Streams pour la table.

  • DescribeTable – Retourne des informations sur une table, telles que son schéma de clé primaire, ses paramètres de débit et ses informations d'index.

  • ListTables – Renvoie les noms de toutes vos tables dans une liste.

  • UpdateTable – Modifie les paramètres d'une table ou de ses index, crée ou supprime de nouveaux index sur une table, ou modifie les paramètres DynamoDB Streams d'une table.

  • DeleteTable – Supprime une table et tous ses objets dépendants de DynamoDB.

Plan de données

Les opérations de plan de données vous permettent d'exécuter les opérations de création, lecture, mise à jour et suppression (également appelées opérations CRUD) sur les données d'une table. Certaines opérations de plan de données vous permettent également de lire les données d'un index secondaire.

Vous pouvez utiliserPartiQL – Langage de requête compatible SQL pour Amazon DynamoDB, pour effectuer ces opérations CRUD, ou vous pouvez utiliser le CRUD classique de DynamoDB APIs qui sépare chaque opération en un appel d'API distinct.

PartiQL – Langage de requête compatible SQL

  • ExecuteStatement – Lit plusieurs éléments d'une table. Vous pouvez également écrire ou mettre à jour un élément unique à partir d'une table. Lors de l'écriture ou de la mise à jour d'un élément unique, vous devez spécifier les attributs de clé primaire.

  • BatchExecuteStatement – Ecrit, met à jour ou lit plusieurs éléments d'une table. Cette solution est plus efficace que l'opération ExecuteStatement parce que votre application n'a besoin que d'un seul aller-retour réseau pour lire les éléments.

classique APIs

Création de données

  • PutItem – Ecrit un élément unique dans une table. Vous devez spécifier les attributs de clé primaire, mais vous n'avez pas à spécifier d'autres attributs.

  • BatchWriteItem – Ecrit jusqu'à 25 éléments dans une table. Cette solution est plus efficace que l'appel répété de PutItem parce que votre application a uniquement besoin d'un seul aller-retour réseau pour écrire les éléments.

Lecture de données

  • GetItem – Extrait un élément unique d'une table. Vous devez spécifier la clé primaire de l'élément que vous voulez. Vous pouvez récupérer l'élément entier ou juste un sous-ensemble de ses attributs.

  • BatchGetItem – Extrait jusqu'à 100 éléments d'une ou de plusieurs tables. Cette solution est plus efficace que l'appel répété de GetItem parce que votre application a uniquement besoin d'un seul aller-retour réseau pour lire les éléments.

  • Query – Extrait tous les éléments ayant une clé de partition spécifique. Vous devez spécifier la valeur de la clé de partition. Vous pouvez récupérer des éléments entiers, ou juste un sous-ensemble de leurs attributs. Le cas échéant, vous pouvez appliquer une condition aux valeurs de clé de tri, afin de récupérer uniquement un sous-ensemble des données ayant la même clé de partition. Vous pouvez utiliser cette opération sur une table, à condition que la table ait une clé de partition et une clé de tri. Vous pouvez également utiliser cette opération sur un index, à condition que l'index ait une clé de partition et une clé de tri.

  • Scan – Extrait tous les éléments de la table ou de l'index spécifiés. Vous pouvez récupérer des éléments entiers, ou juste un sous-ensemble de leurs attributs. Le cas échéant, vous pouvez appliquer une condition de filtre pour renvoyer uniquement les valeurs qui vous intéressent et ignorer les autres.

Mise à jour de données

  • UpdateItem – Modifie un ou plusieurs attributs dans un élément. Vous devez spécifier la clé primaire de l'élément que vous voulez modifier. Vous pouvez ajouter de nouveaux attributs et modifier ou supprimer des attributs existants. Vous pouvez également effectuer des mises à jour conditionnelles, afin que la mise à jour ne réussisse que lorsqu'une condition définie par l'utilisateur est remplie. Le cas échéant, vous pouvez mettre en place un compteur atomique, qui augmente ou diminue un attribut numérique sans interférer avec d'autres demandes d'écriture.

Suppression des données

  • DeleteItem – Supprime un élément unique d'une table. Vous devez spécifier la clé primaire de l'élément que vous voulez supprimer.

  • BatchWriteItem – Supprime jusqu'à 25 éléments d'une ou de plusieurs tables. Cette solution est plus efficace que l'appel répété de DeleteItem parce que votre application a uniquement besoin d'un seul aller-retour réseau pour supprimer les éléments.

    Note

    Vous pouvez utiliser BatchWriteItem pour créer des données et supprimer des données.

DynamoDB Streams

Les opérations DynamoDB Streams vous permettent d'activer ou de désactiver un flux sur une table, et d'autoriser l'accès aux registres de modification de données contenus dans un flux.

  • ListStreams – Retourne la liste de tous vos flux, ou simplement le flux d'une table spécifique.

  • DescribeStream – Retourne des informations sur un flux, telles que son Amazon Resource Name (ARN) et l'emplacement où votre application peut commencer à lire les tout premiers registres de flux.

  • GetShardIterator – Retourne un itérateur de partition, c'est-à-dire une structure de données que votre application utilise pour extraire les registres du flux.

  • GetRecords – Récupère un ou plusieurs registres de flux à l'aide d'un itérateur de partition donné.

Transactions

Les transactions offrent atomicité, cohérence, isolation et durabilité (ACID), ce qui permet de maintenir plus facilement l'exactitude des données dans vos applications.

Vous pouvez utiliserPartiQL – Langage de requête compatible SQL pour Amazon DynamoDB, pour effectuer des opérations transactionnelles, ou vous pouvez utiliser le CRUD classique de DynamoDB APIs qui sépare chaque opération en un appel d'API distinct.

PartiQL – Langage de requête compatible SQL

  • ExecuteTransaction— Une opération par lots qui permet d'effectuer des opérations CRUD sur plusieurs éléments à la fois dans et entre les tables avec un all-or-nothing résultat garanti.

classique APIs

  • TransactWriteItems— Une opération par lots qui permet d'PutUpdateeffectuer des Delete opérations sur plusieurs éléments à la fois dans et entre les tables avec un all-or-nothing résultat garanti.

  • TransactGetItems – Opération par lot qui permet d'effectuer des opérations Get pour extraire plusieurs éléments d'une ou de plusieurs tables.