DynamoDB Helper

这个包提供了一个宏，该宏将生成一个用于与DynamoDB交互的结构体，而不需要通常所需的样板代码。

此项目类似于dynomite-derive 包。但是dynomite derive是基于一个非官方的Rust SDK rusoto，该SDK现在已经进入维护模式，而在这里使用的是官方SDK。

示例用法

use dynamodb_helper::DynamoDb;
use tokio_stream::StreamExt; // needed if the scan method is not excluded

#[derive(DynamoDb)]
struct ExampleStruct {
    #[partition]
    id: String,
    // other values
}

// thanks to the above derive, we can now create a db client
let db = ExampleStructDb::build(aws_sdk_dynamodb::Region::new("eu-west-1"), "exampleTable").await;

// the following will return an ExampleStruct if the id is found
let example_struct = db.get("someId".to_string()).await.expect("This one to exist");

#[derive(DynamoDb)]
struct OtherStruct {
    #[partition]
    id: String,
    #[range]
    range_id: String
    // other values
}

// alternative to build, we can use new and pass in a client
let other_db = OtherStructDb::new(a_dynamodb_client, "exampleTable");

// now we need to pass in both parts of the id
let other_struct = other_db.get("someId".to_string(), "someRange".to_string()).await.expect("This one to exist");
// or only the partition id, in which case we'll get back a Vec
let multiple_structs = other_db.get_by_partition_key("someId".to_string()).await.expect("This one to exist");

// and you can also put, delete, scan, etc.

还可以查看单元和集成测试。

请务必查看使用说明以及属性和方法概述。

使用说明

依赖项

这些依赖项是必需的

aws-config = "0.47.0"
aws-sdk-dynamodb = "0.17.0"

以及可能还需要tokio-stream依赖项（见下文）

StreamExt特质

如果您收到关于以下特质的错误警告“以下特质界限未满足：impl futures_core::stream::Stream<Item = Result<...> + Unpin: Iterator”，这可能是由于您使用了生成的扫描方法，该方法需要以下特质在作用域内（将其添加到您的文件导入中）

use tokio_stream::StreamExt;

并添加tokio-stream依赖项。或者，您可以选择排除扫描方法的生成。

宏细节

宏属性

• #[partition]应装饰将用作分区/散列键的字段
• #[range]可以可选放置在用作范围/排序键的字段上

生成的结构和方法

宏将实现以下特质

• TryFrom<HashMap<String, AttributeValue>> 用于您的结构体（因为如果DynamoDB中的数据与预期不符，这可能会失败）
• From<YourStruct> 用于 HashMap<String, AttributeValue> （应成功，因为它基于类型信息，尽管如果DynamoDB配置和数据不符合预期，可能会在后续失败）

宏还会生成一个名为带注释结构体名称加上后缀 Db 的结构体，具有以下方法（假设您的带注释结构体名为 ExampleStruct）

• fn new(client: aws_sdk_dynamodb::Client,table: &str) -> Self
• asyncfn build(region: aws_sdk_dynamodb::Region,table: &str) -> Self
• asyncfn create_table(&self) -> Result<CreateTableOutput, SdkError<CreateTableError>>
• asyncfn create_table_with_provisioned_throughput(&self, read_capacity: i64, write_capacity: i64) -> Result<CreateTableOutput, SdkError<CreateTableError>>
• asyncfn delete_table(&self) -> Result<DeleteTableOutput, SdkError<DeleteTableError>>
• fn get(&self, partition: String) -> Result<Option<ExampleStruct>, ExampleStructDbGetError> （自定义错误）
• fn get_by_partition_key(&self, partition: String) -> Result<Vec<ExampleStruct>, ExampleStructDbGetByPartitionError> （仅当您有复杂键时，例如分区加范围；自定义错误）
• fn batch_get(&self, keys: Vec<String>) -> Result<Vec<ExampleStruct>, ExampleStructDbBatchGetError> （自定义错误）
• async fn scan(&self) -> Result<Vec<ExampleStruct>, ExampleStructDbScanError> (自定义错误)
• asyncfn put(&self, 输入:ExampleStruct) -> Result<PutItemOutput, SdkError<PutItemError>>
• async fn batch_put(&self, items: Vec<ExampleStruct>) -> Result<BatchWriteItemOutput, SdkError<BatchWriteItemError>> (仅用于新条目)
• asyncfn delete(&self, 分区:String) -> Result<DeleteItemOutput, SdkError<DeleteItemError>>

pub enum ExampleStructDbScanError {
    ParseError(String),
    AwsError(aws_sdk_dynamodb::types::SdkError<aws_sdk_dynamodb::error::ScanError>),
}

#[derive(DynamoDb)]
#[exclusion("scan", "delete_table", "create_table")]
pub struct ExampleTestStruct {
    #[partition]
    partition_key: String,
    value: i32,
}