How to get full document for embedding development

[shiyewuxian]

I found there's some simple guides in Surrealdb website (https://surrealdb.com/docs/embedding) for embedding development.
There's some API including:

• db.connect
• db.use_ns
• db.set
• db.query
• db.select
• db.create
• db.update
• ...

However, there's no description for db.execute, which I have seen it used in some examples. For example:

let ds: Datastore = Datastore::new("memory").await?;
let ses: Session = Session::for_kv();
let ast: &str = "USE NS test DB test; SELECT * FROM post;";
let res: Vec<Response> = ds.execute(ast, &ses, None, false).await?;
println!("(:?)", res);

I would like to know how I can find the description for the API (like the "execute") which is not shown in the website.

Many Thanks.

[phughk]

Hi @shiyewuxian thanks for asking this question.

The documented API is what we have committed to exposing. Other functions are leaking implementation and we intend to not expose them in the future.

Regarding behaviour, execution is a lower-level implementation of the listed functions. All those functions invoke execute under the hood. But they do so with various checks and casting. If you would like general-purpose query processing, the query method in the API should be sufficient.

Another difference is that execute is local-only. If you are operating on a websocket, this command doesnt exist, because execution happens on the server.

Hope this clarifies.

[shiyewuxian]

Hi @phughk thanks for your detailed reply which really helps.