Expand description
This library provides a low-level database library implementation, a remote client and a query language definition, for SurrealDB, the ultimate cloud database for tomorrow’s applications. SurrealDB is a scalable, distributed, collaborative, document-graph database for the realtime web.
This library can be used to start an embedded in-memory datastore, an embedded datastore persisted to disk, a browser-based embedded datastore backed by IndexedDB, or for connecting to a distributed TiKV key-value store.
It also enables simple and advanced querying of a remote SurrealDB server from server-side or client-side code. All connections to SurrealDB are made over WebSockets by default, and automatically reconnect when the connection is terminated.
Modules§
- engine
- Different embedded and remote database engines
- method
- Methods to use when interacting with a SurrealDB instance
- opt
- The different options and types for use in API functions
- parse
- types
- SurrealDB Types
Structs§
- Connect
- The future returned when creating a new SurrealDB instance
- Error
- Represents an error in SurrealDB
- Indexed
Results - The response type of a
Surreal::queryrequest - Notification
- Stats
- Query execution statistics
- Surreal
- A database client instance for embedded or remote databases.
Traits§
- Connection
- Connection trait implemented by supported engines
Type Aliases§
- Result
- A specialized
Resulttype