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 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504
use std::collections::HashMap;
use itermap::IterMap;
use itertools::Itertools;
use optempty::EmptyIntoNone;
use super::Expression;
use crate::{
condition::{
And, AttributeExists, AttributeNotExists, AttributeType, BeginsWith, Between, Comparison,
Condition, Contains, In, Not, Or, Parenthetical,
},
key::KeyCondition,
operand::{Operand, OperandType, Size},
path::{Element, Name, Path},
update::{Set, SetAction, Update},
value::{Ref, Value, ValueOrRef},
};
/// For building an [`Expression`]. Finish with [`.build()`].
///
/// See: [`Expression::builder`]
///
/// [`.build()`]: Self::build
#[must_use = "Call `.build()` to create the `Expression`"]
#[derive(Debug, Default, Clone)]
pub struct Builder {
condition: Option<Condition>,
key_condition: Option<KeyCondition>,
update: Option<Update>,
filter: Option<Condition>,
projection: Option<Vec<Name>>,
names: HashMap<Name, String>,
values: HashMap<Value, Ref>,
}
/// Functions and methods for building an `Expression`.
impl Builder {
/// Sets the condition for this [`Expression`], overwriting any previously set.
pub fn with_condition<T>(mut self, condition: T) -> Self
where
T: Into<Condition>,
{
self.condition = Some(self.process_condition(condition.into()));
self
}
/// Sets the key condition for this [`Expression`], overwriting any previously set.
///
/// See also: [`Path::key`]
///
/// ```
/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
/// use dynamodb_expression::{Expression, Num, Path};
///
/// let key_condition = "id"
/// .parse::<Path>()?
/// .key()
/// .equal(Num::new(42))
/// .and("category".parse::<Path>()?.key().begins_with("hardware."));
///
/// let expression = Expression::builder().with_key_condition(key_condition).build();
/// # _ = expression;
/// #
/// # Ok(())
/// # }
/// ```
pub fn with_key_condition<T>(mut self, key_condition: T) -> Self
where
T: Into<KeyCondition>,
{
self.key_condition = Some(KeyCondition {
condition: self.process_condition(key_condition.into().condition),
});
self
}
/// Sets the update expression, overwriting any previously set.
pub fn with_update<T>(mut self, update: T) -> Self
where
T: Into<Update>,
{
self.update = Some(self.process_update(update.into()));
self
}
/// Sets the filter for this [`Expression`], overwriting any previously set.
pub fn with_filter<T>(mut self, filter: T) -> Self
where
T: Into<Condition>,
{
self.filter = Some(self.process_condition(filter.into()));
self
}
/// Sets the projection for this [`Expression`], overwriting any previously set.
///
/// Each of these examples produce the same projection expression.
///
/// ```
/// # fn example_with_projection() -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
/// # use pretty_assertions::assert_eq;
/// # use dynamodb_expression::{path::Name, Expression};
/// #
/// let expected = Expression {
/// condition_expression: None,
/// key_condition_expression: None,
/// update_expression: None,
/// filter_expression: None,
/// projection_expression: Some(String::from("#0, #1")),
/// expression_attribute_names: Some(
/// [("#0", "id"), ("#1", "name")]
/// .into_iter()
/// .map(|(k, v)| (String::from(k), String::from(v)))
/// .collect(),
/// ),
/// expression_attribute_values: None,
/// };
///
/// let expression = Expression::builder()
/// .with_projection(["id", "name"])
/// .build();
/// assert_eq!(expected, expression);
///
/// let expression = Expression::builder()
/// .with_projection([String::from("id"), String::from("name")])
/// .build();
/// assert_eq!(expected, expression);
///
/// let expression = Expression::builder()
/// .with_projection([Name::from("id"), Name::from("name")])
/// .build();
/// assert_eq!(expected, expression);
///
/// // Anything that's `IntoIterator` will work. A `Vec`, for example.
/// let expression = Expression::builder()
/// .with_projection(vec!["id", "name"])
/// .build();
/// assert_eq!(expected, expression);
///
/// // Or an `Iterator`.
/// let expression = Expression::builder()
/// .with_projection(["id", "name"].into_iter().map(Name::from))
/// .build();
/// assert_eq!(expected, expression);
/// #
/// # Ok(())
/// # }
/// ```
pub fn with_projection<I, T>(mut self, names: I) -> Self
where
I: IntoIterator<Item = T>,
T: Into<Name>,
{
self.projection = Some(
names
.into_iter()
.map(|name| self.process_name(name.into()))
.collect(),
)
// Empty into `None` because DynamoDB doesn't allow empty projection
// expressions, and will return:
// `Invalid ProjectionExpression: The expression can not be empty;`
.empty_into_none();
self
}
/// Builds the [`Expression`].
pub fn build(self) -> Expression {
let Self {
condition,
key_condition,
update,
filter,
projection,
names,
values,
} = self;
Expression {
condition_expression: condition.map(Into::into),
key_condition_expression: key_condition.map(Into::into),
update_expression: {
// Is there a more efficient way when all the `Update` strings
// require formatting?
update.as_ref().map(ToString::to_string)
},
filter_expression: filter.map(Into::into),
projection_expression: projection.map(|attrs| {
attrs
.into_iter()
.map(|name| name.name)
.collect_vec()
.join(", ")
}),
expression_attribute_names: Some(
names
.into_iter()
.map_keys(|name| name.name)
.swap()
.collect(),
)
.empty_into_none(),
expression_attribute_values: Some(
values
.into_iter()
.swap()
.map_keys(String::from)
.map_values(Value::into_attribute_value)
.collect(),
)
.empty_into_none(),
}
}
fn process_condition(&mut self, condition: Condition) -> Condition {
match condition {
Condition::AttributeExists(AttributeExists { path }) => AttributeExists {
path: self.process_path(path),
}
.into(),
Condition::AttributeNotExists(AttributeNotExists { path }) => AttributeNotExists {
path: self.process_path(path),
}
.into(),
Condition::AttributeType(AttributeType {
path,
attribute_type,
}) => AttributeType {
path: self.process_path(path),
attribute_type,
}
.into(),
Condition::Contains(Contains { path, operand }) => Contains {
path: self.process_path(path),
operand: self.process_value(operand).into(),
}
.into(),
Condition::BeginsWith(BeginsWith { path, substr }) => BeginsWith {
path: self.process_path(path),
substr: self.process_value(substr).into(),
}
.into(),
Condition::Between(Between { op, lower, upper }) => Between {
op: self.process_operand(op),
lower: self.process_operand(lower),
upper: self.process_operand(upper),
}
.into(),
Condition::In(In { op, items }) => In {
op: self.process_operand(op),
items: items
.into_iter()
.map(|item| self.process_operand(item))
.collect(),
}
.into(),
Condition::Comparison(Comparison { left, cmp, right }) => Comparison {
left: self.process_operand(left),
cmp,
right: self.process_operand(right),
}
.into(),
Condition::And(And { left, right }) => And {
left: self.process_condition(*left).into(),
right: self.process_condition(*right).into(),
}
.into(),
Condition::Or(Or { left, right }) => Or {
left: self.process_condition(*left).into(),
right: self.process_condition(*right).into(),
}
.into(),
Condition::Not(Not { condition }) => Not {
condition: self.process_condition(*condition).into(),
}
.into(),
Condition::Parenthetical(Parenthetical { condition }) => Parenthetical {
condition: self.process_condition(*condition).into(),
}
.into(),
}
}
fn process_operand(&mut self, operand: Operand) -> Operand {
match operand.op {
OperandType::Path(path) => self.process_path(path).into(),
OperandType::Size(Size { path: name }) => Size {
path: self.process_path(name),
}
.into(),
OperandType::Scalar(value) => Operand {
op: OperandType::Scalar(self.process_value(value).into()),
},
OperandType::Condition(condition) => self.process_condition(*condition).into(),
}
}
fn process_update(&mut self, update: Update) -> Update {
match update {
Update::SetRemove(mut update) => {
if let Some(set) = update.set {
update.set = Some(self.process_set(set));
}
if let Some(mut remove) = update.remove {
remove.paths = remove
.paths
.into_iter()
.map(|path| self.process_path(path))
.collect();
update.remove = Some(remove);
}
update.into()
}
Update::Add(mut update) => {
update.path = self.process_path(update.path);
update.value = self.process_value(update.value).into();
update.into()
}
Update::Delete(mut update) => {
update.path = self.process_path(update.path);
update.subset = self.process_value(update.subset).into();
update.into()
}
}
}
fn process_set(&mut self, mut set: Set) -> Set {
set.actions = set
.actions
.into_iter()
.map(|action| match action {
SetAction::Assign(mut action) => {
action.path = self.process_path(action.path);
action.value = self.process_value(action.value).into();
action.into()
}
SetAction::Math(mut action) => {
action.dst = self.process_path(action.dst);
action.src = action.src.map(|src| self.process_path(src));
action.num = self.process_value(action.num).into();
action.into()
}
SetAction::ListAppend(mut action) => {
action.dst = self.process_path(action.dst);
action.src = action.src.map(|src| self.process_path(src));
action.list = self.process_value(action.list).into();
action.into()
}
SetAction::IfNotExists(mut action) => {
action.dst = self.process_path(action.dst);
action.src = action.src.map(|src| self.process_path(src));
action.value = self.process_value(action.value).into();
action.into()
}
})
.collect();
set
}
fn process_path(&mut self, mut path: Path) -> Path {
path.elements = path
.elements
.into_iter()
.map(|elem| match elem {
Element::Name(name) => self.process_name(name).into(),
Element::IndexedField(mut new_indexed_field) => {
new_indexed_field.name = self.process_name(new_indexed_field.name);
new_indexed_field.into()
}
})
.collect();
path
}
fn process_name(&mut self, name: Name) -> Name {
let count = self.names.len();
Name {
name: self
.names
.entry(name)
.or_insert(format!("#{count}"))
.clone(),
}
}
fn process_value(&mut self, value: ValueOrRef) -> Ref {
match value {
ValueOrRef::Value(value) => {
let count = self.values.len();
self.values
.entry(value)
.or_insert_with(|| count.to_string().into())
.clone()
}
ValueOrRef::Ref(value) => value,
}
}
}
#[cfg(test)]
mod test {
use aws_sdk_dynamodb::operation::query::builders::QueryInputBuilder;
use pretty_assertions::assert_eq;
use crate::path::Name;
use super::Expression;
#[test]
fn empty_projection() {
let expression = Expression::builder()
.with_projection(Vec::<Name>::default())
.build();
assert_eq!(
Expression {
condition_expression: None,
filter_expression: None,
key_condition_expression: None,
projection_expression: None,
update_expression: None,
expression_attribute_names: None,
expression_attribute_values: None,
},
expression,
"An empty iterator should result in `None` for projection expression"
);
let query = expression.to_query_input_builder();
assert_eq!(QueryInputBuilder::default(), query);
}
}
#[cfg(test)]
mod doc_examples {
#[test]
fn example_with_projection() -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
use crate::{path::Name, Expression};
use pretty_assertions::assert_eq;
let expected = Expression {
condition_expression: None,
key_condition_expression: None,
update_expression: None,
filter_expression: None,
projection_expression: Some(String::from("#0, #1")),
expression_attribute_names: Some(
[("#0", "id"), ("#1", "name")]
.into_iter()
.map(|(k, v)| (String::from(k), String::from(v)))
.collect(),
),
expression_attribute_values: None,
};
let expression = Expression::builder()
.with_projection(["id", "name"])
.build();
assert_eq!(expected, expression);
let expression = Expression::builder()
.with_projection([String::from("id"), String::from("name")])
.build();
assert_eq!(expected, expression);
let expression = Expression::builder()
.with_projection([Name::from("id"), Name::from("name")])
.build();
assert_eq!(expected, expression);
// Anything that's `IntoIterator` will work. A `Vec`, for example.
let expression = Expression::builder()
.with_projection(vec!["id", "name"])
.build();
assert_eq!(expected, expression);
// Or an `Iterator`.
let expression = Expression::builder()
.with_projection(["id", "name"].into_iter().map(Name::from))
.build();
assert_eq!(expected, expression);
Ok(())
}
}