生成 API 操作 - Amazon DynamoDB
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 Amazon Web Services 服务入门

生成 API 操作

要使用 NoSQL Workbench 生成 DynamoDB CRUD API,请选择 NoSQL Workbench 右上角的 Interface-based operations(基于接口的操作)。

选择 Operations(操作)下拉列表,然后选择要生成的操作。

您可以在操作生成器中执行以下操作:

表操作

项目操作

表操作

删除表

要为 Delete Table 操作执行或生成代码,请执行以下操作。

  1. 从 Operations(操作)下拉列表中选择 Delete Table(删除表)。

  2. Table name(表名称)下拉列表中选择表。

  3. 如果要生成代码,请选择 Generate code (生成代码)

    选择所需语言的选项卡。现在,您便可复制此代码并在应用程序中使用它。

  4. 如果要立即执行操作,请选择 Run (执行)

    在出现的确认窗口中,通过输入表名称并选择 Delete(删除)予以确认。

    
                                显示 PutItem 操作生成器的控制台屏幕截图。

    操作结果将显示在屏幕底部的结果选项卡中。

有关此操作的更多信息,请参阅《Amazon DynamoDB API 参考》中的删除表

创建表

要为 Create Table 操作执行或生成代码,请执行以下操作。

  1. 从 Operations(操作)下拉列表中选择 Create Table(创建表)。

  2. 输入所需的表名称。

  3. 创建分区键。

  4. 根据需要配置表。您可以创建全局二级索引、启用弹性伸缩和其他选项。

  5. 要自定义容量设置,请转到 Capacity Settings(容量设置),然后取消选中 Default settings(原定设置)旁边的框。

    • 现在,您可以选择 Provisioned(已预置)或 On-demand capacity(按需容量)。

      选中 Provisioned(已预置)后,您可以设置最小和最大读取和写入容量单位。您还可以启用或禁用弹性伸缩。

    • 如果表当前设置为 onDemand(按需),您将无法指定预置吞吐量。

    • 如果您从 onDemand(按需)切换到 Provisioned(已预置)吞吐量,则弹性伸缩将自动应用于所有 GSI,其中,最小值:1,最大值:10;目标:70%。

  6. 如果要清除您所设定的所有新设置并重新开始,请选择 Clear form(清除表单)。

  7. 如果要生成代码,请选择 Generate code (生成代码)

    选择所需语言的选项卡。现在,您便可复制此代码并在应用程序中使用它。

  8. 如果要立即执行操作,请选择 Run (执行)

    操作结果将显示在屏幕底部的结果选项卡中。

  9. 如果要保存此操作以供以后使用,请选择 Save operation (保存操作),然后输入操作的名称,然后单击 Save (保存)

    
                                显示 PutItem 操作生成器的控制台屏幕截图。

有关此操作的更多信息,请参阅《Amazon DynamoDB API 参考》中的创建表

更新表

要为 Update Table 操作执行或生成代码,请执行以下操作:

  1. 从 Operations(操作)下拉列表中选择 Update Table(更新表)。

  2. Update operations(更新操作)下拉列表中选择所需操作。

  3. Table name(表名称)下拉列表中选择表。

  4. 根据需要更新选定的表。您可以创建 GSI、更新预置的吞吐量和其他选项。

  5. 如果您选择 Create GSI(创建 GSI)、Update Provisioned Throughput(更新预置吞吐量)或 Update Provisioned Throughput for GSI(更新 GSI 的预置吞吐量),将显示 Capacity settings(容量设置)选项。

  6. 要自定义容量设置,请转到 Capacity Settings(容量设置)。然后,取消选中对应于 Inherit capacity settings from base table(从基表继承容量设置)或 On-demand(按需)的选项。

    • 现在,您可以选择 Provisioned(已预置)或 On-demand capacity(按需容量)。

      选中 Provisioned(已预置)后,您可以设置最小和最大读取和写入容量单位。您还可以启用或禁用弹性伸缩。

    • 如果表当前设置为 onDemand(按需),您将无法指定预置吞吐量。

    • 如果您从 onDemand(按需)切换到 Provisioned(已预置)吞吐量,则弹性伸缩将自动应用于所有 GSI,其中,最小值:1,最大值:10;目标:70%。

  7. 如果要清除刚输入的设置并重新开始,则 Clear form(清除表单)。

  8. 如果要生成代码,请选择 Generate code (生成代码)

    选择所需语言的选项卡。现在,您便可复制此代码并在应用程序中使用它。

  9. 如果要立即执行操作,请选择 Run (执行)

    操作结果将显示在屏幕底部的结果选项卡中。

  10. 如果要保存此操作以供以后使用,请选择 Save operation (保存操作),然后输入操作的名称,然后单击 Save (保存)

    
                                显示 PutItem 操作生成器的控制台屏幕截图。

