Tantivy 是一个用Rust编写的 全文搜索引擎库。

它在某些方面比 Apache Lucene 更接近，而不是 Elasticsearch 或 Apache Solr，因为它不是一个现成的搜索引擎服务器，而是一个可以用来构建此类搜索引擎的库。

Tantivy 实际上是在 Lucene 设计的基础上进行了强烈的启发。

如果您正在寻找 Elasticsearch 或 Apache Solr 的替代品，请查看我们基于 Tantivy 构建的搜索引擎 Quickwit。

基准测试

以下 基准测试 拆解了不同类型查询/集合的性能。

具体性能取决于查询的性质及其负载。

有关基准测试的详细信息，请参阅此 仓库。

功能

• 全文搜索
• 可配置的分词器（17种拉丁语言支持词干提取），并支持第三方中文（tantivy-jieba 和 cang-jie）、日文（lindera、Vaporetto、和 tantivy-tokenizer-tiny-segmenter）以及韩文（lindera + lindera-ko-dic-builder）
• 快速（查看🐎 ✨ 基准测试 ✨ 🐎）
• 启动时间短（<10ms），非常适合命令行工具
• BM25评分（与Lucene相同）
• 自然查询语言（例如：(michael AND jackson) OR "king of pop"）
• 短语查询搜索（例如："michael jackson"）
• 增量索引
• 多线程索引（在我的台式机上，索引英语维基百科只需不到3分钟）
• Mmap目录
• 当平台/处理器包含SSE2指令集时，使用SIMD整数压缩
• 单值和多值u64、i64和f64快速字段（相当于Lucene中的doc值）
• &[u8]快速字段
• 文本、i64、u64、f64、日期、IP、布尔值和层次结构分类字段
• 压缩文档存储（LZ4、Zstd、None）
• 范围查询
• 分类搜索
• 可配置索引（可选词频和位置索引）
• JSON字段
• 聚合收集器：直方图、范围桶、平均值和统计指标
• 带删除的LogMergePolicy
• 搜索器预热API
• 带有马的头像的蹩脚标志

非特性

分布式搜索不在Tantivy的范围内，但如果你正在寻找这个特性，请查看Quickwit。

入门指南

Tantivy运行在稳定的Rust上，并支持Linux、macOS和Windows。

• Tantivy的简单搜索示例
• tantivy-cli及其教程 - tantivy-cli是一个实际的命令行界面，它使您能够轻松地创建搜索引擎、索引文档并通过CLI或带有REST API的小型服务器进行搜索。它指导您在几分钟内将维基百科搜索引擎搭建并投入使用。
• 最新发布版本的参考文档

我如何支持这个项目？

有许多支持这个项目的方式。

• 使用Tantivy并告诉我们您的体验，您可以在Discord上或通过电子邮件（[email protected]）
• 报告错误
• 写博客文章
• 通过提问或提交PR来帮助文档
• 贡献代码（您可以加入我们的Discord服务器）
• 在您周围谈论Tantivy

代码贡献

我们使用GitHub Pull Request工作流程：在打开PR时引用GitHub票据和/或包含一个综合的提交信息。您可以在CHANGELOG.md中自由更新您的贡献。

分词器

在为tantivy实现分词器时，请依赖于tantivy-tokenizer-apicrate。

克隆和本地构建

Tantivy在稳定的Rust上编译。要检查和运行测试，您可以简单地运行

git clone https://github.com/quickwit-oss/tantivy.git
cd tantivy
cargo test

使用Tantivy的公司

常见问题解答

我可以在其他语言中使用 Tantivy 吗？

• Python → tantivy-py
• Ruby → tantiny

您也可以在 GitHub 上找到其他绑定，但它们可能维护较少。

Tantivy 的一些使用示例是什么？

• seshat：一个矩阵消息数据库/索引器
• tantiny：Ruby 的微型全文搜索引擎
• lnx：具有 REST API 的自适应、容错搜索引擎
• 以及 更多！

与 Lucene 相比，Tantivy 平均快多少？

• 根据我们的 搜索延迟基准，Tantivy 大约比 Lucene 快 2 倍。

tantivy 支持增量索引吗？

• 是的。

我如何编辑文档？

• tantivy 中的数据是不可变的。要编辑文档，需要删除文档并重新索引。

在索引期间，我的文档何时可搜索？

• 在调用 IndexWriter 上的 commit 后，文档将可搜索。还需要重新加载现有的 IndexReader 以反映更改。最后，更改仅对新获得的 Searcher 可见。