BatchGetItem - AWS AppSync
BatchGetItem champs

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.

BatchGetItem

Le document de mappage des demandes vous permet de BatchGetItem demander au résolveur AWS AppSync DynamoDB d'envoyer une BatchGetItem demande à DynamoDB pour récupérer plusieurs éléments, éventuellement sur plusieurs tables. Pour ce modèle de requête, vous devez spécifier les valeurs suivantes :

  • Les noms de tables à partir desquels récupérer les éléments

  • Les clés des éléments à récupérer dans chaque table

Les limites BatchGetItem DynamoDB s'appliquent et aucune expression de condition ne peut être fournie.

Le document de mappage BatchGetItem a la structure suivante :

{
    "version" : "2018-05-29",
    "operation" : "BatchGetItem",
    "tables" : {
        "table1": {
           "keys": [
              ## Item to retrieve Key
              {
                   "foo" : ... typed value,
                   "bar" : ... typed value
              },
              ## Item2 to retrieve Key
              {
                   "foo" : ... typed value,
                   "bar" : ... typed value
              }
            ],
            "consistentRead": true|false,            
            "projection" : {
                 ...
            }
        },
        "table2": {
           "keys": [
              ## Item3 to retrieve Key
              {
                   "foo" : ... typed value,
                   "bar" : ... typed value
              },
              ## Item4 to retrieve Key
              {
                   "foo" : ... typed value,
                   "bar" : ... typed value
              }
            ],
            "consistentRead": true|false,
            "projection" : {
                 ...
            }
        }
    }
}

Les champs sont définis comme suit :

BatchGetItem champs

version

Version de la définition du modèle. Seule la clause 2018-05-29 est prise en charge. Cette valeur est obligatoire.

operation

L'opération DynamoDB à effectuer. Pour que vous puissiez effectuer l'opération DynamoDB BatchGetItem, ce champ doit être défini sur BatchGetItem. Cette valeur est obligatoire.

tables

Les tables DynamoDB à partir desquelles récupérer les éléments. La valeur est une carte où les noms de table sont spécifiés en tant que clés de la carte. Vous devez fournir au moins une table. Cette valeur tables est obligatoire.

keys

Liste des clés DynamoDB représentant la clé primaire des éléments à récupérer. Les éléments DynamoDB peuvent avoir une seule clé de hachage ou une clé de hachage et une clé de tri, selon la structure de la table. Pour plus d'informations sur la façon de spécifier une « valeur saisie », voir Système de types (mappage des demandes).

consistentRead

S'il faut utiliser une lecture cohérente lors de l'exécution d'une GetItemopération. Cette valeur est facultative et est définie comme faux par défaut.

projection

Projection utilisée pour spécifier les attributs à renvoyer par l'opération DynamoDB. Pour plus d'informations sur les projections, voir Projections. Ce champ est facultatif.

Objets à mémoriser :

  • Si un élément n'a pas été récupéré à partir de la table, un élément null s'affiche dans le bloc de données pour cette table.

  • Les résultats d'invocation sont triés par table, en fonction de l'ordre dans lequel ils ont été fournis dans le modèle de mappage des demandes.

  • Chaque Get commande contenue dans a BatchGetItem est atomique, mais un lot peut être partiellement traité. Si un lot est partiellement traité en raison d'une erreur, les clés non traitées sont renvoyées dans le cadre du résultat de l'appel à l'intérieur du unprocessedKeysbloc.

  • BatchGetItem est limité à 100 clés.

Pour l'exemple de modèle de mappage de requête suivant :

{
  "version": "2018-05-29",
  "operation": "BatchGetItem",
  "tables": {
    "authors": [
        {
          "author_id": {
            "S": "a1"
          }
        },
    ],
    "posts": [
        {
          "author_id": {
            "S": "a1"
          },
          "post_id": {
            "S": "p2"
          }
        }
    ],
  }
}

Le résultat de l'appel disponible dans $ctx.result est le suivant :

{
   "data": {
     "authors": [null],
     "posts": [
        # Was retrieved
        {
          "author_id": "a1",
          "post_id": "p2",
          "post_title": "title",
          "post_description": "description",
        }
     ]
   },
   "unprocessedKeys": {
     "authors": [
        # This item was not processed due to an error
        {
          "author_id": "a1"
        }
      ],
     "posts": []
   }
}

$ctx.error contient des détails sur l'erreur. La présence des clés unprocessedKeys, des données et de chaque clé de table fournie dans le modèle de mappage des demandes est garantie dans le résultat de l'appel. Les éléments ayant été supprimés apparaissent dans le bloc de données. Les éléments qui n'ont pas été traités sont marqués comme nuls dans le bloc de données et sont placés à l'intérieur du unprocessedKeysbloc.

Pour un exemple plus complet, suivez le didacticiel DynamoDB Batch avec ici AppSync Tutoriel : Résolveurs de lots DynamoDB.