├── .github ├── FUNDING.yml ├── ISSUE_TEMPLATE │ ├── actions.md │ ├── bug_report.md │ ├── feature_request.md │ └── question.md ├── dependabot.yml └── workflows │ ├── coverage.yml │ ├── long_running.yml │ └── test.yml ├── .gitignore ├── ARCHITECTURE.md ├── AUTHORS ├── CHANGELOG.md ├── CITATION.cff ├── Cargo.toml ├── LICENSE ├── Makefile ├── README.md ├── RELEASE.md ├── TODO.txt ├── benches ├── agg_bench.rs ├── alice.txt ├── analyzer.rs ├── gh.json ├── hdfs.json ├── index-bench.rs └── wiki.json ├── bitpacker ├── Cargo.toml ├── benches │ └── bench.rs └── src │ ├── bitpacker.rs │ ├── blocked_bitpacker.rs │ ├── filter_vec │ ├── avx2.rs │ ├── mod.rs │ └── scalar.rs │ └── lib.rs ├── cliff.toml ├── columnar ├── Cargo.toml ├── README.md ├── benches │ ├── bench_access.rs │ ├── bench_first_vals.rs │ ├── bench_merge.rs │ ├── bench_values_u128.rs │ ├── bench_values_u64.rs │ └── common.rs ├── columnar-cli-inspect │ ├── Cargo.toml │ └── src │ │ └── main.rs ├── columnar-cli │ ├── Cargo.toml │ └── src │ │ └── main.rs ├── compat_tests_data │ ├── v1.columnar │ └── v2.columnar └── src │ ├── TODO.md │ ├── block_accessor.rs │ ├── column │ ├── dictionary_encoded.rs │ ├── mod.rs │ └── serialize.rs │ ├── column_index │ ├── merge │ │ ├── mod.rs │ │ ├── shuffled.rs │ │ └── stacked.rs │ ├── mod.rs │ ├── multivalued_index.rs │ ├── optional_index │ │ ├── mod.rs │ │ ├── set.rs │ │ ├── set_block │ │ │ ├── dense.rs │ │ │ ├── mod.rs │ │ │ ├── sparse.rs │ │ │ └── tests.rs │ │ └── tests.rs │ └── serialize.rs │ ├── column_values │ ├── bench.rs │ ├── merge.rs │ ├── mod.rs │ ├── monotonic_column.rs │ ├── monotonic_mapping.rs │ ├── monotonic_mapping_u128.rs │ ├── stats.rs │ ├── u128_based │ │ ├── compact_space │ │ │ ├── blank_range.rs │ │ │ ├── build_compact_space.rs │ │ │ └── mod.rs │ │ └── mod.rs │ ├── u64_based │ │ ├── bitpacked.rs │ │ ├── blockwise_linear.rs │ │ ├── line.rs │ │ ├── linear.rs │ │ ├── mod.rs │ │ ├── stats_collector.rs │ │ └── tests.rs │ └── vec_column.rs │ ├── columnar │ ├── column_type.rs │ ├── format_version.rs │ ├── merge │ │ ├── merge_dict_column.rs │ │ ├── merge_mapping.rs │ │ ├── mod.rs │ │ ├── term_merger.rs │ │ └── tests.rs │ ├── mod.rs │ ├── reader │ │ └── mod.rs │ └── writer │ │ ├── column_operation.rs │ │ ├── column_writers.rs │ │ ├── mod.rs │ │ ├── serializer.rs │ │ └── value_index.rs │ ├── compat_tests.rs │ ├── dictionary.rs │ ├── dynamic_column.rs │ ├── iterable.rs │ ├── lib.rs │ ├── tests.rs │ ├── utils.rs │ └── value.rs ├── common ├── Cargo.toml ├── benches │ └── bench.rs └── src │ ├── bitset.rs │ ├── bounds.rs │ ├── byte_count.rs │ ├── datetime.rs │ ├── file_slice.rs │ ├── group_by.rs │ ├── json_path_writer.rs │ ├── lib.rs │ ├── serialize.rs │ ├── vint.rs │ └── writer.rs ├── doc ├── .gitignore ├── assets │ └── images │ │ ├── Nuclia.png │ │ ├── element-dark-theme.png │ │ ├── element.io.svg │ │ ├── etsy.png │ │ ├── humanfirst.ai-dark-theme.png │ │ ├── humanfirst.png │ │ ├── nuclia-dark-theme.png │ │ ├── paradedb.png │ │ └── searchbenchmark.png ├── book.toml └── src │ ├── SUMMARY.md │ ├── avant-propos.md │ ├── basis.md │ ├── best_practise.md.rs │ ├── examples.md │ ├── facetting.md │ ├── faq.md │ ├── index_sorting.md │ ├── innerworkings.md │ ├── inverted_index.md │ ├── json.md │ └── schema.md ├── examples ├── aggregation.rs ├── basic_search.rs ├── custom_collector.rs ├── custom_tokenizer.rs ├── date_time_field.rs ├── deleting_updating_documents.rs ├── faceted_search.rs ├── faceted_search_with_tweaked_score.rs ├── fuzzy_search.rs ├── index_from_multiple_threads.rs ├── index_with_json.rs ├── integer_range_search.rs ├── ip_field.rs ├── iterating_docs_and_positions.rs ├── json_field.rs ├── phrase_prefix_search.rs ├── pre_tokenized_text.rs ├── snippet.rs ├── stop_words.rs └── warmer.rs ├── ownedbytes ├── Cargo.toml └── src │ └── lib.rs ├── query-grammar ├── Cargo.toml ├── README.md └── src │ ├── infallible.rs │ ├── lib.rs │ ├── occur.rs │ ├── query_grammar.rs │ └── user_input_ast.rs ├── rustfmt.toml ├── src ├── aggregation │ ├── README.md │ ├── agg_limits.rs │ ├── agg_req.rs │ ├── agg_req_with_accessor.rs │ ├── agg_result.rs │ ├── agg_tests.rs │ ├── bucket │ │ ├── histogram │ │ │ ├── date_histogram.rs │ │ │ ├── histogram.rs │ │ │ └── mod.rs │ │ ├── mod.rs │ │ ├── range.rs │ │ ├── term_agg.rs │ │ └── term_missing_agg.rs │ ├── buf_collector.rs │ ├── collector.rs │ ├── date.rs │ ├── error.rs │ ├── intermediate_agg_result.rs │ ├── metric │ │ ├── average.rs │ │ ├── cardinality.rs │ │ ├── count.rs │ │ ├── extended_stats.rs │ │ ├── max.rs │ │ ├── min.rs │ │ ├── mod.rs │ │ ├── percentiles.rs │ │ ├── stats.rs │ │ ├── sum.rs │ │ └── top_hits.rs │ ├── mod.rs │ └── segment_agg_result.rs ├── collector │ ├── count_collector.rs │ ├── custom_score_top_collector.rs │ ├── docset_collector.rs │ ├── facet_collector.rs │ ├── filter_collector_wrapper.rs │ ├── histogram_collector.rs │ ├── mod.rs │ ├── multi_collector.rs │ ├── tests.rs │ ├── top_collector.rs │ ├── top_score_collector.rs │ └── tweak_score_top_collector.rs ├── compat_tests.rs ├── core │ ├── executor.rs │ ├── json_utils.rs │ ├── mod.rs │ ├── searcher.rs │ └── tests.rs ├── directory │ ├── composite_file.rs │ ├── directory.rs │ ├── directory_lock.rs │ ├── error.rs │ ├── file_watcher.rs │ ├── footer.rs │ ├── managed_directory.rs │ ├── mmap_directory.rs │ ├── mod.rs │ ├── ram_directory.rs │ ├── tests.rs │ └── watch_event_router.rs ├── docset.rs ├── error.rs ├── fastfield │ ├── alive_bitset.rs │ ├── error.rs │ ├── facet_reader.rs │ ├── mod.rs │ ├── readers.rs │ └── writer.rs ├── fieldnorm │ ├── code.rs │ ├── mod.rs │ ├── reader.rs │ ├── serializer.rs │ └── writer.rs ├── functional_test.rs ├── future_result.rs ├── index │ ├── index.rs │ ├── index_meta.rs │ ├── inverted_index_reader.rs │ ├── mod.rs │ ├── segment.rs │ ├── segment_component.rs │ ├── segment_id.rs │ └── segment_reader.rs ├── indexer │ ├── delete_queue.rs │ ├── doc_id_mapping.rs │ ├── doc_opstamp_mapping.rs │ ├── flat_map_with_buffer.rs │ ├── index_writer.rs │ ├── index_writer_status.rs │ ├── log_merge_policy.rs │ ├── merge_index_test.rs │ ├── merge_operation.rs │ ├── merge_policy.rs │ ├── merger.rs │ ├── mod.rs │ ├── operation.rs │ ├── path_to_unordered_id.rs │ ├── prepared_commit.rs │ ├── segment_entry.rs │ ├── segment_manager.rs │ ├── segment_register.rs │ ├── segment_serializer.rs │ ├── segment_updater.rs │ ├── segment_writer.rs │ ├── single_segment_index_writer.rs │ └── stamper.rs ├── lib.rs ├── macros.rs ├── positions │ ├── mod.rs │ ├── reader.rs │ └── serializer.rs ├── postings │ ├── block_search.rs │ ├── block_segment_postings.rs │ ├── compression │ │ ├── mod.rs │ │ └── vint.rs │ ├── indexing_context.rs │ ├── json_postings_writer.rs │ ├── loaded_postings.rs │ ├── mod.rs │ ├── per_field_postings_writer.rs │ ├── postings.rs │ ├── postings_writer.rs │ ├── recorder.rs │ ├── segment_postings.rs │ ├── serializer.rs │ ├── skip.rs │ └── term_info.rs ├── query │ ├── all_query.rs │ ├── automaton_weight.rs │ ├── bitset │ │ └── mod.rs │ ├── bm25.rs │ ├── boolean_query │ │ ├── block_wand.rs │ │ ├── boolean_query.rs │ │ ├── boolean_weight.rs │ │ └── mod.rs │ ├── boost_query.rs │ ├── const_score_query.rs │ ├── disjunction.rs │ ├── disjunction_max_query.rs │ ├── empty_query.rs │ ├── exclude.rs │ ├── exist_query.rs │ ├── explanation.rs │ ├── fuzzy_query.rs │ ├── intersection.rs │ ├── mod.rs │ ├── more_like_this │ │ ├── mod.rs │ │ ├── more_like_this.rs │ │ └── query.rs │ ├── phrase_prefix_query │ │ ├── mod.rs │ │ ├── phrase_prefix_query.rs │ │ ├── phrase_prefix_scorer.rs │ │ └── phrase_prefix_weight.rs │ ├── phrase_query │ │ ├── mod.rs │ │ ├── phrase_query.rs │ │ ├── phrase_scorer.rs │ │ ├── phrase_weight.rs │ │ ├── regex_phrase_query.rs │ │ └── regex_phrase_weight.rs │ ├── query.rs │ ├── query_parser │ │ ├── logical_ast.rs │ │ ├── mod.rs │ │ └── query_parser.rs │ ├── range_query │ │ ├── fast_field_range_doc_set.rs │ │ ├── mod.rs │ │ ├── range_query.rs │ │ └── range_query_fastfield.rs │ ├── regex_query.rs │ ├── reqopt_scorer.rs │ ├── score_combiner.rs │ ├── scorer.rs │ ├── set_query.rs │ ├── term_query │ │ ├── mod.rs │ │ ├── term_query.rs │ │ ├── term_scorer.rs │ │ └── term_weight.rs │ ├── union │ │ ├── bitset_union.rs │ │ ├── buffered_union.rs │ │ ├── mod.rs │ │ └── simple_union.rs │ ├── vec_docset.rs │ └── weight.rs ├── reader │ ├── mod.rs │ └── warming.rs ├── schema │ ├── bytes_options.rs │ ├── date_time_options.rs │ ├── document │ │ ├── de.rs │ │ ├── default_document.rs │ │ ├── existing_type_impls.rs │ │ ├── mod.rs │ │ ├── owned_value.rs │ │ ├── se.rs │ │ └── value.rs │ ├── facet.rs │ ├── facet_options.rs │ ├── field.rs │ ├── field_entry.rs │ ├── field_type.rs │ ├── flags.rs │ ├── index_record_option.rs │ ├── ip_options.rs │ ├── json_object_options.rs │ ├── mod.rs │ ├── named_field_document.rs │ ├── numeric_options.rs │ ├── schema.rs │ ├── term.rs │ └── text_options.rs ├── snippet │ └── mod.rs ├── space_usage │ └── mod.rs ├── store │ ├── compression_lz4_block.rs │ ├── compression_zstd_block.rs │ ├── compressors.rs │ ├── decompressors.rs │ ├── footer.rs │ ├── index │ │ ├── block.rs │ │ ├── mod.rs │ │ ├── skip_index.rs │ │ └── skip_index_builder.rs │ ├── mod.rs │ ├── reader.rs │ ├── store_compressor.rs │ └── writer.rs ├── termdict │ ├── fst_termdict │ │ ├── merger.rs │ │ ├── mod.rs │ │ ├── streamer.rs │ │ ├── term_info_store.rs │ │ └── termdict.rs │ ├── mod.rs │ ├── sstable_termdict │ │ ├── merger.rs │ │ └── mod.rs │ └── tests.rs └── tokenizer │ ├── alphanum_only.rs │ ├── ascii_folding_filter.rs │ ├── empty_tokenizer.rs │ ├── facet_tokenizer.rs │ ├── lower_caser.rs │ ├── mod.rs │ ├── ngram_tokenizer.rs │ ├── raw_tokenizer.rs │ ├── regex_tokenizer.rs │ ├── remove_long.rs │ ├── simple_tokenizer.rs │ ├── split_compound_words.rs │ ├── stemmer.rs │ ├── stop_word_filter │ ├── gen_stopwords.py │ ├── mod.rs │ └── stopwords.rs │ ├── tokenized_string.rs │ ├── tokenizer.rs │ ├── tokenizer_manager.rs │ └── whitespace_tokenizer.rs ├── sstable ├── Cargo.toml ├── README.md ├── benches │ ├── ord_to_term.rs │ └── stream_bench.rs └── src │ ├── block_match_automaton.rs │ ├── block_reader.rs │ ├── delta.rs │ ├── dictionary.rs │ ├── lib.rs │ ├── merge │ ├── heap_merge.rs │ └── mod.rs │ ├── sstable_index_v2.rs │ ├── sstable_index_v3.rs │ ├── streamer.rs │ ├── value │ ├── index.rs │ ├── mod.rs │ ├── range.rs │ ├── u64_monotonic.rs │ └── void.rs │ └── vint.rs ├── stacker ├── Cargo.toml ├── Performance.md ├── benches │ └── bench.rs ├── example │ └── hashmap.rs ├── fuzz_test │ ├── Cargo.toml │ └── src │ │ └── main.rs └── src │ ├── arena_hashmap.rs │ ├── expull.rs │ ├── fastcmp.rs │ ├── fastcpy.rs │ ├── lib.rs │ ├── memory_arena.rs │ └── shared_arena_hashmap.rs ├── tests ├── compat_tests_data │ ├── index_v6 │ │ ├── .managed.json │ │ ├── .tantivy-meta.lock │ │ ├── .tantivy-writer.lock │ │ ├── 00000000000000000000000000000000.fast │ │ ├── 00000000000000000000000000000000.fieldnorm │ │ ├── 00000000000000000000000000000000.idx │ │ ├── 00000000000000000000000000000000.pos │ │ ├── 00000000000000000000000000000000.store │ │ ├── 00000000000000000000000000000000.term │ │ └── meta.json │ └── index_v7 │ │ ├── .managed.json │ │ ├── .tantivy-meta.lock │ │ ├── .tantivy-writer.lock │ │ ├── 000002f0000000000000000000000000.fast │ │ ├── 000002f0000000000000000000000000.fieldnorm │ │ ├── 000002f0000000000000000000000000.idx │ │ ├── 000002f0000000000000000000000000.pos │ │ ├── 000002f0000000000000000000000000.store │ │ ├── 000002f0000000000000000000000000.term │ │ └── meta.json └── failpoints │ └── mod.rs └── tokenizer-api ├── Cargo.toml ├── README.md └── src └── lib.rs /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | # These are supported funding model platforms 2 | 3 | github: fulmicoton 4 | patreon: # Replace with a single Patreon username 5 | open_collective: # Replace with a single Open Collective username 6 | ko_fi: # Replace with a single Ko-fi username 7 | tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel 8 | community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry 9 | liberapay: # Replace with a single Liberapay username 10 | issuehunt: # Replace with a single IssueHunt username 11 | otechie: # Replace with a single Otechie username 12 | custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2'] 13 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/actions.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Actions 3 | about: Actions not directly related to producing code. 4 | 5 | --- 6 | 7 | # Actions title 8 | 9 | Action description. 10 | e.g. 11 | - benchmark 12 | - investigate and report 13 | - etc. 14 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/bug_report.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bug report 3 | about: Create a report to help us improve 4 | 5 | --- 6 | 7 | **Describe the bug** 8 | - What did you do? 9 | - What happened? 10 | - What was expected? 11 | 12 | **Which version of tantivy are you using?** 13 | If "master", ideally give the specific sha1 revision. 14 | 15 | **To Reproduce** 16 | 17 | If your bug is deterministic, can you give a minimal reproducing code? 18 | Some bugs are not deterministic. Can you describe with precision in which context it happened? 19 | If this is possible, can you share your code? 20 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature_request.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Feature request 3 | about: Suggest an idea for this project 4 | 5 | --- 6 | 7 | **Is your feature request related to a problem? Please describe.** 8 | A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] 9 | 10 | **Describe the solution you'd like** 11 | A clear and concise description of what you want to happen. 12 | 13 | **[Optional] describe alternatives you've considered** 14 | A clear and concise description of any alternative solutions or features you've considered. 15 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/question.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Question 3 | about: Ask any question about tantivy's usage... 4 | 5 | --- 6 | 7 | Try to be specific about your use case... 8 | -------------------------------------------------------------------------------- /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | version: 2 2 | updates: 3 | - package-ecosystem: cargo 4 | directory: "/" 5 | schedule: 6 | interval: daily 7 | time: "20:00" 8 | open-pull-requests-limit: 10 9 | 10 | - package-ecosystem: "github-actions" 11 | directory: "/" 12 | schedule: 13 | interval: daily 14 | time: "20:00" 15 | open-pull-requests-limit: 10 16 | -------------------------------------------------------------------------------- /.github/workflows/coverage.yml: -------------------------------------------------------------------------------- 1 | name: Coverage 2 | 3 | on: 4 | push: 5 | branches: [main] 6 | 7 | # Ensures that we cancel running jobs for the same PR / same workflow. 8 | concurrency: 9 | group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }} 10 | cancel-in-progress: true 11 | 12 | jobs: 13 | coverage: 14 | runs-on: ubuntu-latest 15 | steps: 16 | - uses: actions/checkout@v4 17 | - name: Install Rust 18 | run: rustup toolchain install nightly-2024-07-01 --profile minimal --component llvm-tools-preview 19 | - uses: Swatinem/rust-cache@v2 20 | - uses: taiki-e/install-action@cargo-llvm-cov 21 | - name: Generate code coverage 22 | run: cargo +nightly-2024-07-01 llvm-cov --all-features --workspace --doctests --lcov --output-path lcov.info 23 | - name: Upload coverage to Codecov 24 | uses: codecov/codecov-action@v3 25 | continue-on-error: true 26 | with: 27 | token: ${{ secrets.CODECOV_TOKEN }} # not required for public repos 28 | files: lcov.info 29 | fail_ci_if_error: true 30 | -------------------------------------------------------------------------------- /.github/workflows/long_running.yml: -------------------------------------------------------------------------------- 1 | name: Long running tests 2 | 3 | on: 4 | push: 5 | branches: [ main ] 6 | 7 | env: 8 | CARGO_TERM_COLOR: always 9 | NUM_FUNCTIONAL_TEST_ITERATIONS: 20000 10 | 11 | # Ensures that we cancel running jobs for the same PR / same workflow. 12 | concurrency: 13 | group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }} 14 | cancel-in-progress: true 15 | 16 | jobs: 17 | test: 18 | 19 | runs-on: ubuntu-latest 20 | 21 | steps: 22 | - uses: actions/checkout@v4 23 | - name: Install stable 24 | uses: actions-rs/toolchain@v1 25 | with: 26 | toolchain: stable 27 | profile: minimal 28 | override: true 29 | 30 | - name: Run indexing_unsorted 31 | run: cargo test indexing_unsorted -- --ignored 32 | - name: Run indexing_sorted 33 | run: cargo test indexing_sorted -- --ignored 34 | -------------------------------------------------------------------------------- /.github/workflows/test.yml: -------------------------------------------------------------------------------- 1 | name: Unit tests 2 | 3 | on: 4 | push: 5 | branches: [ main ] 6 | pull_request: 7 | branches: [ main ] 8 | 9 | env: 10 | CARGO_TERM_COLOR: always 11 | 12 | # Ensures that we cancel running jobs for the same PR / same workflow. 13 | concurrency: 14 | group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }} 15 | cancel-in-progress: true 16 | 17 | jobs: 18 | check: 19 | 20 | runs-on: ubuntu-latest 21 | 22 | steps: 23 | - uses: actions/checkout@v4 24 | 25 | - name: Install nightly 26 | uses: actions-rs/toolchain@v1 27 | with: 28 | toolchain: nightly 29 | profile: minimal 30 | components: rustfmt 31 | - name: Install stable 32 | uses: actions-rs/toolchain@v1 33 | with: 34 | toolchain: stable 35 | profile: minimal 36 | components: clippy 37 | 38 | - uses: Swatinem/rust-cache@v2 39 | 40 | - name: Check Formatting 41 | run: cargo +nightly fmt --all -- --check 42 | 43 | - name: Check Stable Compilation 44 | run: cargo build --all-features 45 | 46 | 47 | - name: Check Bench Compilation 48 | run: cargo +nightly bench --no-run --profile=dev --all-features 49 | 50 | - uses: actions-rs/clippy-check@v1 51 | with: 52 | toolchain: stable 53 | token: ${{ secrets.GITHUB_TOKEN }} 54 | args: --tests 55 | 56 | test: 57 | 58 | runs-on: ubuntu-latest 59 | 60 | strategy: 61 | matrix: 62 | features: [ 63 | { label: "all", flags: "mmap,stopwords,lz4-compression,zstd-compression,failpoints" }, 64 | { label: "quickwit", flags: "mmap,quickwit,failpoints" } 65 | ] 66 | 67 | name: test-${{ matrix.features.label}} 68 | 69 | steps: 70 | - uses: actions/checkout@v4 71 | 72 | - name: Install stable 73 | uses: actions-rs/toolchain@v1 74 | with: 75 | toolchain: stable 76 | profile: minimal 77 | override: true 78 | 79 | - uses: taiki-e/install-action@nextest 80 | - uses: Swatinem/rust-cache@v2 81 | 82 | - name: Run tests 83 | run: cargo +stable nextest run --features ${{ matrix.features.flags }} --verbose --workspace 84 | 85 | - name: Run doctests 86 | run: cargo +stable test --doc --features ${{ matrix.features.flags }} --verbose --workspace 87 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | tantivy.iml 2 | .cargo 3 | proptest-regressions 4 | *.swp 5 | target 6 | target/debug 7 | .vscode 8 | target/release 9 | Cargo.lock 10 | benchmark 11 | .DS_Store 12 | *.bk 13 | .idea 14 | trace.dat 15 | cargo-timing* 16 | control 17 | variable 18 | -------------------------------------------------------------------------------- /AUTHORS: -------------------------------------------------------------------------------- 1 | # This is the list of authors of tantivy for copyright purposes. 2 | Paul Masurel 3 | Laurentiu Nicola 4 | Dru Sellers 5 | Ashley Mannix 6 | Michael J. Curry 7 | Jason Wolfe 8 | # As an employee of Google I am required to add Google LLC 9 | # in the list of authors, but this project is not affiliated to Google 10 | # in any other way. 11 | Google LLC 12 | -------------------------------------------------------------------------------- /CITATION.cff: -------------------------------------------------------------------------------- 1 | cff-version: 1.2.0 2 | message: "If you use this software, please cite it as below." 3 | authors: 4 | - alias: Quickwit Inc. 5 | website: "https://quickwit.io" 6 | title: "tantivy" 7 | version: 0.22.0 8 | doi: 10.5281/zenodo.13942948 9 | date-released: 2024-10-17 10 | url: "https://github.com/quickwit-oss/tantivy" 11 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Copyright (c) 2018 by the project authors, as listed in the AUTHORS file. 2 | 3 | Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: 4 | 5 | The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. 6 | 7 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 8 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | test: 2 | @echo "Run test only... No examples." 3 | cargo test --tests --lib 4 | 5 | fmt: 6 | cargo +nightly fmt --all 7 | -------------------------------------------------------------------------------- /RELEASE.md: -------------------------------------------------------------------------------- 1 | # Release a new Tantivy Version 2 | 3 | ## Steps 4 | 5 | 1. Identify new packages in workspace since last release 6 | 2. Identify changed packages in workspace since last release 7 | 3. Bump version in `Cargo.toml` and their dependents for all changed packages 8 | 4. Update version of root `Cargo.toml` 9 | 5. Publish version starting with leaf nodes 10 | 6. Set git tag with new version 11 | 12 | 13 | In conjucation with `cargo-release` Steps 1-4 (I'm not sure if the change detection works): 14 | Set new packages to version 0.0.0 15 | 16 | Replace prev-tag-name 17 | ```bash 18 | cargo release --workspace --no-publish -v --prev-tag-name 0.19 --push-remote origin minor --no-tag --execute 19 | ``` 20 | 21 | no-tag or it will create tags for all the subpackages 22 | -------------------------------------------------------------------------------- /TODO.txt: -------------------------------------------------------------------------------- 1 | Make schema_builder API fluent. 2 | fix doc serialization and prevent compression problems 3 | 4 | u64 , etc. should return Result