#surrealdb #连接 #派生 #数据库 #属性 #类型 #额外

surrealdb-extras

为与 SurrealDB 一起工作提供额外的功能。

8 个版本

0.2.1 2024 年 3 月 11 日
0.2.0 2024 年 3 月 8 日
0.1.8 2024 年 3 月 2 日
0.1.7 2024 年 2 月 26 日
0.1.4 2024 年 1 月 30 日

658Rust 模式

MIT 许可证

40KB
917

一个简单的库,用于建立连接并设置/创建命名空间 &db,并设置属性的类型。

示例

pub async fn establish(path: PathBuf) -> surrealdb::Result<Surreal<Db>> {
    let conn = Surreal::new::<SpeeDb>((path.join("db"), Config::default().strict()));
    surrealdb_extras::use_ns_db(conn, "test", "test", vec![Test::register]).await
}

#[derive(surrealdb_extras::SurrealTableEntry, Deserialize, Serialize, Clone, Default)]
#[db("test_table")]
#[sql(["DEFINE EVENT test_table_updated ON TABLE test_table WHEN $event = \"UPDATE\" AND $before.updated == $after.updated THEN (UPDATE $after.id SET updated = time::now() );"])]
struct Test {
    random_number: i32,
    /// renamed field
    #[opt(rename = "new_name")]
    #[serde(rename = "new_name")]
    data: String,
    /// overwrites the detected db type
    #[opt(db_type = "string")]
    data: CustomStructWithSerialize,
    /// will be excluded in get_or_insert check
    #[opt(exclude = true)]
    updated: Datetime
}

pub async fn demo() {
    let conn = establish(PathBuf::new()).await.unwrap();
    let test = Test::default();

    // creates new item with custom id and return self
    let _: Option<Test> = test
        .clone()
        .insert(&conn, Some(sql::Id::rand()))
        .await
        .unwrap();
        
    // creates new item with random id and return record
    let v: surrealdb_extras::Record = test.add(&conn).await.unwrap().unwrap();
    
    // delete record
    let v: Option<surrealdb_extras::Record> = v.delete(&conn).await.unwrap();
}

ThingFunc 中的实用函数

  • ThingFunc
  • SurrealTableInfo

ThingType、RecordData、Record 中的函数来自 ThingFunc

分类

初始化
  • use_ns_db
  • impl SurrealTableInfo(使用 #[derive(SurrealTable, Serialize, Deserialize)])
反序列化
  • impl SurrealSelectInfo(使用 #[derive(SurrealSelect, Deserialize)]#[derive(SurrealTable, Serialize, Deserialize)])
  • 记录
  • RecordData
  • ThingFunc(在结构体内部)
  • ThingType(在结构体内部)
序列化
  • impl SurrealTableInfo(使用 #[derive(SurrealTable, Serialize, Deserialize)])

  • ThingFunc(在结构体内部)

  • ThingType(在结构体内部)

  • ThingArray

依赖

~60MB
~1M SLoC