tantivy/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

Tantivy has 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

Contribute

Send me an email (paul.masurel at gmail.com) if you want to contribute to tantivy.