BatchDeleteItem - AWS AppSync
BatchDeleteItem 字段

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

BatchDeleteItem

BatchDeleteItem请求映射文档允许您告诉 D AWS AppSync ynamoDB 解析器向 DynamoDB BatchWriteItem 请求删除多个项目，可能跨多个表。对于此请求模板，您必须指定以下各项：

  • 要从中删除项目的表名称

  • 要从每个表中删除的项目的键

DynamoDB BatchWriteItem 限制适用，并且无法提供任何条件表达式。

BatchDeleteItem 映射文档具有以下结构：

{
    "version" : "2018-05-29",
    "operation" : "BatchDeleteItem",
    "tables" : {
        "table1": [
        ## Item to delete Key
        {
             "foo" : ... typed value,
             "bar" : ... typed value
        },
        ## Item2 to delete Key
        {
             "foo" : ... typed value,
             "bar" : ... typed value
        }],
        "table2": [
        ## Item3 to delete Key
        {
             "foo" : ... typed value,
             "bar" : ... typed value
        },
        ## Item4 to delete Key
        {
             "foo" : ... typed value,
             "bar" : ... typed value
        }],
    }
}

字段定义如下：

BatchDeleteItem 字段

version

模板定义版本。仅支持 2018-05-29。该值为必填项。

operation

要执行的 DynamoDB 操作。要执行 BatchDeleteItem DynamoDB 操作，该字段必须设置为 BatchDeleteItem。该值为必填项。

tables

要从中删除项目的 DynamoDB 表。每个表是 DynamoDB 键列表，表示要删除的项目的主键。DynamoDB 项目可能具有单个哈希键，也可能具有哈希键和排序键，具体取决于表结构。有关如何指定“类型化值”的更多信息，请参阅类型系统（请求映射）。必须提供至少一个表。tables 值是必需的。

要记住的事项：

  • 与 DeleteItem 操作相反，响应中不会返回完全删除的项目。只返回传递的键。

  • 如果尚未从表中删除某个项目，null 元素将显示在该表的数据块中。

  • 根据在请求映射模板中提供调用结果的顺序，将按表对这些结果进行排序。

  • BatchDeleteItem 中的每个 Delete 命令都是原子性的。但是，可以部分处理一个批处理。如果由于错误而部分处理了批次，则未处理的密钥将作为区块内部调用结果的一部分返回。unprocessedKeys

  • BatchDeleteItem 限制为 25 个键。

  • 与冲突检测一起使用时，不支持此操作。同时使用两者可能会导致错误。

对于以下示例请求映射模板：

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

$ctx.result 中可用的调用结果如下所示：

{
   "data": {
     "authors": [null],
     "posts": [
        # Was deleted
        {
          "author_id": "a1",
          "post_id": "p2"
        }
     ]
   },
   "unprocessedKeys": {
     "authors": [
        # This key was not processed due to an error
        {
          "author_id": "a1"
        }
      ],
     "posts": []
   }
}

$ctx.error 包含有关该错误的详细信息。请求映射模板中提供的密钥unprocessedKeys、数据、和每个表键都保证出现在调用结果中。已删除的项目存在于数据块中。尚未处理的项目在数据块内被标记为空并放置在数据unprocessedKeys块内。

要获得更完整的示例，请按照 DynamoDB 批处理教程进行操作，这里有 AppSync 教程：Dynamo DB 批处理解析器。