mirror of
https://github.com/quickwit-oss/tantivy.git
synced 2026-06-19 09:16:45 +00:00
Tantivy is a full-text search engine library inspired by Apache Lucene and written in Rust
- Rust 100%
| cpp | ||
| examples | ||
| script | ||
| src | ||
| .gitignore | ||
| .gitmodules | ||
| .travis.yml | ||
| build.rs | ||
| Cargo.toml | ||
| LICENSE | ||
| README.md | ||
Tantivy is a full text search engine library written in rust.
It is strongly inspired by Lucene's design.
Features
- configurable indexing (optional term frequency and position indexing)
- tf-idf scoring
- Basic query language
- Incremental indexing
- Multithreaded indexing (indexing English Wikipedia takes 4 minutes on my desktop)
- mmap based
- SIMD integer compression
- u32 fast fields (equivalent of doc values in Lucene)
- LZ4 compressed document store
- Cheesy logo with a horse
Getting started
- tantivy's usage example
- tantivy-cli and its tutorial. It will walk you through getting a wikipedia search engine up and running in a few minutes.
- reference doc.
Compiling
By default, tantivy uses a git submodule called simdcomp.
After cloning the repository, you will need to initialize and update
the submodules. The project can then be built using cargo.
git clone git@github.com:fulmicoton/tantivy.git
git submodule init
git submodule update
cargo build
Alternatively, if you are trying to compile tantivy without simd compression,
you can disable this functionality. In this case, this submodule is not required
and you can compile tantivy by using the --no-default-features flag.
cargo build --no-default-features
Contribute
Send me an email (paul.masurel at gmail.com) if you want to contribute to tantivy.