Expand description
§surmux
极简 SurrealDB WebSocket 客户端 — 单连接 JSON-RPC 多路复用, 极简依赖.
§设计原则
- 最小依赖: 仅 ~11 个直接依赖 (vs 官方 SDK 的 ~500+)
- 高性能: 单 WS 连接 + id-based 请求多路复用, 支持数千并发请求
- 优雅 API: 流式 QueryBuilder + 便捷 CRUD + 事务 + Bucket
- 自动重连: 指数退避 + 重连后自动重新认证 (signin → use ns/db)
§使用示例
use surmux::{SurrealClient, SurrealConfig};
let config = SurrealConfig::new("localhost:8000")
.user("root")
.password("root")
.namespace("my_ns")
.database("my_db");
let client = SurrealClient::connect(config).await?;
// 查询
#[derive(serde::Deserialize)]
struct User { id: String, name: String }
let users: Vec<User> = client
.query("SELECT * FROM users WHERE status = $status")
.bind("status", "active")
.all()
.await?;
// 事务 (Token 分配)
client.transaction(&[
"LET $t = (SELECT * FROM product_alloc WHERE status = 'free' LIMIT 1)",
"UPDATE $t.id SET status = 'allocated' RETURN AFTER",
]).exec().await?;Re-exports§
pub use bucket::BucketOps;pub use client::SurrealClient;pub use config::SurrealConfig;pub use error::SurrealError;pub use error::SurrealResult;pub use pool::SurrealPool;pub use protocol::SurrealQueryResult;pub use query::QueryBuilder;
Modules§
- bucket
- BucketOps: SurrealDB Bucket 文件存储操作.
- client
- SurrealClient: 主入口, 连接管理 + 查询 API.
- codec
- RPC 编解码器: CBOR 与 JSON 协议的请求/响应序列化与反序列化.
- config
- 连接配置.
- error
- 结构化错误类型.
- pool
- 连接池: 多个独立 WS 连接, round-robin 分发.
- protocol
- RPC 协议类型: 请求/响应/查询结果.
- query
- QueryBuilder: 流式构建 SurrealQL 查询.
- serde_
compat - CBOR Tag adapter — typed path 兼容 SurrealDB 自定义 CBOR Tag.