# Rust SDK

The SurrealDB SDK for Rust enables simple and advanced querying of a remote or embedded database.

The SurrealDB SDK for Rust enables you to interact 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 version `1.89` or greater, and is available as a [crate](https://crates.io/crates/surrealdb).

> [!NOTE]
> The latest version of the SDK is latest.
> The SDK works with SurrealDB versions `v2.0.0` to `v3.2.4`, ensuring compatibility with the latest version.

## Getting started

- [Getting started guide](/docs/languages/rust.md) - Connect to SurrealDB and run your first queries.

## Learn

- [Concepts](/docs/reference/rust/concepts.md) - Guides for connecting, authenticating, querying, and working with data.

- [API Reference](/docs/reference/rust/methods.md) - Complete reference for the SDK's methods, types, and errors.

## Frameworks

- [Actix](/docs/reference/rust/frameworks/actix.md)

- [Axum](/docs/reference/rust/frameworks/axum.md)

- [Egui](/docs/reference/rust/frameworks/egui.md)

- [Rocket](/docs/reference/rust/frameworks/rocket.md)

## Contributing

To contribute to the SDK code, submit an Issue or Pull Request in the [Rust SDK](https://github.com/surrealdb/surrealdb/tree/main/surrealdb) repository. To contribute to this documentation, submit an Issue or Pull Request in the [docs.surrealdb.com](https://github.com/surrealdb/docs.surrealdb.com) repository.

## Sources

- [GitHub repository](https://github.com/surrealdb/surrealdb/tree/main/surrealdb)
- [Crates.io package](https://crates.io/crates/surrealdb)
- [Docs.rs documentation](https://docs.rs/surrealdb/latest/surrealdb/)