Skip to main content

hermes_core/index/
mod.rs

1//! Index - multi-segment async search index
2//!
3//! The `Index` is the central concept that provides:
4//! - `Index::create()` / `Index::open()` - create or open an index
5//! - `index.writer()` - get an IndexWriter for adding documents
6//! - `index.reader()` - get an IndexReader for searching (with reload policy)
7//!
8//! The Index owns the SegmentManager which handles segment lifecycle and tracking.
9
10#[cfg(feature = "native")]
11use crate::dsl::Schema;
12#[cfg(feature = "native")]
13use crate::error::Result;
14#[cfg(feature = "native")]
15use crate::structures::{CoarseCentroids, PQCodebook};
16#[cfg(feature = "native")]
17use rustc_hash::FxHashMap;
18#[cfg(feature = "native")]
19use std::sync::Arc;
20
21mod searcher;
22pub use searcher::Searcher;
23
24#[cfg(feature = "native")]
25mod reader;
26#[cfg(feature = "native")]
27mod vector_builder;
28#[cfg(feature = "native")]
29mod writer;
30#[cfg(feature = "native")]
31pub use reader::IndexReader;
32#[cfg(feature = "native")]
33pub use writer::IndexWriter;
34
35mod metadata;
36pub use metadata::{FieldVectorMeta, INDEX_META_FILENAME, IndexMetadata, VectorIndexState};
37
38#[cfg(feature = "native")]
39mod helpers;
40#[cfg(feature = "native")]
41pub use helpers::{
42    IndexingStats, SchemaConfig, SchemaFieldConfig, create_index_at_path, create_index_from_sdl,
43    index_documents_from_reader, index_json_document, parse_schema,
44};
45
46/// Default file name for the slice cache
47pub const SLICE_CACHE_FILENAME: &str = "index.slicecache";
48
49/// Index configuration
50#[derive(Debug, Clone)]
51pub struct IndexConfig {
52    /// Number of threads for CPU-intensive tasks (search parallelism)
53    pub num_threads: usize,
54    /// Number of parallel segment builders (documents distributed round-robin)
55    pub num_indexing_threads: usize,
56    /// Number of threads for parallel block compression within each segment
57    pub num_compression_threads: usize,
58    /// Block cache size for term dictionary per segment
59    pub term_cache_blocks: usize,
60    /// Block cache size for document store per segment
61    pub store_cache_blocks: usize,
62    /// Max memory (bytes) across all builders before auto-commit (global limit)
63    pub max_indexing_memory_bytes: usize,
64    /// Merge policy for background segment merging
65    pub merge_policy: Box<dyn crate::merge::MergePolicy>,
66    /// Index optimization mode (adaptive, size-optimized, performance-optimized)
67    pub optimization: crate::structures::IndexOptimization,
68    /// Reload interval in milliseconds for IndexReader (how often to check for new segments)
69    pub reload_interval_ms: u64,
70}
71
72impl Default for IndexConfig {
73    fn default() -> Self {
74        #[cfg(feature = "native")]
75        let cpus = num_cpus::get().max(1);
76        #[cfg(not(feature = "native"))]
77        let cpus = 1;
78
79        Self {
80            num_threads: cpus,
81            num_indexing_threads: 1,
82            num_compression_threads: cpus,
83            term_cache_blocks: 256,
84            store_cache_blocks: 32,
85            max_indexing_memory_bytes: 256 * 1024 * 1024, // 256 MB default
86            merge_policy: Box::new(crate::merge::TieredMergePolicy::default()),
87            optimization: crate::structures::IndexOptimization::default(),
88            reload_interval_ms: 1000, // 1 second default
89        }
90    }
91}
92
93/// Multi-segment async Index
94///
95/// The central concept for search. Owns segment lifecycle and provides:
96/// - `Index::create()` / `Index::open()` - create or open an index
97/// - `index.writer()` - get an IndexWriter for adding documents
98/// - `index.reader()` - get an IndexReader for searching with reload policy
99///
100/// All segment management is delegated to SegmentManager.
101#[cfg(feature = "native")]
102pub struct Index<D: crate::directories::DirectoryWriter + 'static> {
103    directory: Arc<D>,
104    schema: Arc<Schema>,
105    config: IndexConfig,
106    /// Segment manager - owns segments, tracker, and metadata
107    segment_manager: Arc<crate::merge::SegmentManager<D>>,
108    /// Trained centroids for vector search
109    trained_centroids: FxHashMap<u32, Arc<CoarseCentroids>>,
110    /// Trained codebooks for vector search
111    trained_codebooks: FxHashMap<u32, Arc<PQCodebook>>,
112    /// Cached reader (created lazily, reused across calls)
113    cached_reader: tokio::sync::OnceCell<IndexReader<D>>,
114}
115
116#[cfg(feature = "native")]
117impl<D: crate::directories::DirectoryWriter + 'static> Index<D> {
118    /// Create a new index in the directory
119    pub async fn create(directory: D, schema: Schema, config: IndexConfig) -> Result<Self> {
120        let directory = Arc::new(directory);
121        let schema = Arc::new(schema);
122        let metadata = IndexMetadata::new((*schema).clone());
123
124        let segment_manager = Arc::new(crate::merge::SegmentManager::new(
125            Arc::clone(&directory),
126            Arc::clone(&schema),
127            metadata,
128            config.merge_policy.clone_box(),
129            config.term_cache_blocks,
130        ));
131
132        // Save initial metadata
133        segment_manager.update_metadata(|_| {}).await?;
134
135        Ok(Self {
136            directory,
137            schema,
138            config,
139            segment_manager,
140            trained_centroids: FxHashMap::default(),
141            trained_codebooks: FxHashMap::default(),
142            cached_reader: tokio::sync::OnceCell::new(),
143        })
144    }
145
146    /// Open an existing index from a directory
147    pub async fn open(directory: D, config: IndexConfig) -> Result<Self> {
148        let directory = Arc::new(directory);
149
150        // Load metadata (includes schema)
151        let metadata = IndexMetadata::load(directory.as_ref()).await?;
152        let schema = Arc::new(metadata.schema.clone());
153
154        // Load trained structures
155        let (trained_centroids, trained_codebooks) =
156            metadata.load_trained_structures(directory.as_ref()).await;
157
158        let segment_manager = Arc::new(crate::merge::SegmentManager::new(
159            Arc::clone(&directory),
160            Arc::clone(&schema),
161            metadata,
162            config.merge_policy.clone_box(),
163            config.term_cache_blocks,
164        ));
165
166        Ok(Self {
167            directory,
168            schema,
169            config,
170            segment_manager,
171            trained_centroids,
172            trained_codebooks,
173            cached_reader: tokio::sync::OnceCell::new(),
174        })
175    }
176
177    /// Get the schema
178    pub fn schema(&self) -> &Schema {
179        &self.schema
180    }
181
182    /// Get a reference to the underlying directory
183    pub fn directory(&self) -> &D {
184        &self.directory
185    }
186
187    /// Get the segment manager
188    pub fn segment_manager(&self) -> &Arc<crate::merge::SegmentManager<D>> {
189        &self.segment_manager
190    }
191
192    /// Get an IndexReader for searching (with reload policy)
193    ///
194    /// The reader is cached and reused across calls. The reader's internal
195    /// searcher will reload segments based on its reload interval (configurable via IndexConfig).
196    pub async fn reader(&self) -> Result<&IndexReader<D>> {
197        self.cached_reader
198            .get_or_try_init(|| async {
199                IndexReader::from_segment_manager_with_reload_interval(
200                    Arc::clone(&self.schema),
201                    Arc::clone(&self.segment_manager),
202                    self.trained_centroids.clone(),
203                    self.trained_codebooks.clone(),
204                    self.config.term_cache_blocks,
205                    self.config.reload_interval_ms,
206                )
207                .await
208            })
209            .await
210    }
211
212    /// Get the config
213    pub fn config(&self) -> &IndexConfig {
214        &self.config
215    }
216
217    /// Get trained centroids
218    pub fn trained_centroids(&self) -> &FxHashMap<u32, Arc<CoarseCentroids>> {
219        &self.trained_centroids
220    }
221
222    /// Get trained codebooks
223    pub fn trained_codebooks(&self) -> &FxHashMap<u32, Arc<PQCodebook>> {
224        &self.trained_codebooks
225    }
226
227    /// Get segment readers for query execution (convenience method)
228    pub async fn segment_readers(&self) -> Result<Vec<Arc<crate::segment::SegmentReader>>> {
229        let reader = self.reader().await?;
230        let searcher = reader.searcher().await?;
231        Ok(searcher.segment_readers().to_vec())
232    }
233
234    /// Total number of documents across all segments
235    pub async fn num_docs(&self) -> Result<u32> {
236        let reader = self.reader().await?;
237        let searcher = reader.searcher().await?;
238        Ok(searcher.num_docs())
239    }
240
241    /// Get a document by global doc_id
242    pub async fn doc(&self, doc_id: crate::DocId) -> Result<Option<crate::dsl::Document>> {
243        let reader = self.reader().await?;
244        let searcher = reader.searcher().await?;
245        searcher.doc(doc_id).await
246    }
247
248    /// Get default fields for search
249    pub fn default_fields(&self) -> Vec<crate::Field> {
250        if !self.schema.default_fields().is_empty() {
251            self.schema.default_fields().to_vec()
252        } else {
253            self.schema
254                .fields()
255                .filter(|(_, entry)| {
256                    entry.indexed && entry.field_type == crate::dsl::FieldType::Text
257                })
258                .map(|(field, _)| field)
259                .collect()
260        }
261    }
262
263    /// Get tokenizer registry
264    pub fn tokenizers(&self) -> Arc<crate::tokenizer::TokenizerRegistry> {
265        Arc::new(crate::tokenizer::TokenizerRegistry::default())
266    }
267
268    /// Create a query parser for this index
269    pub fn query_parser(&self) -> crate::dsl::QueryLanguageParser {
270        let default_fields = self.default_fields();
271        let tokenizers = self.tokenizers();
272
273        let query_routers = self.schema.query_routers();
274        if !query_routers.is_empty()
275            && let Ok(router) = crate::dsl::QueryFieldRouter::from_rules(query_routers)
276        {
277            return crate::dsl::QueryLanguageParser::with_router(
278                Arc::clone(&self.schema),
279                default_fields,
280                tokenizers,
281                router,
282            );
283        }
284
285        crate::dsl::QueryLanguageParser::new(Arc::clone(&self.schema), default_fields, tokenizers)
286    }
287
288    /// Parse and search using a query string
289    pub async fn query(
290        &self,
291        query_str: &str,
292        limit: usize,
293    ) -> Result<crate::query::SearchResponse> {
294        self.query_offset(query_str, limit, 0).await
295    }
296
297    /// Query with offset for pagination
298    pub async fn query_offset(
299        &self,
300        query_str: &str,
301        limit: usize,
302        offset: usize,
303    ) -> Result<crate::query::SearchResponse> {
304        let parser = self.query_parser();
305        let query = parser
306            .parse(query_str)
307            .map_err(crate::error::Error::Query)?;
308        self.search_offset(query.as_ref(), limit, offset).await
309    }
310
311    /// Search and return results
312    pub async fn search(
313        &self,
314        query: &dyn crate::query::Query,
315        limit: usize,
316    ) -> Result<crate::query::SearchResponse> {
317        self.search_offset(query, limit, 0).await
318    }
319
320    /// Search with offset for pagination
321    pub async fn search_offset(
322        &self,
323        query: &dyn crate::query::Query,
324        limit: usize,
325        offset: usize,
326    ) -> Result<crate::query::SearchResponse> {
327        let reader = self.reader().await?;
328        let searcher = reader.searcher().await?;
329        let segments = searcher.segment_readers();
330
331        let fetch_limit = offset + limit;
332
333        let futures: Vec<_> = segments
334            .iter()
335            .map(|segment| {
336                let sid = segment.meta().id;
337                async move {
338                    let results =
339                        crate::query::search_segment(segment.as_ref(), query, fetch_limit).await?;
340                    Ok::<_, crate::error::Error>(
341                        results
342                            .into_iter()
343                            .map(move |r| (sid, r))
344                            .collect::<Vec<_>>(),
345                    )
346                }
347            })
348            .collect();
349
350        let batches = futures::future::try_join_all(futures).await?;
351        let mut all_results: Vec<(u128, crate::query::SearchResult)> =
352            Vec::with_capacity(batches.iter().map(|b| b.len()).sum());
353        for batch in batches {
354            all_results.extend(batch);
355        }
356
357        all_results.sort_by(|a, b| {
358            b.1.score
359                .partial_cmp(&a.1.score)
360                .unwrap_or(std::cmp::Ordering::Equal)
361        });
362
363        let total_hits = all_results.len() as u32;
364
365        let hits: Vec<crate::query::SearchHit> = all_results
366            .into_iter()
367            .skip(offset)
368            .take(limit)
369            .map(|(segment_id, result)| crate::query::SearchHit {
370                address: crate::query::DocAddress::new(segment_id, result.doc_id),
371                score: result.score,
372                matched_fields: result.extract_ordinals(),
373            })
374            .collect();
375
376        Ok(crate::query::SearchResponse { hits, total_hits })
377    }
378
379    /// Get a document by its unique address
380    pub async fn get_document(
381        &self,
382        address: &crate::query::DocAddress,
383    ) -> Result<Option<crate::dsl::Document>> {
384        let segment_id = address.segment_id_u128().ok_or_else(|| {
385            crate::error::Error::Query(format!("Invalid segment ID: {}", address.segment_id))
386        })?;
387
388        let reader = self.reader().await?;
389        let searcher = reader.searcher().await?;
390
391        for segment in searcher.segment_readers() {
392            if segment.meta().id == segment_id {
393                return segment.doc(address.doc_id).await;
394            }
395        }
396
397        Ok(None)
398    }
399
400    /// Reload is no longer needed - reader handles this automatically
401    pub async fn reload(&self) -> Result<()> {
402        // No-op - reader reloads automatically based on policy
403        Ok(())
404    }
405
406    /// Get posting lists for a term across all segments
407    pub async fn get_postings(
408        &self,
409        field: crate::Field,
410        term: &[u8],
411    ) -> Result<
412        Vec<(
413            Arc<crate::segment::SegmentReader>,
414            crate::structures::BlockPostingList,
415        )>,
416    > {
417        let segments = self.segment_readers().await?;
418        let mut results = Vec::new();
419
420        for segment in segments {
421            if let Some(postings) = segment.get_postings(field, term).await? {
422                results.push((segment, postings));
423            }
424        }
425
426        Ok(results)
427    }
428}
429
430/// Native-only methods for Index
431#[cfg(feature = "native")]
432impl<D: crate::directories::DirectoryWriter + 'static> Index<D> {
433    /// Get an IndexWriter for adding documents
434    pub fn writer(&self) -> writer::IndexWriter<D> {
435        writer::IndexWriter::from_index(self)
436    }
437}
438
439// TODO: Add back warmup_and_save_slice_cache when slice caching is re-integrated
440
441#[cfg(test)]
442mod tests {
443    use super::*;
444    use crate::directories::RamDirectory;
445    use crate::dsl::{Document, SchemaBuilder};
446
447    #[tokio::test]
448    async fn test_index_create_and_search() {
449        let mut schema_builder = SchemaBuilder::default();
450        let title = schema_builder.add_text_field("title", true, true);
451        let body = schema_builder.add_text_field("body", true, true);
452        let schema = schema_builder.build();
453
454        let dir = RamDirectory::new();
455        let config = IndexConfig::default();
456
457        // Create index and add documents
458        let writer = IndexWriter::create(dir.clone(), schema.clone(), config.clone())
459            .await
460            .unwrap();
461
462        let mut doc1 = Document::new();
463        doc1.add_text(title, "Hello World");
464        doc1.add_text(body, "This is the first document");
465        writer.add_document(doc1).unwrap();
466
467        let mut doc2 = Document::new();
468        doc2.add_text(title, "Goodbye World");
469        doc2.add_text(body, "This is the second document");
470        writer.add_document(doc2).unwrap();
471
472        writer.commit().await.unwrap();
473
474        // Open for reading
475        let index = Index::open(dir, config).await.unwrap();
476        assert_eq!(index.num_docs().await.unwrap(), 2);
477
478        // Check postings
479        let postings = index.get_postings(title, b"world").await.unwrap();
480        assert_eq!(postings.len(), 1); // One segment
481        assert_eq!(postings[0].1.doc_count(), 2); // Two docs with "world"
482
483        // Retrieve document
484        let doc = index.doc(0).await.unwrap().unwrap();
485        assert_eq!(doc.get_first(title).unwrap().as_text(), Some("Hello World"));
486    }
487
488    #[tokio::test]
489    async fn test_multiple_segments() {
490        let mut schema_builder = SchemaBuilder::default();
491        let title = schema_builder.add_text_field("title", true, true);
492        let schema = schema_builder.build();
493
494        let dir = RamDirectory::new();
495        let config = IndexConfig {
496            max_indexing_memory_bytes: 1024, // Very small to trigger frequent flushes
497            ..Default::default()
498        };
499
500        let writer = IndexWriter::create(dir.clone(), schema.clone(), config.clone())
501            .await
502            .unwrap();
503
504        // Add documents in batches to create multiple segments
505        for batch in 0..3 {
506            for i in 0..5 {
507                let mut doc = Document::new();
508                doc.add_text(title, format!("Document {} batch {}", i, batch));
509                writer.add_document(doc).unwrap();
510            }
511            writer.commit().await.unwrap();
512        }
513
514        // Open and check
515        let index = Index::open(dir, config).await.unwrap();
516        assert_eq!(index.num_docs().await.unwrap(), 15);
517        // With queue-based indexing, exact segment count varies
518        assert!(
519            index.segment_readers().await.unwrap().len() >= 2,
520            "Expected multiple segments"
521        );
522    }
523
524    #[tokio::test]
525    async fn test_segment_merge() {
526        let mut schema_builder = SchemaBuilder::default();
527        let title = schema_builder.add_text_field("title", true, true);
528        let schema = schema_builder.build();
529
530        let dir = RamDirectory::new();
531        let config = IndexConfig {
532            max_indexing_memory_bytes: 512, // Very small to trigger frequent flushes
533            ..Default::default()
534        };
535
536        let writer = IndexWriter::create(dir.clone(), schema.clone(), config.clone())
537            .await
538            .unwrap();
539
540        // Create multiple segments by flushing between batches
541        for batch in 0..3 {
542            for i in 0..3 {
543                let mut doc = Document::new();
544                doc.add_text(title, format!("Document {} batch {}", i, batch));
545                writer.add_document(doc).unwrap();
546            }
547            writer.flush().await.unwrap();
548        }
549        writer.commit().await.unwrap();
550
551        // Should have multiple segments (at least 2, one per flush with docs)
552        let index = Index::open(dir.clone(), config.clone()).await.unwrap();
553        assert!(
554            index.segment_readers().await.unwrap().len() >= 2,
555            "Expected multiple segments"
556        );
557
558        // Force merge
559        let writer = IndexWriter::open(dir.clone(), config.clone())
560            .await
561            .unwrap();
562        writer.force_merge().await.unwrap();
563
564        // Should have 1 segment now
565        let index = Index::open(dir, config).await.unwrap();
566        assert_eq!(index.segment_readers().await.unwrap().len(), 1);
567        assert_eq!(index.num_docs().await.unwrap(), 9);
568
569        // Verify all documents accessible (order may vary with queue-based indexing)
570        let mut found_docs = 0;
571        for i in 0..9 {
572            if index.doc(i).await.unwrap().is_some() {
573                found_docs += 1;
574            }
575        }
576        assert_eq!(found_docs, 9);
577    }
578
579    #[tokio::test]
580    async fn test_match_query() {
581        let mut schema_builder = SchemaBuilder::default();
582        let title = schema_builder.add_text_field("title", true, true);
583        let body = schema_builder.add_text_field("body", true, true);
584        let schema = schema_builder.build();
585
586        let dir = RamDirectory::new();
587        let config = IndexConfig::default();
588
589        let writer = IndexWriter::create(dir.clone(), schema.clone(), config.clone())
590            .await
591            .unwrap();
592
593        let mut doc1 = Document::new();
594        doc1.add_text(title, "rust programming");
595        doc1.add_text(body, "Learn rust language");
596        writer.add_document(doc1).unwrap();
597
598        let mut doc2 = Document::new();
599        doc2.add_text(title, "python programming");
600        doc2.add_text(body, "Learn python language");
601        writer.add_document(doc2).unwrap();
602
603        writer.commit().await.unwrap();
604
605        let index = Index::open(dir, config).await.unwrap();
606
607        // Test match query with multiple default fields
608        let results = index.query("rust", 10).await.unwrap();
609        assert_eq!(results.hits.len(), 1);
610
611        // Test match query with multiple tokens
612        let results = index.query("rust programming", 10).await.unwrap();
613        assert!(!results.hits.is_empty());
614
615        // Verify hit has address (segment_id + doc_id)
616        let hit = &results.hits[0];
617        assert!(!hit.address.segment_id.is_empty(), "Should have segment_id");
618
619        // Verify document retrieval by address
620        let doc = index.get_document(&hit.address).await.unwrap().unwrap();
621        assert!(
622            !doc.field_values().is_empty(),
623            "Doc should have field values"
624        );
625
626        // Also verify doc retrieval directly by global doc_id
627        let doc = index.doc(0).await.unwrap().unwrap();
628        assert!(
629            !doc.field_values().is_empty(),
630            "Doc should have field values"
631        );
632    }
633
634    #[tokio::test]
635    async fn test_slice_cache_warmup_and_load() {
636        use crate::directories::SliceCachingDirectory;
637
638        let mut schema_builder = SchemaBuilder::default();
639        let title = schema_builder.add_text_field("title", true, true);
640        let body = schema_builder.add_text_field("body", true, true);
641        let schema = schema_builder.build();
642
643        let dir = RamDirectory::new();
644        let config = IndexConfig::default();
645
646        // Create index with some documents
647        let writer = IndexWriter::create(dir.clone(), schema.clone(), config.clone())
648            .await
649            .unwrap();
650
651        for i in 0..10 {
652            let mut doc = Document::new();
653            doc.add_text(title, format!("Document {} about rust", i));
654            doc.add_text(body, format!("This is body text number {}", i));
655            writer.add_document(doc).unwrap();
656        }
657        writer.commit().await.unwrap();
658
659        // Open with slice caching and perform some operations to warm up cache
660        let caching_dir = SliceCachingDirectory::new(dir.clone(), 1024 * 1024);
661        let index = Index::open(caching_dir, config.clone()).await.unwrap();
662
663        // Perform a search to warm up the cache
664        let results = index.query("rust", 10).await.unwrap();
665        assert!(!results.hits.is_empty());
666
667        // Check cache stats - should have cached some data
668        let stats = index.directory.stats();
669        assert!(stats.total_bytes > 0, "Cache should have data after search");
670    }
671
672    #[tokio::test]
673    async fn test_multivalue_field_indexing_and_search() {
674        let mut schema_builder = SchemaBuilder::default();
675        let uris = schema_builder.add_text_field("uris", true, true);
676        let title = schema_builder.add_text_field("title", true, true);
677        let schema = schema_builder.build();
678
679        let dir = RamDirectory::new();
680        let config = IndexConfig::default();
681
682        // Create index and add document with multi-value field
683        let writer = IndexWriter::create(dir.clone(), schema.clone(), config.clone())
684            .await
685            .unwrap();
686
687        let mut doc = Document::new();
688        doc.add_text(uris, "one");
689        doc.add_text(uris, "two");
690        doc.add_text(title, "Test Document");
691        writer.add_document(doc).unwrap();
692
693        // Add another document with different uris
694        let mut doc2 = Document::new();
695        doc2.add_text(uris, "three");
696        doc2.add_text(title, "Another Document");
697        writer.add_document(doc2).unwrap();
698
699        writer.commit().await.unwrap();
700
701        // Open for reading
702        let index = Index::open(dir, config).await.unwrap();
703        assert_eq!(index.num_docs().await.unwrap(), 2);
704
705        // Verify document retrieval preserves all values
706        let doc = index.doc(0).await.unwrap().unwrap();
707        let all_uris: Vec<_> = doc.get_all(uris).collect();
708        assert_eq!(all_uris.len(), 2, "Should have 2 uris values");
709        assert_eq!(all_uris[0].as_text(), Some("one"));
710        assert_eq!(all_uris[1].as_text(), Some("two"));
711
712        // Verify to_json returns array for multi-value field
713        let json = doc.to_json(index.schema());
714        let uris_json = json.get("uris").unwrap();
715        assert!(uris_json.is_array(), "Multi-value field should be an array");
716        let uris_arr = uris_json.as_array().unwrap();
717        assert_eq!(uris_arr.len(), 2);
718        assert_eq!(uris_arr[0].as_str(), Some("one"));
719        assert_eq!(uris_arr[1].as_str(), Some("two"));
720
721        // Verify both values are searchable
722        let results = index.query("uris:one", 10).await.unwrap();
723        assert_eq!(results.hits.len(), 1, "Should find doc with 'one'");
724        assert_eq!(results.hits[0].address.doc_id, 0);
725
726        let results = index.query("uris:two", 10).await.unwrap();
727        assert_eq!(results.hits.len(), 1, "Should find doc with 'two'");
728        assert_eq!(results.hits[0].address.doc_id, 0);
729
730        let results = index.query("uris:three", 10).await.unwrap();
731        assert_eq!(results.hits.len(), 1, "Should find doc with 'three'");
732        assert_eq!(results.hits[0].address.doc_id, 1);
733
734        // Verify searching for non-existent value returns no results
735        let results = index.query("uris:nonexistent", 10).await.unwrap();
736        assert_eq!(results.hits.len(), 0, "Should not find non-existent value");
737    }
738
739    /// Comprehensive test for WAND optimization in BooleanQuery OR queries
740    ///
741    /// This test verifies that:
742    /// 1. BooleanQuery with multiple SHOULD term queries uses WAND automatically
743    /// 2. Search results are correct regardless of WAND optimization
744    /// 3. Scores are reasonable for matching documents
745    #[tokio::test]
746    async fn test_wand_optimization_for_or_queries() {
747        use crate::query::{BooleanQuery, TermQuery};
748
749        let mut schema_builder = SchemaBuilder::default();
750        let content = schema_builder.add_text_field("content", true, true);
751        let schema = schema_builder.build();
752
753        let dir = RamDirectory::new();
754        let config = IndexConfig::default();
755
756        // Create index with documents containing various terms
757        let writer = IndexWriter::create(dir.clone(), schema.clone(), config.clone())
758            .await
759            .unwrap();
760
761        // Doc 0: contains "rust" and "programming"
762        let mut doc = Document::new();
763        doc.add_text(content, "rust programming language is fast");
764        writer.add_document(doc).unwrap();
765
766        // Doc 1: contains "rust" only
767        let mut doc = Document::new();
768        doc.add_text(content, "rust is a systems language");
769        writer.add_document(doc).unwrap();
770
771        // Doc 2: contains "programming" only
772        let mut doc = Document::new();
773        doc.add_text(content, "programming is fun");
774        writer.add_document(doc).unwrap();
775
776        // Doc 3: contains "python" (neither rust nor programming)
777        let mut doc = Document::new();
778        doc.add_text(content, "python is easy to learn");
779        writer.add_document(doc).unwrap();
780
781        // Doc 4: contains both "rust" and "programming" multiple times
782        let mut doc = Document::new();
783        doc.add_text(content, "rust rust programming programming systems");
784        writer.add_document(doc).unwrap();
785
786        writer.commit().await.unwrap();
787
788        // Open for reading
789        let index = Index::open(dir.clone(), config.clone()).await.unwrap();
790
791        // Test 1: Pure OR query with multiple terms (should use WAND automatically)
792        let or_query = BooleanQuery::new()
793            .should(TermQuery::text(content, "rust"))
794            .should(TermQuery::text(content, "programming"));
795
796        let results = index.search(&or_query, 10).await.unwrap();
797
798        // Should find docs 0, 1, 2, 4 (all that contain "rust" OR "programming")
799        assert_eq!(results.hits.len(), 4, "Should find exactly 4 documents");
800
801        let doc_ids: Vec<u32> = results.hits.iter().map(|h| h.address.doc_id).collect();
802        assert!(doc_ids.contains(&0), "Should find doc 0");
803        assert!(doc_ids.contains(&1), "Should find doc 1");
804        assert!(doc_ids.contains(&2), "Should find doc 2");
805        assert!(doc_ids.contains(&4), "Should find doc 4");
806        assert!(
807            !doc_ids.contains(&3),
808            "Should NOT find doc 3 (only has 'python')"
809        );
810
811        // Test 2: Single term query (should NOT use WAND, but still work)
812        let single_query = BooleanQuery::new().should(TermQuery::text(content, "rust"));
813
814        let results = index.search(&single_query, 10).await.unwrap();
815        assert_eq!(results.hits.len(), 3, "Should find 3 documents with 'rust'");
816
817        // Test 3: Query with MUST (should NOT use WAND)
818        let must_query = BooleanQuery::new()
819            .must(TermQuery::text(content, "rust"))
820            .should(TermQuery::text(content, "programming"));
821
822        let results = index.search(&must_query, 10).await.unwrap();
823        // Must have "rust", optionally "programming"
824        assert_eq!(results.hits.len(), 3, "Should find 3 documents with 'rust'");
825
826        // Test 4: Query with MUST_NOT (should NOT use WAND)
827        let must_not_query = BooleanQuery::new()
828            .should(TermQuery::text(content, "rust"))
829            .should(TermQuery::text(content, "programming"))
830            .must_not(TermQuery::text(content, "systems"));
831
832        let results = index.search(&must_not_query, 10).await.unwrap();
833        // Should exclude docs with "systems" (doc 1 and 4)
834        let doc_ids: Vec<u32> = results.hits.iter().map(|h| h.address.doc_id).collect();
835        assert!(
836            !doc_ids.contains(&1),
837            "Should NOT find doc 1 (has 'systems')"
838        );
839        assert!(
840            !doc_ids.contains(&4),
841            "Should NOT find doc 4 (has 'systems')"
842        );
843
844        // Test 5: Verify top-k limit works correctly with WAND
845        let or_query = BooleanQuery::new()
846            .should(TermQuery::text(content, "rust"))
847            .should(TermQuery::text(content, "programming"));
848
849        let results = index.search(&or_query, 2).await.unwrap();
850        assert_eq!(results.hits.len(), 2, "Should return only top 2 results");
851
852        // Top results should be docs that match both terms (higher scores)
853        // Doc 0 and 4 contain both "rust" and "programming"
854    }
855
856    /// Test that WAND optimization produces same results as non-WAND for correctness
857    #[tokio::test]
858    async fn test_wand_results_match_standard_boolean() {
859        use crate::query::{BooleanQuery, TermQuery, WandOrQuery};
860
861        let mut schema_builder = SchemaBuilder::default();
862        let content = schema_builder.add_text_field("content", true, true);
863        let schema = schema_builder.build();
864
865        let dir = RamDirectory::new();
866        let config = IndexConfig::default();
867
868        let writer = IndexWriter::create(dir.clone(), schema.clone(), config.clone())
869            .await
870            .unwrap();
871
872        // Add several documents
873        for i in 0..10 {
874            let mut doc = Document::new();
875            let text = match i % 4 {
876                0 => "apple banana cherry",
877                1 => "apple orange",
878                2 => "banana grape",
879                _ => "cherry date",
880            };
881            doc.add_text(content, text);
882            writer.add_document(doc).unwrap();
883        }
884
885        writer.commit().await.unwrap();
886        let index = Index::open(dir.clone(), config.clone()).await.unwrap();
887
888        // Compare explicit WandOrQuery with auto-optimized BooleanQuery
889        let wand_query = WandOrQuery::new(content).term("apple").term("banana");
890
891        let bool_query = BooleanQuery::new()
892            .should(TermQuery::text(content, "apple"))
893            .should(TermQuery::text(content, "banana"));
894
895        let wand_results = index.search(&wand_query, 10).await.unwrap();
896        let bool_results = index.search(&bool_query, 10).await.unwrap();
897
898        // Both should find the same documents
899        assert_eq!(
900            wand_results.hits.len(),
901            bool_results.hits.len(),
902            "WAND and Boolean should find same number of docs"
903        );
904
905        let wand_docs: std::collections::HashSet<u32> =
906            wand_results.hits.iter().map(|h| h.address.doc_id).collect();
907        let bool_docs: std::collections::HashSet<u32> =
908            bool_results.hits.iter().map(|h| h.address.doc_id).collect();
909
910        assert_eq!(
911            wand_docs, bool_docs,
912            "WAND and Boolean should find same documents"
913        );
914    }
915
916    #[tokio::test]
917    async fn test_vector_index_threshold_switch() {
918        use crate::dsl::{DenseVectorConfig, VectorIndexType};
919
920        // Create schema with dense vector field configured for IVF-RaBitQ
921        let mut schema_builder = SchemaBuilder::default();
922        let title = schema_builder.add_text_field("title", true, true);
923        let embedding = schema_builder.add_dense_vector_field_with_config(
924            "embedding",
925            true, // indexed
926            true, // stored
927            DenseVectorConfig {
928                dim: 8,
929                index_type: VectorIndexType::IvfRaBitQ,
930                store_raw: true,
931                num_clusters: Some(4), // Small for test
932                nprobe: 2,
933                mrl_dim: None,
934                build_threshold: Some(50), // Build when we have 50+ vectors
935            },
936        );
937        let schema = schema_builder.build();
938
939        let dir = RamDirectory::new();
940        let config = IndexConfig::default();
941
942        // Phase 1: Add vectors below threshold (should use Flat index)
943        let writer = IndexWriter::create(dir.clone(), schema.clone(), config.clone())
944            .await
945            .unwrap();
946
947        // Add 30 documents (below threshold of 50)
948        for i in 0..30 {
949            let mut doc = Document::new();
950            doc.add_text(title, format!("Document {}", i));
951            // Simple embedding: [i, i, i, i, i, i, i, i] normalized
952            let vec: Vec<f32> = (0..8).map(|_| (i as f32) / 30.0).collect();
953            doc.add_dense_vector(embedding, vec);
954            writer.add_document(doc).unwrap();
955        }
956        writer.commit().await.unwrap();
957
958        // Open index and verify it's using Flat (not built yet)
959        let index = Index::open(dir.clone(), config.clone()).await.unwrap();
960        assert!(
961            index.trained_centroids.is_empty(),
962            "Should not have trained centroids below threshold"
963        );
964
965        // Search should work with Flat index
966        let query_vec: Vec<f32> = vec![0.5; 8];
967        let segments = index.segment_readers().await.unwrap();
968        assert!(!segments.is_empty());
969
970        let results = segments[0]
971            .search_dense_vector(
972                embedding,
973                &query_vec,
974                5,
975                1,
976                crate::query::MultiValueCombiner::Max,
977            )
978            .unwrap();
979        assert!(!results.is_empty(), "Flat search should return results");
980
981        // Phase 2: Add more vectors to cross threshold
982        let writer = IndexWriter::open(dir.clone(), config.clone())
983            .await
984            .unwrap();
985
986        // Add 30 more documents (total 60, above threshold of 50)
987        for i in 30..60 {
988            let mut doc = Document::new();
989            doc.add_text(title, format!("Document {}", i));
990            let vec: Vec<f32> = (0..8).map(|_| (i as f32) / 60.0).collect();
991            doc.add_dense_vector(embedding, vec);
992            writer.add_document(doc).unwrap();
993        }
994        // Commit auto-triggers vector index build when threshold is crossed
995        writer.commit().await.unwrap();
996
997        // Verify centroids were trained (auto-triggered)
998        assert!(
999            writer.is_vector_index_built(embedding).await,
1000            "Vector index should be built after crossing threshold"
1001        );
1002
1003        // Reopen index and verify trained structures are loaded
1004        let index = Index::open(dir.clone(), config.clone()).await.unwrap();
1005        assert!(
1006            index.trained_centroids.contains_key(&embedding.0),
1007            "Should have loaded trained centroids for embedding field"
1008        );
1009
1010        // Search should still work
1011        let segments = index.segment_readers().await.unwrap();
1012        let results = segments[0]
1013            .search_dense_vector(
1014                embedding,
1015                &query_vec,
1016                5,
1017                1,
1018                crate::query::MultiValueCombiner::Max,
1019            )
1020            .unwrap();
1021        assert!(
1022            !results.is_empty(),
1023            "Search should return results after build"
1024        );
1025
1026        // Phase 3: Verify calling build_vector_index again is a no-op
1027        let writer = IndexWriter::open(dir.clone(), config.clone())
1028            .await
1029            .unwrap();
1030        writer.build_vector_index().await.unwrap(); // Should skip training
1031
1032        // Still built
1033        assert!(writer.is_vector_index_built(embedding).await);
1034    }
1035}