有关此操作的更多信息,请参阅《Amazon DynamoDB API 参考》中的更新表

项目操作

获取项目

要为 Get Item 操作执行或生成代码,请执行以下操作。

  1. 指定分区键值。

  2. 如果要添加投影表达式,请执行以下操作:

    1. 选择 Projection expression (投影表达式)

    2. 选择 Projection expression (投影表达式) 旁边的 +(加号)。

    3. 指定 Attribute name(属性名称)。

    
                                显示 GetItem 操作生成器的控制台屏幕截图。
  3. 如果要生成代码,请选择 Generate code (生成代码)

    从显示的选项卡中选择所需的语言。现在,您便可复制此代码并在应用程序中使用它。

  4. 如果要立即执行操作,请选择 Run (执行)

  5. 如果要保存此操作以供以后使用,请选择 Save operation (保存操作),然后输入操作的名称,然后单击 Save (保存)

有关此操作的更多信息,请参阅《Amazon DynamoDB API 参考》中的 GetItem

放置项目

要为 Put Item 操作执行或生成代码,请执行以下操作。

  1. 指定分区键值。

  2. 指定排序键值(如果存在)。

  3. 如果要添加非键属性,请执行以下操作:

    1. 选择 Other attributes (其他属性) 旁边的 +(加号)。

    2. 指定 Attribute name (属性名称)Type (类型)Value (值)

  4. 如果必须满足条件表达式 Put Item 操作才能成功,请执行以下操作:

    1. 选择 Condition (条件)

    2. 指定属性名称、比较运算符、属性类型和属性值。

    3. 如果需要其他条件,请再次选择 Condition (条件)

    有关更多信息,请参阅 条件表达式

    
                                显示 PutItem 操作生成器的控制台屏幕截图。
  5. 如果要生成代码,请选择 Generate code (生成代码)

    从显示的选项卡中选择所需的语言。现在,您便可复制此代码并在应用程序中使用它。

  6. 如果要立即执行操作,请选择 Run (执行)

  7. 如果要保存此操作以供以后使用,请选择 Save operation (保存操作),然后输入操作的名称,然后单击 Save (保存)

有关此操作的更多信息,请参见 Amazon DynamoDB API 参考PutItem

更新项目

要为 Update Item 操作执行或生成代码,请执行以下操作:

  1. 输入分区键值。

  2. 输入排序键值(如果存在)。

  3. Update expression (更新表达式) 中,选择列表中的表达式。

  4. 选择表达式的 +(加号)。

  5. 输入选定表达式的属性名称和属性值。

  6. 如果要添加更多表达式,请在 Update Expression (更新表达式) 下拉列表中选择另一个表达式,然后选择 +

  7. 如果必须满足条件表达式 Update Item 操作才能成功,请执行以下操作:

    1. 选择 Condition (条件)

    2. 指定属性名称、比较运算符、属性类型和属性值。

    3. 如果需要其他条件,请再次选择 Condition (条件)

    有关更多信息,请参阅条件表达式

    
                                显示 UpdateItem 操作生成器的控制台屏幕截图。
  8. 如果要生成代码,请选择 Generate code (生成代码)

    选择所需语言的选项卡。现在,您便可复制此代码并在应用程序中使用它。

  9. 如果要立即执行操作,请选择 Run (执行)

  10. 如果要保存此操作以供以后使用,请选择 Save operation (保存操作),然后输入操作的名称,然后单击 Save (保存)

有关此操作的更多信息,请参见 Amazon DynamoDB API 参考UpdateItem

删除项目

要为 Delete Item 操作执行或生成代码,请执行以下操作。

  1. 输入分区键值。

  2. 输入排序键值(如果存在)。

  3. 如果必须满足条件表达式 Delete Item 操作才能成功,请执行以下操作:

    1. 选择 Condition (条件)

    2. 指定属性名称、比较运算符、属性类型和属性值。

    3. 如果需要其他条件,请再次选择 Condition (条件)

    有关更多信息,请参阅 条件表达式

    
                                显示 DeleteItem 操作生成器的控制台屏幕截图。
  4. 如果要生成代码,请选择 Generate code (生成代码)

    选择所需语言的选项卡。现在,您便可复制此代码并在应用程序中使用它。

  5. 如果要立即执行操作,请选择 Run (执行)

  6. 如果要保存此操作以供以后使用,请选择 Save operation (保存操作),然后输入操作的名称,然后单击 Save (保存)

有关此操作的更多信息,请参见 Amazon DynamoDB API 参考DeleteItem

Query

