15 unstable releases (5 breaking)

0.6.1 Jul 10, 2018
0.5.2 May 6, 2018
0.5.1 Mar 10, 2018
0.4.3 Jul 24, 2017
0.1.1 Aug 14, 2016

#4 in Database implementations

Download history 29/week @ 2018-07-28 54/week @ 2018-08-04 135/week @ 2018-08-11 26/week @ 2018-08-18 35/week @ 2018-08-25 23/week @ 2018-09-01 30/week @ 2018-09-08 24/week @ 2018-09-15 98/week @ 2018-09-22 76/week @ 2018-09-29 41/week @ 2018-10-06 28/week @ 2018-10-13 135/week @ 2018-10-20

214 downloads per month
Used in 3 crates

MIT license

1MB
24K SLoC

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

Tantivy

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

It is closer to Lucene than to Elastic Search and 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.

Features

  • Full-text search
  • Fast (check out the :racehorse: :sparkles: benchmark :sparkles: :racehorse:)
  • 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
  • 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 and will not be in 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 git@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.

Contribute

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

Dependencies

~13MB
~166K SLoC