NewYour coding agent can read the release notes before it upgrades.Set up the MCP server →
crates.io
crates.io, #2355 most downloaded on crates.io
Search engine library
Latest stable
0.27.0
Last release 1 months ago
16 Oct 2026
Ships fairly regularly
a new release about every 7 months
Nearly every release is documented
notes for 14 of 14 stable releases
Nothing withdrawn
no release was ever pulled
7 years old
14 releases · first in 2019
Drag across the ruler to compare, or tap a release to open it.
.set_fast(..) now takes a &str. The same behavior as .set_fast(None) can be obtained with .set_fast(tantivy::RAW_TOKENIZER_NAME). #3020 #3029 ( @fulmi
================================
.set_fast(..) now takes a &str. The same behavior as .set_fast(None) can be obtained with .set_fast(tantivy::tokenizer::RAW_TOKENIZER_NAME). #3020 #3029(@fulmicoton @trinity-1686a)FieldType::TieBreaker variant; exhaustive matches on FieldType need a new arm.Custom variants to FieldType, Type, OwnedValue, ReferenceValueLeaf and SegmentComponent, and new TantivyError variants. SegmentComponent is no longer Copy, SegmentSerializer is removed and IndexMerger::write now takes a &Segment #2993(@rebasedming)IndexSettings has a new public sort_by_field field, and ColumnarWriter::serialize / FastFieldsWriter::serialize take an optional doc id mapping #2959(@rebasedming)Directory writers only need terminate(), not flush(). RamDirectory::deep_clone is removed #3095(@PSeitz)BooleanWeight::new is removed; use BooleanWeight::with_minimum_number_should_match #3071(@fulmicoton)SumAggregation has a new none_if_no_match field #2878(@mdashti)IntermediateTermBucketResult::entries() returns a slice instead of a hash map, and intermediate aggregation results no longer implement PartialEq #3040(@PSeitz)*AggReqData) and columnar::ColumnBlockAccessor are no longer public #3110 #3066(@fulmicoton)tantivy-sstable: BlockReader::from_multiple_blocks and DeltaReader::from_multiple_blocks take the first term ordinal of each block #3030(@flow3d)CompactDoc::node_data is no longer public #3175(@fulmicoton-dd)missing value also exists as a real term #3163(@PSeitz)missing is used with include/exclude #2907(@barbarj)after_key on a non-empty page, like Elasticsearch #2910(@Abdul-Andha)datasketches for cardinality aggregation, fixing sketch LIST serialization, and switch to HLL8 #2936(@fulmicoton)DisjunctionMaxQuery and other non-summing score combiners being scored as a sum with TopDocs #3022(@marcbachmann)>= 1.5 no longer matches 1) #3074(@fulmicoton)Streamer::term_ord() returning wrong ordinals when an automaton prunes dictionary blocks #3030(@flow3d)FacetCollector returning a facet from an unrelated branch #2867(@majiayu000)DateTime::try_from_utc #3156(@Darkheir)SegmentReader ignoring I/O errors when opening the positions file #2931(@JinheLin)rust-stemmers with frostem, fixing a panic on some Greek words #3028(@Xuanwo)StrColumn::ord_to_str, Term::get_json_path, the doc store and MemoryArena #3175 #3176(@fulmicoton-dd)SchemaBuilder::add_tie_breaker_field. Values are consecutive within a segment, start at a random offset, and are preserved across merges. #3104 #3143 #3158(@PSeitz @Mallets)jitexpr feature)
jitexpr crate, a Cranelift-based JIT expression compiler with arithmetic, comparison, boolean, null, math, string and regex functions #3078 #3083 #3090 #3107 #3109(@fulmicoton @fulmicoton-dd)JitExprPredicate to filter documents with a jitexpr expression over fast fields #3081 #3129(@fulmicoton)JitExprValueSourceProvider to use calculated fields in aggregations #3162 #3166(@fulmicoton)ValueSource abstraction to aggregate on computed values, registered via AggregationCollector::with_value_sources #3112 #3147 #3160 #3171(@fulmicoton)IntermediateAggregationResults::prune_intermediate_results to re-prune intermediate results with the request limits #2990(@trinity-1686a)none_if_no_match option to the sum aggregation #2878(@mdashti)validate_aggregation_fields_exist to check aggregation fields up front #2768(@mdashti)BucketEntries::iter() and TopNComputer::threshold public #2890(@alexanderbianchi)IndexSettings::sort_by_field), now with Str/Bytes fast field support and correct NULL ordering in merges #2959 #3116 #3185(@rebasedming @walter-woodall @fulmicoton)finalize_with_doc_id_mapping) #2978(@Mallets)field:*) in the query parser #2798(@Darkheir)DocPredicateQuery and FunctionPredicate to match documents with a per-document predicate #3072(@fulmicoton-dd)RegexPhraseQuery::from_regexes and RegexPhraseQuery::regexes() #3138(@palmoni5)FuzzyTermQuery::automaton() and make DfaWrapper public #3136(@palmoni5)SeekDangerResult for downstream DocSet implementations #3144(@PSeitz)BlockSegmentPostings::rank() to count docs below a target using the skip list #2958(@Windforce17)SegmentPlugin trait for custom per-segment components and custom field types #2993(@rebasedming)IndexMeta::list_segment_files() #3080(@fulmicoton)Snippet::fragment_range() #3134(@palmoni5)info! logs to debug! #3013(@mmustafasenoglu)select_nth for top-k #2989 #3017 #2987 #2983 #3174(@PSeitz @trinity-1686a @fulmicoton)seek_danger on RangeDocSet #2963(@PSeitz-dd)Intersection::seek #2982 #3164(@PSeitz @fulmicoton-dd)Weight::scorer_danger so intersections can build slow scorers (e.g. phrase) lazily around a candidate doc #3070(@fulmicoton)ExistsQuery on sparse fast fields #3052(@PSeitz)ConstScoreQuery disables scoring of the wrapped query #3059(@JinheLin)RegexPhraseQuery regexes once per query (up to 9x faster) #3135 #3137(@palmoni5)warm_postings_automaton_with_bitset to warm an automaton's postings and return matching docs in one pass #3157(@PSeitz)filter_vec implementations for ARM (~2.5x faster) #2940 #2952(@fulmicoton)Streamer::advance (up to 2x) and without_keys() streamers for automaton and range queries #3126 #3155(@trinity-1686a @fulmicoton)RamDirectory and remove unneeded flushes while writing segments #3095(@PSeitz)Your coding agent can read these notes before it upgrades. Set up the MCP server →
Align float query coercion during search with the columnar coercion rules #2692(@fulmicoton)
seek() advancing below current doc id #2812(@fulmicoton)* #2751(@Darkheir)vint buffer overflow during index creation #2778(@rebasedming)ExpUnrolledLinkedList for large datasets #2735(@mdashti)"..."*) and slop ("..."~N) on JSON fields; previously both were silently dropped, degrading the query to an exact phrase #2966(@DavIvek)SortKeyComputer for sorting on column types unknown until runtime #2770 #2790(@stuhood @PSeitz)TopDocs::order_by #2780(@stuhood)stemmer feature flag #2791(@fulmicoton)DeleteMeta, AddOperation, advance_deletes, with_max_doc, serializer module, and delete_queue public #2762 #2765 #2766 #2835(@philippemnoel @PSeitz)Language hashable #2763(@philippemnoel)space_usage reporting for JSON fields and columnar data #2761(@PSeitz-dd)Term into Term and IndexingTerm #2744 #2750(@PSeitz-dd @PSeitz)PagedTermMap for faster medium cardinality term aggregations #2715 #2759(@PSeitz @PSeitz-dd)Vec instead of a HashMap #2740(@fulmicoton-dd)ExistsQuery for a high number of dynamic columns #2694(@PSeitz-dd)DocSet::cost() and use it to order scorers in intersections #2707(@PSeitz)collect_block support for collector wrappers #2727(@stuhood)AllScorer in boolean queries #2745 #2760 #2774(@fulmicoton @mdashti @trinity-1686a)seek_danger on DocSet for more efficient intersections #2538 #2810(@PSeitz @stuhood @fulmicoton)RangeDocSet when query range does not overlap with column bounds #2783(@ChangRui-Ryan)DocSets without intermediate union #2825(@PSeitz)fill_buffer and optimized TinySet #2863(@PSeitz)update edition to 2024 by @PSeitz in https://github.com/quickwit-oss/tantivy/pull/2620
TopDocs. by @stuhood in https://github.com/quickwit-oss/tantivy/pull/2642TopDocs::order_by_string_fast_field for duplicates by @stuhood in https://github.com/quickwit-oss/tantivy/pull/2673Full Changelog: https://github.com/quickwit-oss/tantivy/compare/0.24...0.25.0
TopDocs. #2642(@stuhood)Tantivy 0.24 will be backwards compatible with indices created with v0.22 and v0.21. The new minimum rust version will be 1.75. Tantivy 0.23 will be s
Tantivy 0.24 will be backwards compatible with indices created with v0.22 and v0.21. The new minimum rust version will be 1.75. Tantivy 0.23 will be skipped.
OwnedBytes debug panic #2512(@b41sh)Aggregation
Range Queries
RangeQuery it is autodetected) #2477(@PSeitz)add format backwards-compatibility tests #2485(@PSeitz)
add columnar format compatibility tests #2433(@PSeitz)
Improved snippet ranges algorithm #2474(@gezihuzi)
make find_field_with_default return json fields without path #2476(@trinity-1686a)
Make BooleanQuery support minimum_number_should_match #2405(@LebranceBW)
Make NUM_MERGE_THREADS configurable #2535(@Barre)
RegexPhraseQuery
RegexPhraseQuery supports phrase queries with regex. E.g. query "b.* b.* wolf" matches "big bad wolf". Slop is supported as well: "b.* wolf"~2 matches "big bad wolf" #2516(@PSeitz)
Optional Index in Multivalue Columnar Index For mostly empty multivalued indices there was a large overhead during creation when iterating all docids (merge case). This is alleviated by placing an optional index in the multivalued index to mark documents that have values. This will slightly increase space and access time. #2439(@PSeitz)
Store DateTime as nanoseconds in doc store DateTime in the doc store was truncated to microseconds previously. This removes this truncation, while still keeping backwards compatibility. #2486(@PSeitz)
Performance/Memory
Json Type
QueryParser
Exist queries match subpath fields #2558(@rdettai)
add access benchmark for columnar #2432(@PSeitz)
extend indexwriter proptests #2342(@PSeitz)
add bench & test for columnar merging #2428(@PSeitz)
Change in Executor API #2391(@fulmicoton)
Removed usage of num_cpus #2387(@fulmicoton)
use bingang for agg and stacker benchmark #2378#2492(@PSeitz)
cleanup top level exports #2382(@PSeitz)
make convert_to_fast_value_and_append_to_json_term pub #2370(@PSeitz)
remove JsonTermWriter #2238(@PSeitz)
validate sort by field type #2336(@PSeitz)
Fix trait bound of StoreReader::iter #2360(@adamreichold)
remove read_postings_no_deletes #2526(@PSeitz)
remove deprecated IntOptions and DateTime #2353(@PSeitz)
Tantivy 0.22 will be able to read indices created with Tantivy 0.21.
get_docids_for_value_range to panic. #2295(@fulmicoton)Field in FilterCollector #2196(@PSeitz)Tantivy documents as a trait: Index data directly without converting to tantivy types first #2071(@ChillFish8)
encode some part of posting list as -1 instead of direct values (smaller inverted indices) #2185(@trinity-1686a)
Aggregation
Add ExistsQuery to check documents that have a value #2160(@imotov)
Expose TopDocs::order_by_u64_field again #2282(@ditsuke)
Memory/Performance
QueryParser
Add shared search executor #2312(@MochiXu)
Truncate keys to u16::MAX in term hashmap #2299(@PSeitz)
report if a term matched when warming up posting list #2309(@trinity-1686a)
Support json fields in FuzzyTermQuery #2173(@PingXia-at)
Read list of fields encoded in term dictionary for JSON fields #2184(@PSeitz)
add collect_block to BoxableSegmentCollector #2331(@PSeitz)
expose collect_block buffer size #2326(@PSeitz)
Forward regex parser errors #2288(@adamreichold)
Make FacetCounts defaultable and cloneable. #2322(@adamreichold)
Derive Debug for SchemaBuilder #2254(@GodTamIt)
add missing inlines to tantivy options #2245(@PSeitz)
Full Changelog: https://github.com/quickwit-oss/tantivy/compare/0.21...v0.22.0
Fix track fast field memory consumption, which led to higher memory consumption than the budget allowed during indexing #2148#2147(@PSeitz)
FacetCollector. #2086(@adamreichold)Full Changelog: https://github.com/quickwit-oss/tantivy/compare/0.20.2...0.21
Fix phrase queries with slop (slop supports now transpositions, algorithm that carries slop so far for num terms > 2) #2031#2020(@PSeitz)
coerce option for text and numbers types (convert the value instead of returning an error during indexing) #1904 (@PSeitz)date_histogram aggregation (only fixed_interval for now) #1900 (@PSeitz)percentiles aggregations #1984 (@PSeitz)quickwit to send intermediate results) #1992 (@PSeitz)Searcher with disabled scoring via EnableScoring::Disabled #1780 (@shikhar)DatePrecision to DateTimePrecision #2051 (@guilload)Full Changelog: https://github.com/quickwit-oss/tantivy/blob/main/CHANGELOG.md
Fix missing fieldnorms for u64, i64, f64, bool, bytes and date #1620 (@PSeitz)
IN in queryparser , e.g. field: IN [val1 val2 val3] #1683 (@trinity-1686a)get_val(u32)) #1644 (@PSeitz)DateTime type has been updated to hold timestamps with microseconds precision.
DateOptions and DatePrecision have been added to configure Date fields. The precision is used to hint on fast values compression. Otherwise, seconds precision is used everywhere else (i.e terms, indexing) #1396 (@evanxg852000)Searcher cloneable. (@PSeitz)tantivy::TantivyError cloneable #1402 (@PSeitz)Full Changelog: https://github.com/quickwit-oss/tantivy/compare/0.18...0.19
For date values chrono has been replaced with time (@uklotzde) #1304
chrono has been replaced with time (@uklotzde) #1304 :
time crate is re-exported as tantivy::time instead of tantivy::chrono.tantivy::DateTime has been removed.Value::Date wraps time::PrimitiveDateTime without time zone information.time::OffsetDateTime to Value::Date implicitly converts the value into UTC.
If this is not desired do the time zone conversion yourself and use time::PrimitiveDateTime
directly instead.API Changes. Using Range instead of (start, end) in the API and internals (FileSlice, OwnedBytes, Snippets, ...) This change is breaking but migration
FileSlice, OwnedBytes, Snippets, ...)
This change is breaking but migration is trivial.Migrated tantivy error from the now deprecated failure crate to thiserror #760. (@hirevo)
failure crate to thiserror #760. (@hirevo)Schema::Value now returns an Option instead of panicking if the type does not match.FileSlice that can be reduced and eventually read into an OwnedBytes object. Long and blocking io operation are still required by they do not span over the entire file.Query::explainnotify #924. Replaced with FileWatcher struct that polls meta file every 500ms in background thread. (@halvorboe @guilload)FilterCollector, which wraps another collector and filters docs using a predicate over a fast field (@barrotsteindev)FilterCollector now supports all Fast Field value types (@barrotsteindev)This version breaks compatibility and requires users to reindex everything.
Tantivy 0.13 introduce a change in the index format that will require you to reindex your index (BlockWAND information are added in the skiplist). The
Tantivy 0.13 introduce a change in the index format that will require you to reindex your index (BlockWAND information are added in the skiplist). The index size increase is minor as this information is only added for full blocks. If you have a massive index for which reindexing is not an option, please contact me so that we can discuss possible solutions.
FuzzyTermQuery not matching terms by prefix when it should (@Peachball)MMapDirectory::open does not return a Result anymore..advance() returns the new DocId. Scorer::skip(target) has been replaced by Scorer::seek(target) and returns the resulting DocId.
As a result, iterating through DocSet now looks as followslet mut doc = docset.doc();
while doc != TERMINATED {
// ...
doc = docset.advance();
}
The change made it possible to greatly simplify a lot of the docset's code.
Scorer::for_each_pruning function. (@fulmicoton)Removing static dispatch in tokenizers for simplicity.
TermDictionary stream. (@halvorboe)TermDictionary stream. (@halvorboe)Crates relying on custom tokenizer, or registering tokenizer in the manager will require some minor changes. Check https://github.com/quickwit-oss/tantivy/blob/main/examples/custom_tokenizer.rs to check for some code sample.
Added f64 field. Internally reuse u64 code the same way i64 does (@fdb-hiroshima)
Box<BoxableTokenizer>. See detail in #629Box<dyn BoxableTokenizer> has been replaced by a BoxedTokenizer struct.RegexQuery instance is built. As a result, it can now return
an error and handling the Result is required.tantivy::version() now returns a Version object. This object implements ToString()One column per quarter.