Expand description
The embedded SurrealDB engine driven by the Rust SDK.
This crate owns everything that needs the database core: it opens a
Datastore, which runs its own background maintenance tasks, and
serves it to the SDK as a SurrealEngine.
The SDK reaches it only through surrealdb_engine_api, which is why
enabling one of this crate’s storage backends is the only thing that puts
the core in a Rust SDK build.
§Stability
This is an internal interface between crates released together. It carries
no stability guarantee and may change in any release, including a patch
release. Application code should use the
surrealdb crate and select a storage backend
with its kv-* features.
Modules§
- tasks
- The datastore’s background maintenance tasks.
Structs§
- Datastore
- The underlying datastore instance which stores the dataset.
- Engine
Options - Configuration for the engine behaviour
- Local
Config - Everything the engine needs to open a datastore and start serving routes.
- Local
Engine - A datastore this process owns, served through the SDK’s engine interface.
- Root
- The root credentials to initialise the datastore with on first start.
Functions§
- connect
- Opens the datastore
configdescribes and serves it to the SDK. - from_
datastore - Serves an already-open datastore to the SDK.