docs.surrealdb.com icon indicating copy to clipboard operation
docs.surrealdb.com copied to clipboard

Documentation: add information about surrealdb::sql, Id, Thing, ulid

Open szabgab opened this issue 4 months ago • 4 comments

Description

I can use

use surrealdb::sql::{Id, Thing};
let id = Id::ulid();
let thing = Thing::from(("user", id));

But I can't seem to find the documentation:

https://docs.rs/surrealdb/latest/surrealdb/index.html?search=sql returns nothing

https://docs.rs/surrealdb/latest/surrealdb/index.html?search=ulid returns a link to https://docs.rs/surrealdb/latest/surrealdb/struct.Uuid.html but ulid is not mentioned on that page.

Neither https://docs.rs/surrealdb/latest/surrealdb/index.html?search=Id nor https://docs.rs/surrealdb/latest/surrealdb/index.html?search=Thing returns a page about the right thing. That would be surrealdb::sql::{Id, Thing}

More specifically I was looking for a way to convert a string (received via http) to an Id. Copilot suggested Id::from_ulid_str but that does not seem to exists. (yet :smile: ).

Is there an existing issue for this?

  • [X] I have searched the existing issues

Code of Conduct

  • [X] I agree to follow this project's Code of Conduct

szabgab avatar Sep 27 '24 08:09 szabgab