36 releases (4 breaking)
|0.25.3||Jan 13, 2023|
|0.25.2||Jan 13, 2023|
|0.22.3||Dec 7, 2022|
|0.21.10||Dec 5, 2022|
|0.19.3||Oct 31, 2022|
#112 in Database implementations
142 downloads per month
Tantivy is a full-text search engine library written in Rust.
Tantivy is, in fact, strongly inspired by Lucene's design.
If you are looking for an alternative to Elasticsearch or Apache Solr, check out Quickwit, our search engine built on top of Tantivy.
The following benchmark breakdowns performance for different types of queries/collections.
Your mileage WILL vary depending on the nature of queries and their load.
- Full-text search
- Configurable tokenizer (stemming available for 17 Latin languages) with third party support for Chinese (tantivy-jieba and cang-jie), Japanese (lindera, Vaporetto, and tantivy-tokenizer-tiny-segmenter) and Korean (lindera + lindera-ko-dic-builder)
- Fast (check out the 🐎 ✨ benchmark ✨ 🐎)
- Tiny startup time (<10ms), perfect for command-line tools
- BM25 scoring (the same as Lucene)
- Natural query language (e.g.
(michael AND jackson) OR "king of pop")
- Phrase queries search (e.g.
- 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, i64, and f64 fast fields (equivalent of doc values in Lucene)
- Text, i64, u64, f64, dates, and hierarchical facet fields
- Compressed document store (LZ4, Zstd, None, Brotli, Snap)
- Range queries
- Faceted search
- Configurable indexing (optional term frequency and position indexing)
- JSON Field
- Aggregation Collector: histogram, range buckets, average, and stats metrics
- LogMergePolicy with deletes
- Searcher Warmer API
- Cheesy logo with a horse
Distributed search is out of the scope of Tantivy, but if you are looking for this feature, check out Quickwit.
Tantivy works on stable Rust and supports Linux, macOS, and Windows.
- Tantivy's simple search example
- tantivy-cli and its tutorial -
tantivy-cliis an actual command-line interface that makes it easy for you to create a search engine, index documents, and search via the CLI or a small server with a REST API. It walks you through getting a Wikipedia search engine up and running in a few minutes.
- Reference doc for the last released version
How can I support this project?
There are many ways to support this project.
- Use Tantivy and tell us about your experience on Discord or by email (firstname.lastname@example.org)
- Report bugs
- Write a blog post
- Help with documentation by asking questions or submitting PRs
- Contribute code (you can join our Discord server)
- Talk about Tantivy around you
We use the GitHub Pull Request workflow: reference a GitHub ticket and/or include a comprehensive commit message when opening a PR.
When implementing a tokenizer for tantivy depend on the
Minimum supported Rust version
Tantivy currently requires at least Rust 1.62 or later to compile.
Clone and build locally
Tantivy compiles on stable Rust. To check out and run tests, you can simply run:
git clone https://github.com/quickwit-oss/tantivy.git cd tantivy cargo build
Some tests will not run with just
cargo test because of
To run the tests exhaustively, run
You might find it useful to step through the programme with a debugger.
A failing test
Make sure you haven't run
cargo clean after the most recent
cargo test or
cargo build to guarantee that the
target/ directory exists. Use this bash script to find the name of the most recent debug build of Tantivy and run it under
find target/debug/ -maxdepth 1 -executable -type f -name "tantivy*" -printf '%TY-%Tm-%Td %TT %p\n' | sort -r | cut -d " " -f 3 | xargs -I RECENT_DBG_TANTIVY rust-gdb RECENT_DBG_TANTIVY
Now that you are in
rust-gdb, you can set breakpoints on lines and methods that match your source code and run the debug executable with flags that you normally pass to
cargo test like this:
$gdb run --test-threads 1 --test $NAME_OF_TEST
rustc compiles everything in the
examples/ directory in debug mode. This makes it easy for you to make examples to reproduce bugs:
rust-gdb target/debug/examples/$EXAMPLE_NAME $ gdb run
Companies Using Tantivy
Can I use Tantivy in other languages?
You can also find other bindings on GitHub but they may be less maintained.
What are some examples of Tantivy use?
- seshat: A matrix message database/indexer
- tantiny: Tiny full-text search for Ruby
- lnx: adaptable, typo tolerant search engine with a REST API
- and more!
On average, how much faster is Tantivy compared to Lucene?
- According to our search latency benchmark, Tantivy is approximately 2x faster than Lucene.
Does tantivy support incremental indexing?
How can I edit documents?
- Data in tantivy is immutable. To edit a document, the document needs to be deleted and reindexed.
When will my documents be searchable during indexing?
- Documents will be searchable after a
commitis called on an
IndexReaders will also need to be reloaded in order to reflect the changes. Finally, changes are only visible to newly acquired