blob: 4adbfd776cfcb7d2298ecbfb4e785c70f2d2601c [file] [log] [blame]
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `/root/.cargo/git/checkouts/tantivy-65d0bbbddbbd5d02/433372d/src/indexer/mod.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>mod.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../../normalize.css"><link rel="stylesheet" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../../ayu.css" disabled><link rel="stylesheet" href="../../../dark.css" disabled><link rel="stylesheet" href="../../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../../storage.js"></script><script defer src="../../../source-script.js"></script><script defer src="../../../source-files.js"></script><script defer src="../../../main.js"></script><noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../../tantivy/index.html"><div class="logo-container">
<img src="http://fulmicoton.com/tantivy-logo/tantivy-logo.png" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../../tantivy/index.html">
<img src="http://fulmicoton.com/tantivy-logo/tantivy-logo.png" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span>
<span id="2">2</span>
<span id="3">3</span>
<span id="4">4</span>
<span id="5">5</span>
<span id="6">6</span>
<span id="7">7</span>
<span id="8">8</span>
<span id="9">9</span>
<span id="10">10</span>
<span id="11">11</span>
<span id="12">12</span>
<span id="13">13</span>
<span id="14">14</span>
<span id="15">15</span>
<span id="16">16</span>
<span id="17">17</span>
<span id="18">18</span>
<span id="19">19</span>
<span id="20">20</span>
<span id="21">21</span>
<span id="22">22</span>
<span id="23">23</span>
<span id="24">24</span>
<span id="25">25</span>
<span id="26">26</span>
<span id="27">27</span>
<span id="28">28</span>
<span id="29">29</span>
<span id="30">30</span>
<span id="31">31</span>
<span id="32">32</span>
<span id="33">33</span>
<span id="34">34</span>
<span id="35">35</span>
<span id="36">36</span>
<span id="37">37</span>
<span id="38">38</span>
<span id="39">39</span>
<span id="40">40</span>
<span id="41">41</span>
<span id="42">42</span>
<span id="43">43</span>
<span id="44">44</span>
<span id="45">45</span>
<span id="46">46</span>
<span id="47">47</span>
<span id="48">48</span>
<span id="49">49</span>
<span id="50">50</span>
<span id="51">51</span>
<span id="52">52</span>
<span id="53">53</span>
<span id="54">54</span>
<span id="55">55</span>
<span id="56">56</span>
<span id="57">57</span>
<span id="58">58</span>
<span id="59">59</span>
<span id="60">60</span>
<span id="61">61</span>
<span id="62">62</span>
<span id="63">63</span>
<span id="64">64</span>
<span id="65">65</span>
<span id="66">66</span>
<span id="67">67</span>
<span id="68">68</span>
<span id="69">69</span>
<span id="70">70</span>
<span id="71">71</span>
<span id="72">72</span>
<span id="73">73</span>
<span id="74">74</span>
<span id="75">75</span>
<span id="76">76</span>
<span id="77">77</span>
<span id="78">78</span>
<span id="79">79</span>
<span id="80">80</span>
<span id="81">81</span>
<span id="82">82</span>
<span id="83">83</span>
<span id="84">84</span>
<span id="85">85</span>
<span id="86">86</span>
<span id="87">87</span>
<span id="88">88</span>
<span id="89">89</span>
<span id="90">90</span>
<span id="91">91</span>
<span id="92">92</span>
<span id="93">93</span>
<span id="94">94</span>
<span id="95">95</span>
<span id="96">96</span>
<span id="97">97</span>
<span id="98">98</span>
<span id="99">99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
</pre><pre class="rust"><code><span class="kw">pub mod </span>delete_queue;
<span class="kw">pub mod </span>demuxer;
<span class="kw">pub mod </span>doc_id_mapping;
<span class="kw">mod </span>doc_opstamp_mapping;
<span class="kw">mod </span>flat_map_with_buffer;
<span class="kw">pub mod </span>index_writer;
<span class="kw">mod </span>index_writer_status;
<span class="kw">mod </span>json_term_writer;
<span class="kw">mod </span>log_merge_policy;
<span class="kw">mod </span>merge_operation;
<span class="kw">pub mod </span>merge_policy;
<span class="kw">pub mod </span>merger;
<span class="kw">mod </span>merger_sorted_index_test;
<span class="kw">pub mod </span>operation;
<span class="kw">pub mod </span>prepared_commit;
<span class="kw">mod </span>segment_entry;
<span class="kw">mod </span>segment_manager;
<span class="kw">mod </span>segment_register;
<span class="kw">pub mod </span>segment_serializer;
<span class="kw">pub mod </span>segment_updater;
<span class="kw">mod </span>segment_writer;
<span class="kw">mod </span>sorted_doc_id_column;
<span class="kw">mod </span>sorted_doc_id_multivalue_column;
<span class="kw">mod </span>stamper;
<span class="kw">use </span>crossbeam_channel <span class="kw">as </span>channel;
<span class="kw">use </span>smallvec::SmallVec;
<span class="kw">pub use </span><span class="self">self</span>::index_writer::IndexWriter;
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">use </span><span class="self">self</span>::json_term_writer::{
convert_to_fast_value_and_get_term, set_string_and_get_terms, JsonTermWriter,
};
<span class="kw">pub use </span><span class="self">self</span>::log_merge_policy::LogMergePolicy;
<span class="kw">pub use </span><span class="self">self</span>::merge_operation::MergeOperation;
<span class="kw">pub use </span><span class="self">self</span>::merge_policy::{MergeCandidate, MergePolicy, NoMergePolicy};
<span class="kw">pub use </span><span class="self">self</span>::prepared_commit::PreparedCommit;
<span class="kw">pub use </span><span class="self">self</span>::segment_entry::SegmentEntry;
<span class="kw">pub use </span><span class="self">self</span>::segment_manager::SegmentManager;
<span class="kw">pub use </span><span class="self">self</span>::segment_serializer::SegmentSerializer;
<span class="kw">pub use </span><span class="self">self</span>::segment_updater::{merge_filtered_segments, merge_indices};
<span class="kw">pub use </span><span class="self">self</span>::segment_writer::SegmentWriter;
<span class="kw">use </span><span class="kw">crate</span>::indexer::operation::AddOperation;
<span class="doccomment">/// Alias for the default merge policy, which is the `LogMergePolicy`.
</span><span class="kw">pub type </span>DefaultMergePolicy = LogMergePolicy;
<span class="comment">// Batch of documents.
// Most of the time, users will send operation one-by-one, but it can be useful to
// send them as a small block to ensure that
// - all docs in the operation will happen on the same segment and continuous doc_ids.
// - all operations in the group are committed at the same time, making the group
// atomic.
</span><span class="kw">type </span>AddBatch = SmallVec&lt;[AddOperation; <span class="number">4</span>]&gt;;
<span class="kw">type </span>AddBatchSender = channel::Sender&lt;AddBatch&gt;;
<span class="kw">type </span>AddBatchReceiver = channel::Receiver&lt;AddBatch&gt;;
<span class="attribute">#[cfg(feature = <span class="string">&quot;mmap&quot;</span>)]
#[cfg(test)]
</span><span class="kw">mod </span>tests_mmap {
<span class="kw">use </span><span class="kw">crate</span>::collector::Count;
<span class="kw">use </span><span class="kw">crate</span>::query::QueryParser;
<span class="kw">use </span><span class="kw">crate</span>::schema::{JsonObjectOptions, Schema, TEXT};
<span class="kw">use crate</span>::{Index, Term};
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_advance_delete_bug() -&gt; <span class="kw">crate</span>::Result&lt;()&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>schema_builder = Schema::builder();
<span class="kw">let </span>text_field = schema_builder.add_text_field(<span class="string">&quot;text&quot;</span>, TEXT);
<span class="kw">let </span>index = Index::create_from_tempdir(schema_builder.build())<span class="question-mark">?</span>;
<span class="kw">let </span><span class="kw-2">mut </span>index_writer = index.writer_for_tests()<span class="question-mark">?</span>;
<span class="comment">// there must be one deleted document in the segment
</span>index_writer.add_document(<span class="macro">doc!</span>(text_field=&gt;<span class="string">&quot;b&quot;</span>))<span class="question-mark">?</span>;
index_writer.delete_term(Term::from_field_text(text_field, <span class="string">&quot;b&quot;</span>));
<span class="comment">// we need enough data to trigger the bug (at least 32 documents)
</span><span class="kw">for _ in </span><span class="number">0</span>..<span class="number">32 </span>{
index_writer.add_document(<span class="macro">doc!</span>(text_field=&gt;<span class="string">&quot;c&quot;</span>))<span class="question-mark">?</span>;
}
index_writer.commit()<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(())
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_json_field_expand_dots_disabled_dot_escaped_required() {
<span class="kw">let </span><span class="kw-2">mut </span>schema_builder = Schema::builder();
<span class="kw">let </span>json_field = schema_builder.add_json_field(<span class="string">&quot;json&quot;</span>, TEXT);
<span class="kw">let </span>index = Index::create_in_ram(schema_builder.build());
<span class="kw">let </span><span class="kw-2">mut </span>index_writer = index.writer_for_tests().unwrap();
<span class="kw">let </span>json = <span class="macro">serde_json::json!</span>({<span class="string">&quot;k8s.container.name&quot;</span>: <span class="string">&quot;prometheus&quot;</span>, <span class="string">&quot;val&quot;</span>: <span class="string">&quot;hello&quot;</span>});
index_writer.add_document(<span class="macro">doc!</span>(json_field=&gt;json)).unwrap();
index_writer.commit().unwrap();
<span class="kw">let </span>reader = index.reader().unwrap();
<span class="kw">let </span>searcher = reader.searcher();
<span class="macro">assert_eq!</span>(searcher.num_docs(), <span class="number">1</span>);
<span class="kw">let </span>parse_query = QueryParser::for_index(<span class="kw-2">&amp;</span>index, Vec::new());
<span class="kw">let </span>query = parse_query
.parse_query(<span class="string">r#&quot;json.k8s\.container\.name:prometheus&quot;#</span>)
.unwrap();
<span class="kw">let </span>num_docs = searcher.search(<span class="kw-2">&amp;</span>query, <span class="kw-2">&amp;</span>Count).unwrap();
<span class="macro">assert_eq!</span>(num_docs, <span class="number">1</span>);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_json_field_expand_dots_enabled_dot_escape_not_required() {
<span class="kw">let </span><span class="kw-2">mut </span>schema_builder = Schema::builder();
<span class="kw">let </span>json_options: JsonObjectOptions =
JsonObjectOptions::from(TEXT).set_expand_dots_enabled();
<span class="kw">let </span>json_field = schema_builder.add_json_field(<span class="string">&quot;json&quot;</span>, json_options);
<span class="kw">let </span>index = Index::create_in_ram(schema_builder.build());
<span class="kw">let </span><span class="kw-2">mut </span>index_writer = index.writer_for_tests().unwrap();
<span class="kw">let </span>json = <span class="macro">serde_json::json!</span>({<span class="string">&quot;k8s.container.name&quot;</span>: <span class="string">&quot;prometheus&quot;</span>, <span class="string">&quot;val&quot;</span>: <span class="string">&quot;hello&quot;</span>});
index_writer.add_document(<span class="macro">doc!</span>(json_field=&gt;json)).unwrap();
index_writer.commit().unwrap();
<span class="kw">let </span>reader = index.reader().unwrap();
<span class="kw">let </span>searcher = reader.searcher();
<span class="macro">assert_eq!</span>(searcher.num_docs(), <span class="number">1</span>);
<span class="kw">let </span>parse_query = QueryParser::for_index(<span class="kw-2">&amp;</span>index, Vec::new());
<span class="kw">let </span>query = parse_query
.parse_query(<span class="string">r#&quot;json.k8s.container.name:prometheus&quot;#</span>)
.unwrap();
<span class="kw">let </span>num_docs = searcher.search(<span class="kw-2">&amp;</span>query, <span class="kw-2">&amp;</span>Count).unwrap();
<span class="macro">assert_eq!</span>(num_docs, <span class="number">1</span>);
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="tantivy" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>