Skip to content
Tantivy is a full-text search engine library inspired by Apache Lucene and written in Rust
Branch: master
Clone or download
Pull request Compare This branch is 10 commits behind tantivy-search:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/ISSUE_TEMPLATE
ci
doc
examples
src
.gitattributes
.gitignore
.travis.yml
AUTHORS
CHANGELOG.md
Cargo.toml
LICENSE
README.md
appveyor.yml
run-tests.sh
rustfmt.toml

README.md

Build Status codecov Join the chat at https://gitter.im/tantivy-search/tantivy License: MIT Build status Say Thanks!

Tantivy

Become a patron

Tantivy is a full text search engine library written in rust.

It is closer to Apache Lucene than to Elasticsearch and Apache Solr in the sense it is not an off-the-shelf search engine server, but rather a crate that can be used to build such a search engine.

Tantivy is, in fact, strongly inspired by Lucene's design.

Benchmark

Tantivy is typically faster than Lucene, but the results will depend on the nature of the queries in your workload.

The following benchmark break downs performance for different type of queries / collection.

Features

  • Full-text search
  • Configurable tokenizer. (stemming available for 17 latin languages. Third party support for Chinese (tantivy-jieba and cang-jie) and Japanese
  • Fast (check out the 🐎 benchmark 🐎)
  • Tiny startup time (<10ms), perfect for command line tools
  • BM25 scoring (the same as lucene)
  • Natural query language (michael AND jackson) OR "king of pop"
  • Phrase queries search ("michael jackson")
  • Incremental indexing
  • Multithreaded indexing (indexing English Wikipedia takes < 3 minutes on my desktop)
  • Mmap directory
  • SIMD integer compression when the platform/CPU includes the SSE2 instruction set.
  • Single valued and multivalued u64 and i64 fast fields (equivalent of doc values in Lucene)
  • &[u8] fast fields
  • Text, i64, u64, dates and hierarchical facet fields
  • LZ4 compressed document store
  • Range queries
  • Faceted search
  • Configurable indexing (optional term frequency and position indexing)
  • Cheesy logo with a horse

Non-features

  • Distributed search is out of the scope of tantivy. That being said, tantivy is meant as a library upon which one could build a distributed search. Serializable/mergeable collector state for instance, are within the scope of tantivy.

Supported OS and compiler

Tantivy works on stable rust (>= 1.27) and supports Linux, MacOS and Windows.

Getting started

Compiling

Development

Tantivy compiles on stable rust but requires Rust >= 1.27. To check out and run tests, you can simply run :

git clone https://github.com/tantivy-search/tantivy.git
cd tantivy
cargo build

Running tests

Some tests will not run with just cargo test because of fail-rs. To run the tests exhaustively, run ./run-tests.sh.

How can I support this project ?

There are many ways to support this project.

  • If you use tantivy, tell us about your experience on gitter or by email (paul.masurel@gmail.com)
  • Report bugs
  • Write a blog post
  • Complete documentation
  • Contribute code (you can join our gitter )
  • Talk about tantivy around you
  • Drop a word on on Say Thanks! or even Become a patron
You can’t perform that action at this time.