SeekStorm

⚠ 该项目 README 未提供完整安装说明，以下步骤为通用流程，请以官方文档为准。

环境要求

• 已安装 Rust 工具链（含 cargo 命令）
• 异步运行时 crate：tokio
• 序列化 crate：serde_json

安装与启动步骤

1. 1检查 Rust 环境

   确认本机已安装 Rust 与 cargo，且能在项目目录执行 cargo 命令。README 未指定最低版本。

   cargo --version

   复制

2. 2添加依赖 crate

   在已有 Cargo 项目目录中执行，把 SeekStorm 库与示例所需的 tokio、serde_json 加入依赖。

   cargo add seekstorm
   cargo add tokio
   cargo add serde_json

   复制

3. 3编写异步入口

   SeekStorm 库需在异步 Rust 运行时中调用，按 README 示例用 #[tokio::main] 包裹 main 函数。

   use std::error::Error;
   #[tokio::main]
   async fn main() -> Result<(), Box> {
   
     // your SeekStorm code here
   
      Ok(())
   }

   复制

4. 4定义索引与分面

   分面字段要在 create_index 的 schema 中定义，分面值在 index_document 写入时设置，否则查询阶段无法使用分面。

5. 5查询并按分面过滤

   查询时传入 query_facets / facet_filter 参数，分面统计结果会随搜索返回对象一起返回。

6. 6运行验证

   cargo run 编译并启动示例，能编译通过、异步 main 正常执行即说明依赖接入成功。

   cargo run

   复制

关键配置

如何确认成功

cargo run 编译无错误，tokio 异步 main 正常执行并返回 Ok(())，说明库已正确引入。

常见问题

注意事项

• README 未提供完整的安装编译步骤，库用法细节以官方 Library Docs 与 REST API 文档为准。
• 项目采用 Apache License 2.0 开源许可。
• README 标注 work in progress，接口和功能可能仍在变化。
• 除进程内库外，还可选择多租户服务器模式，其说明见 server 与 client 各自的 README。