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
/*!
A crate to help build DynamoDB condition, filter, key condition, and update
expressions in a type-safe way, including handling [expression attribute names][1]
and [expression attribute values][2].
[`Expression`] is the type to use for a [DynamoDB expression][2].
[`Path`] represents a [DynamoDB item attribute or document path][3], and has
many methods for building various expressions.
An example showing a how to use this crate to perform a query:
```no_run
# use aws_sdk_dynamodb::{error::SdkError, operation::query::QueryError};
#
# async fn example() -> Result<(), SdkError<QueryError>> {
use dynamodb_expression::{Expression, Num, Path};
let client = aws_sdk_dynamodb::Client::new(&aws_config::load_from_env().await);
let query_output = Expression::builder()
.with_filter(
Path::new_name("name")
.attribute_exists()
.and(Path::new_name("age").greater_than_or_equal(Num::new(2.5))),
)
.with_projection(["name", "age"])
.with_key_condition(Path::new_name("id").key().equal(Num::new(42)))
.build()
.query(&client)
.table_name("your_table")
.send()
.await?;
#
# Ok(())
# }
```
From here, see [`Expression`] and [`Path`] for more docs and examples.
# What about Rusoto?
[Rusoto][5] is intentionally not supported.
If you are using Rusoto and want to take advantage of this crate, you can still
build an expression, then convert the [`aws_sdk_dynamodb::types::AttributeValue`]
that are in the `expression_attribute_values` field into [`rusoto_dynamodb::AttributeValue`].
The rest of the fields are already what's needed.
```no_run
use aws_sdk_dynamodb::{primitives::Blob, types::AttributeValue as AwsAv};
use dynamodb_expression::{Expression, Path};
use itermap::IterMap;
use rusoto_core::Region;
use rusoto_dynamodb::{
AttributeValue as RusotoAv, DynamoDb, DynamoDbClient, UpdateItemInput,
};
# async fn example() {
let expression = Expression::builder()
.with_update(Path::new_name("foo").assign("a value"))
.build();
let input = UpdateItemInput {
update_expression: expression.update_expression,
condition_expression: expression.condition_expression,
expression_attribute_names: expression.expression_attribute_names,
expression_attribute_values: expression
.expression_attribute_values
.map(|values| values.into_iter().map_values(convert_av).collect()),
table_name: String::from("things"),
key: [(
String::from("id"),
RusotoAv {
n: Some(42.to_string()),
..RusotoAv::default()
},
)]
.into(),
..UpdateItemInput::default()
};
DynamoDbClient::new(Region::UsEast1)
.update_item(input)
.await
.expect("Failed to update item");
# }
fn convert_av(av: AwsAv) -> RusotoAv {
let mut rav = RusotoAv::default();
match av {
AwsAv::B(av) => rav.b = Some(av.into_inner().into()),
AwsAv::Bool(av) => rav.bool = av.into(),
AwsAv::Bs(av) => {
rav.bs = Some(
av.into_iter()
.map(Blob::into_inner)
.map(Into::into)
.collect(),
)
}
AwsAv::L(av) => rav.l = Some(av.into_iter().map(convert_av).collect()),
AwsAv::M(av) => rav.m = Some(av.into_iter().map_values(convert_av).collect()),
AwsAv::N(av) => rav.n = av.into(),
AwsAv::Ns(av) => rav.ns = av.into(),
AwsAv::Null(av) => rav.null = av.into(),
AwsAv::S(av) => rav.s = av.into(),
AwsAv::Ss(av) => rav.ss = av.into(),
_ => unimplemented!(
"A variant was added to aws_sdk_dynamodb::types::AttributeValue \
and not implemented here: {av:?}",
),
}
rav
}
```
[1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.ExpressionAttributeNames.html
[2]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.ExpressionAttributeValues.html
[3]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.html
[4]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.Attributes.html
[5]: https://docs.rs/rusoto_dynamodb/
[`rusoto_dynamodb::AttributeValue`]: https://docs.rs/rusoto_dynamodb/latest/rusoto_dynamodb/struct.AttributeValue.html
*/
// Re-export the crates publicly exposed in our API
pub use ::aws_sdk_dynamodb;
pub use ::num;
pub mod condition;
pub mod expression;
pub mod key;
pub mod operand;
pub mod path;
pub mod update;
pub mod value;
pub use expression::Expression;
pub use path::Path;
pub use value::{Map, Num, Scalar, Set, Value};
#[cfg(test)]
mod examples {
/// This exists just for formatting the doctest.
#[allow(dead_code)]
async fn example_rusoto() {
use crate::{Expression, Path};
use aws_sdk_dynamodb::{primitives::Blob, types::AttributeValue as AwsAv};
use itermap::IterMap;
use rusoto_core::Region;
use rusoto_dynamodb::{
AttributeValue as RusotoAv, DynamoDb, DynamoDbClient, UpdateItemInput,
};
let expression = Expression::builder()
.with_update(Path::new_name("foo").assign("a value"))
.build();
let input = UpdateItemInput {
update_expression: expression.update_expression,
condition_expression: expression.condition_expression,
expression_attribute_names: expression.expression_attribute_names,
expression_attribute_values: expression
.expression_attribute_values
.map(|values| values.into_iter().map_values(convert_av).collect()),
table_name: String::from("things"),
key: [(
String::from("id"),
RusotoAv {
n: Some(42.to_string()),
..RusotoAv::default()
},
)]
.into(),
..UpdateItemInput::default()
};
DynamoDbClient::new(Region::UsEast1)
.update_item(input)
.await
.expect("Failed to update item");
fn convert_av(av: AwsAv) -> RusotoAv {
let mut rav = RusotoAv::default();
match av {
AwsAv::B(av) => rav.b = Some(av.into_inner().into()),
AwsAv::Bool(av) => rav.bool = av.into(),
AwsAv::Bs(av) => {
rav.bs = Some(
av.into_iter()
.map(Blob::into_inner)
.map(Into::into)
.collect(),
)
}
AwsAv::L(av) => rav.l = Some(av.into_iter().map(convert_av).collect()),
AwsAv::M(av) => rav.m = Some(av.into_iter().map_values(convert_av).collect()),
AwsAv::N(av) => rav.s = av.into(),
AwsAv::Ns(av) => rav.ns = av.into(),
AwsAv::Null(av) => rav.null = av.into(),
AwsAv::S(av) => rav.s = av.into(),
AwsAv::Ss(av) => rav.ss = av.into(),
_ => unimplemented!(
"A variant was added to aws_sdk_dynamodb::types::AttributeValue \
and not implemented here: {av:?}",
),
}
rav
}
}
}