#surrealdb #connection #derive #attributes #type #extra #async

surrealdb-extras

Provides additional functionality for working with SurrealDB

9 releases (1 stable)

2.0.7 Oct 18, 2024
2.0.0 Oct 17, 2024
0.2.1 Mar 11, 2024
0.1.8 Mar 2, 2024
0.1.4 Jan 30, 2024

#471 in Rust patterns

Download history 5/week @ 2024-09-19 6/week @ 2024-09-26 2/week @ 2024-10-03 943/week @ 2024-10-17 50/week @ 2024-10-24

623 downloads per month

MIT license

41KB
915 lines

A simple library that establishes a connection and sets/creates the namespace&db and sets the types of the attributes

Example

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();
}

usefull functions in:

  • RecordIdFunc
  • SurrealTableInfo

the functions in RecordIdType, RecordData, Record are from RecordIdFunc

Categorized

init:
  • use_ns_db
  • impl SurrealTableInfo(use #[derive(SurrealTable, Serialize, Deserialize)])
Deserialize:
  • impl SurrealSelectInfo(use #[derive(SurrealSelect, Deserialize)] or #[derive(SurrealTable, Serialize, Deserialize)])
  • Record
  • RecordData
  • RecordIdFunc(within structs)
  • RecordIdType(within structs)
Serialize:
  • impl SurrealTableInfo(use #[derive(SurrealTable, Serialize, Deserialize)])

  • RecordIdFunc(within structs)

  • RecordIdType(within structs)

  • ThingArray

Dependencies

~76MB
~1.5M SLoC