SurrealDB Docs Logo

Enter a search query

Rust

Rust SDK

The SurrealDB SDK for Rust is the primary method of interacting with SurrealDB from client-side, server-side applications, systems, APIs, embedded systems, and IOT devices. The Rust SDK has support for robust error handling and type-safe operations, using an asynchronous API for efficient concurrent database interactions. You can use the Rust SDK to interact with your SurrealDB database instances, or to run SurrealDB as an embedded database within your Rust application, with functionality for executing queries, managing data, running database functions, authenticating to the database, building user signup and authentication functionality, and subscribing to data changes with live queries.

Important

The SDK requires Rust JDK version 1.80.1 or greater, and is available as a crate.

Note

The SDK works seamlessly with SurrealDB versions v2.0.0 to v2.0.4, ensuring compatibility with the latest version.

To contribute to the SDK code, submit an Issue or Pull Request in the surrealdb.rust repository. To contribute to this documentation, submit an Issue or Pull Request in the docs.surrealdb.com repository.

Frameworks

Sources

On this page

© SurrealDB GitHub Discord Community Cloud Features Releases Install