1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
use aws_sdk_dynamodb::{
operation::update_item::UpdateItemOutput,
types::AttributeValue,
};
use serde::Serialize;
use std::collections::HashMap;
use crate::error::{Error, Result};
use super::DynamoDbStore;
impl DynamoDbStore {
/// Updates an item in a DynamoDB table using low-level HashMap API.
///
/// This method allows you to modify attributes of an existing item or add new attributes
/// using update expressions. It provides fine-grained control over how items are updated.
///
/// # Arguments
///
/// * `table_name` - The name of the DynamoDB table
/// * `key` - A HashMap containing the primary key attributes that identify the item to update
/// * `update_expression` - A string that defines how to update the item (e.g., "SET #name = :name, #age = :age")
/// * `expression_attribute_values` - Optional HashMap mapping placeholder values in the update expression (e.g., ":name") to AttributeValues
/// * `expression_attribute_names` - Optional HashMap mapping placeholder names in the update expression (e.g., "#name") to actual attribute names
///
/// # Returns
///
/// Returns `Ok(UpdateItemOutput)` on success, containing the response from DynamoDB.
///
/// # Errors
///
/// Returns an error if:
/// - The table name is empty
/// - The key map is empty
/// - The update expression is empty
/// - AWS credentials are not properly configured
/// - The specified table does not exist
/// - The key does not match the table's key schema
/// - The update expression is invalid
/// - Network connectivity issues occur
/// - IAM permissions are insufficient
///
/// # Example
///
/// ```rust,no_run
/// use clean_dynamodb_store::DynamoDbStore;
/// use aws_sdk_dynamodb::types::AttributeValue;
/// use std::collections::HashMap;
///
/// #[tokio::main]
/// async fn main() -> Result<(), Box<dyn std::error::Error>> {
/// let store = DynamoDbStore::new().await?;
///
/// // Define the key
/// let mut key = HashMap::new();
/// key.insert("id".to_string(), AttributeValue::S("user123".to_string()));
///
/// // Define the update expression
/// let update_expression = "SET #name = :name, age = :age".to_string();
///
/// // Define expression attribute values
/// let mut values = HashMap::new();
/// values.insert(":name".to_string(), AttributeValue::S("John Doe".to_string()));
/// values.insert(":age".to_string(), AttributeValue::N("31".to_string()));
///
/// // Define expression attribute names (for reserved keywords)
/// let mut names = HashMap::new();
/// names.insert("#name".to_string(), "name".to_string());
///
/// store.update_item(
/// "users",
/// key,
/// update_expression,
/// Some(values),
/// Some(names),
/// ).await?;
///
/// Ok(())
/// }
/// ```
///
/// # Example with ADD operation
///
/// ```rust,no_run
/// use clean_dynamodb_store::DynamoDbStore;
/// use aws_sdk_dynamodb::types::AttributeValue;
/// use std::collections::HashMap;
///
/// #[tokio::main]
/// async fn main() -> Result<(), Box<dyn std::error::Error>> {
/// let store = DynamoDbStore::new().await?;
///
/// let mut key = HashMap::new();
/// key.insert("id".to_string(), AttributeValue::S("user123".to_string()));
///
/// // Increment a counter
/// let update_expression = "ADD login_count :inc".to_string();
///
/// let mut values = HashMap::new();
/// values.insert(":inc".to_string(), AttributeValue::N("1".to_string()));
///
/// store.update_item("users", key, update_expression, Some(values), None).await?;
///
/// Ok(())
/// }
/// ```
pub async fn update_item(
&self,
table_name: &str,
key: HashMap<String, AttributeValue>,
update_expression: String,
expression_attribute_values: Option<HashMap<String, AttributeValue>>,
expression_attribute_names: Option<HashMap<String, String>>,
) -> Result<UpdateItemOutput> {
Self::validate_table_name(table_name)?;
Self::validate_not_empty(&key, "Key")?;
if update_expression.trim().is_empty() {
return Err(Error::Validation("Update expression cannot be empty".to_string()));
}
let result = self
.client
.update_item()
.table_name(table_name)
.set_key(Some(key))
.update_expression(update_expression)
.set_expression_attribute_values(expression_attribute_values)
.set_expression_attribute_names(expression_attribute_names)
.send()
.await
.map_err(|e| Error::AwsSdk(Box::new(e.into())))?;
Ok(result)
}
/// Updates an item using a type-safe key struct.
///
/// This is a higher-level alternative to [`update_item`](Self::update_item) that works with
/// any key type implementing [`Serialize`]. The key struct is automatically converted to
/// DynamoDB's AttributeValue format using `serde_dynamo`.
///
/// # Type Parameters
///
/// * `K` - Any type that implements [`Serialize`] representing the primary key
///
/// # Arguments
///
/// * `table_name` - The name of the DynamoDB table
/// * `key` - A reference to the key struct identifying the item to update
/// * `update_expression` - A string that defines how to update the item
/// * `expression_attribute_values` - Optional HashMap mapping placeholder values in the update expression
/// * `expression_attribute_names` - Optional HashMap mapping placeholder names in the update expression
///
/// # Returns
///
/// Returns `Ok(UpdateItemOutput)` on success, containing the response from DynamoDB.
///
/// # Errors
///
/// Returns an error if:
/// - The table name is empty
/// - The update expression is empty
/// - Key serialization fails
/// - AWS credentials are not properly configured
/// - The specified table does not exist
/// - The update expression is invalid
/// - Network connectivity issues occur
/// - IAM permissions are insufficient
///
/// # Example
///
/// ```rust,no_run
/// use clean_dynamodb_store::DynamoDbStore;
/// use aws_sdk_dynamodb::types::AttributeValue;
/// use serde::Serialize;
/// use std::collections::HashMap;
///
/// #[derive(Serialize)]
/// struct UserKey {
/// id: String,
/// }
///
/// #[tokio::main]
/// async fn main() -> Result<(), Box<dyn std::error::Error>> {
/// let store = DynamoDbStore::new().await?;
///
/// let key = UserKey {
/// id: "user123".to_string(),
/// };
///
/// let update_expression = "SET #name = :name, age = :age".to_string();
///
/// let mut values = HashMap::new();
/// values.insert(":name".to_string(), AttributeValue::S("Jane Doe".to_string()));
/// values.insert(":age".to_string(), AttributeValue::N("28".to_string()));
///
/// let mut names = HashMap::new();
/// names.insert("#name".to_string(), "name".to_string());
///
/// store.update(
/// "users",
/// &key,
/// update_expression,
/// Some(values),
/// Some(names),
/// ).await?;
///
/// Ok(())
/// }
/// ```
///
/// # Example with conditional update
///
/// ```rust,no_run
/// use clean_dynamodb_store::DynamoDbStore;
/// use aws_sdk_dynamodb::types::AttributeValue;
/// use serde::Serialize;
/// use std::collections::HashMap;
///
/// #[derive(Serialize)]
/// struct UserKey {
/// id: String,
/// }
///
/// #[tokio::main]
/// async fn main() -> Result<(), Box<dyn std::error::Error>> {
/// let store = DynamoDbStore::new().await?;
///
/// let key = UserKey { id: "user123".to_string() };
///
/// // Increment counter only
/// let update_expression = "ADD view_count :inc".to_string();
///
/// let mut values = HashMap::new();
/// values.insert(":inc".to_string(), AttributeValue::N("1".to_string()));
///
/// store.update("users", &key, update_expression, Some(values), None).await?;
///
/// Ok(())
/// }
/// ```
pub async fn update<K: Serialize>(
&self,
table_name: &str,
key: &K,
update_expression: String,
expression_attribute_values: Option<HashMap<String, AttributeValue>>,
expression_attribute_names: Option<HashMap<String, String>>,
) -> Result<UpdateItemOutput> {
Self::validate_table_name(table_name)?;
let key_map = serde_dynamo::to_item(key)
.map_err(|e| Error::Validation(format!("Failed to serialize key: {}", e)))?;
self.update_item(
table_name,
key_map,
update_expression,
expression_attribute_values,
expression_attribute_names,
)
.await
}
}