8 个版本
0.3.1 | 2023 年 10 月 15 日 |
---|---|
0.3.0 | 2023 年 6 月 25 日 |
0.2.4 | 2023 年 6 月 22 日 |
0.1.3 | 2023 年 6 月 3 日 |
#563 在 数据库接口
每月 22 次下载
70KB
1.5K SLoC
Dynarust
Dynarust 是一个针对 DynamoDB ODM 的 Rust 库,使用 serde 和 serde_json 将结构体映射到本地 Dynamo 项。
它仅适用于具有 HASH
和 RANGE
键的表,在代码中分别称为 pk
和 sk
。这种设置可以用于非常广泛的各种用例。
用法
您需要在您的 Cargo.toml
中包含以下依赖项,根据您的需求调整版本
[dependencies]
dynarust = "*"
serde = "*"
tokio = { version = "*", features = ["full"] }
// Spawn a local dynamo: `docker run -p 8000:8000 amazon/dynamodb-local`
use dynarust::serde::{Deserialize, Serialize};
use dynarust::serde_json::json;
#[derive(Serialize, Deserialize)]
struct Car {
brand: String,
model: String,
horse_power: i64,
}
impl dynarust::Resource for Car {
fn table() -> String { "Cars".into() }
fn pk_sk(&self) -> (String, String) { (self.brand.clone(), self.model.clone()) }
}
#[tokio::main]
async fn main() {
let client = dynarust::Client::local().await;
client.create_table::<Car>(None).await.unwrap();
let car = Car {
brand: "Tesla".into(),
model: "Y".into(),
horse_power: 347,
};
client.create(&car).await.unwrap();
client.update(&car, json!({ "horse_power": 534 })).await.unwrap();
let tesla = client.get::<Car>(("Tesla".into(), "Y".into())).await.unwrap();
assert_eq!(tesla.unwrap().horse_power, 534)
}
事务
Dynarust 的 API 非常注重事务的易用性,提供了一种执行事务操作的方法,几乎就像它们是普通操作一样
// Spawn a local dynamo: `docker run -p 8000:8000 amazon/dynamodb-local`
use dynarust::serde::{Deserialize, Serialize};
use dynarust::serde_json::json;
#[derive(Serialize, Deserialize)]
struct Car {
brand: String,
model: String,
n_modifications: i64,
}
impl dynarust::Resource for Car {
fn table() -> String { "Cars".into() }
fn pk_sk(&self) -> (String, String) { (self.brand.clone(), self.model.clone()) }
}
#[derive(Serialize, Deserialize)]
struct CarModification {
car_brand: String,
car_model: String,
modification: String,
price: f64,
}
impl dynarust::Resource for CarModification {
fn table() -> String { "CarModifications".into() }
fn pk_sk(&self) -> (String, String) {(
format!("{}-{}", self.car_brand, self.car_model),
self.modification.clone(),
)}
}
#[tokio::main]
async fn main() {
let client = dynarust::Client::local().await;
client.create_table::<Car>(None).await.unwrap();
client.create_table::<CarModification>(None).await.unwrap();
let car = Car {
brand: "Tesla".into(),
model: "Y".into(),
n_modifications: 0,
};
client.create(&car).await.unwrap();
let car_modification = CarModification {
car_brand: "Tesla".into(),
car_model: "Y".into(),
modification: "Loud exhaust".into(),
price: 14999.95,
};
let mut context = dynarust::begin_transaction();
dynarust::transact_create(&car_modification, &mut context).unwrap();
dynarust::transact_update(&car, json!({ "n_modifications": car.n_modifications + 1 }), &mut context).unwrap();
client.execute_transaction(context).await.unwrap();
let tesla = client.get::<Car>(("Tesla".into(), "Y".into())).await.unwrap();
assert_eq!(tesla.unwrap().n_modifications, 1)
}
设置
为了使用此库,表的设置需要类似于以下等效 CFN 模板
DynamoDBTable:
Type: AWS::DynamoDB::Table
Properties:
TableName: my-table
AttributeDefinitions:
- AttributeName: PrimaryKey
AttributeType: S
- AttributeName: SecondaryKey
AttributeType: S
KeySchema:
- AttributeName: PrimaryKey
KeyType: HASH
- AttributeName: SecondaryKey
KeyType: RANGE
dynarust
预期属性 PrimaryKey
和 SecondaryKey
在键模式中声明为 HASH
和 RANGE
值,并且两者都是 S
(字符串) 类型。
即将推出
- 支持全局次要索引,具有与现有主索引相同的 API。
当前限制
- 仅适用于具有
HASH
和RANGE
键设置的表。 - 它与全局或本地次要索引不兼容。
- 缺少一些批处理操作,目前只实现了
batch_get
。
依赖关系
~30MB
~589K SLoC