要为 Query 操作执行或生成代码,请执行以下操作。

  1. 指定分区键值。

  2. 如果 Query 操作需要排序键,请执行以下操作:

    1. 选择 Sort key (排序键)

    2. 指定比较运算符、属性类型和属性值。

  3. 如果并非所有属性都应与操作结果一起返回,请选择 Projection expression (投影表达式)

  4. 选择 +(加号)。

  5. 输入要与查询结果一起返回的属性。

  6. 如果需要更多属性,请选择 +

  7. 如果必须满足条件表达式 Query 操作才能成功,请执行以下操作:

    1. 选择 Condition (条件)

    2. 指定属性名称、比较运算符、属性类型和属性值。

    3. 如果需要其他条件,请再次选择 Condition (条件)

    有关更多信息,请参阅条件表达式

    
                                显示查询操作生成器的控制台屏幕截图。
  8. 如果要生成代码,请选择 Generate code (生成代码)

    选择所需语言的选项卡。现在,您便可复制此代码并在应用程序中使用它。

  9. 如果要立即执行操作,请选择 Run (执行)

  10. 如果要保存此操作以供以后使用,请选择 Save operation (保存操作),然后输入操作的名称,然后单击 Save (保存)

有关此操作的更多信息,请参见 Amazon DynamoDB API 参考Query

Scan

要为 Scan 操作执行或生成代码,请执行以下操作。

  1. 如果并非所有属性都应与操作结果一起返回,请选择 Projection expression (投影表达式)

  2. 选择 +(加号)。

  3. 指定要与查询结果一起返回的属性。

  4. 如果需要更多属性,请再次选择 +

  5. 如果必须满足条件表达式扫描操作才能成功,请执行以下操作:

    1. 选择 Condition (条件)

    2. 指定属性名称、比较运算符、属性类型和属性值。

    3. 如果需要其他条件,请再次选择 Condition (条件)

    有关更多信息,请参阅 条件表达式

  6. 如果要生成代码,请选择 Generate code (生成代码)

    选择所需语言的选项卡。现在,您便可复制此代码并在应用程序中使用它。

  7. 如果要立即执行操作,请选择 Run (执行)

  8. 如果要保存此操作以供以后使用,请选择 Save operation (保存操作),然后输入操作的名称,然后单击 Save (保存)

TransactGetItems

要为 TransactGetItems 操作执行或生成代码,请执行以下操作。

  1. 选择 +(加号)。

  2. 按照 获取项目 操作的说明操作。

    指定完操作的详细信息后,如果要添加更多操作,选择 +(加号)。

    
                                显示 transactwriteitems 操作生成器中的加号按钮的控制台屏幕截图。

    要更改操作的顺序,请在左侧列表中选择一项操作,然后选择向上或向下箭头以在列表中将其上移或下移。

    要删除一项操作,请在列表中选择该操作,然后选择 Delete (删除)(垃圾桶)图标。

  3. 如果要生成代码,请选择 Generate code (生成代码)

    选择所需语言的选项卡。现在,您便可复制此代码并在应用程序中使用它。

  4. 如果要立即执行操作,请选择 Run (执行)

  5. 如果要保存此操作以供以后使用,请选择 Save operation (保存操作),然后输入操作的名称,然后单击 Save (保存)

有关事务的更多信息,请参阅 Amazon DynamoDB Transactions

TransactWriteItems

要为 TransactWriteItems 操作执行或生成代码,请执行以下操作。

  1. Actions (操作) 下拉列表中,选择所需的操作。

    • 对于 DeleteItem,按照 删除项目 操作的说明操作。

    • 对于 PutItem,按照 放置项目 操作的说明操作。

    • 对于 UpdateItem,按照 更新项目 操作的说明操作。

    指定完操作的详细信息后,选择 + 按钮。

    
                                显示 transactwriteitems 操作生成器中的加号按钮的控制台屏幕截图。

    要更改操作的顺序,请在左侧列表中选择一项操作,然后选择向上或向下箭头以在列表中将其上移或下移。

    要删除一项操作,请在列表中选择该操作,然后选择 Delete (删除)(垃圾桶)图标。

    
                                显示操作生成器中的向上箭头和向下箭头以及垃圾桶按钮的控制台屏幕截图。
  2. 如果要生成代码,请选择 Generate code (生成代码)

    选择所需语言的选项卡。现在,您便可复制此代码并在应用程序中使用它。

  3. 如果要立即执行操作,请选择 Run (执行)

  4. 如果要保存此操作以供以后使用,请选择 Save operation (保存操作),然后输入操作的名称,然后单击 Save (保存)

有关事务的更多信息,请参阅 Amazon DynamoDB Transactions