hermes_core/
index.rs

1//! Index - multi-segment async search index
2//!
3//! Components:
4//! - Index: main entry point for searching
5//! - IndexWriter: for adding documents and committing segments
6//! - Supports multiple segments with merge
7
8use std::path::Path;
9use std::sync::Arc;
10
11use parking_lot::RwLock;
12#[cfg(feature = "native")]
13use rustc_hash::FxHashMap;
14
15use crate::DocId;
16#[cfg(feature = "native")]
17use crate::directories::DirectoryWriter;
18use crate::directories::{Directory, SliceCachingDirectory};
19use crate::dsl::{Document, Field, Schema};
20use crate::error::{Error, Result};
21#[cfg(feature = "native")]
22use crate::segment::{SegmentBuilder, SegmentBuilderConfig, SegmentMerger};
23use crate::segment::{SegmentId, SegmentReader};
24use crate::structures::BlockPostingList;
25#[cfg(feature = "native")]
26use crate::tokenizer::BoxedTokenizer;
27
28#[cfg(feature = "native")]
29use tokio::sync::Mutex as AsyncMutex;
30
31/// Default file name for the slice cache
32pub const SLICE_CACHE_FILENAME: &str = "index.slicecache";
33
34/// Index configuration
35#[derive(Debug, Clone)]
36pub struct IndexConfig {
37    /// Number of threads for CPU-intensive tasks (search parallelism)
38    pub num_threads: usize,
39    /// Number of parallel segment builders (documents distributed round-robin)
40    pub num_indexing_threads: usize,
41    /// Number of threads for parallel block compression within each segment
42    pub num_compression_threads: usize,
43    /// Block cache size for term dictionary per segment
44    pub term_cache_blocks: usize,
45    /// Block cache size for document store per segment
46    pub store_cache_blocks: usize,
47    /// Max documents per segment before auto-commit
48    pub max_docs_per_segment: u32,
49    /// Index optimization mode (adaptive, size-optimized, performance-optimized)
50    pub optimization: crate::structures::IndexOptimization,
51}
52
53impl Default for IndexConfig {
54    fn default() -> Self {
55        #[cfg(feature = "native")]
56        let cpus = num_cpus::get().max(1);
57        #[cfg(not(feature = "native"))]
58        let cpus = 1;
59
60        Self {
61            num_threads: cpus,
62            num_indexing_threads: 1,
63            num_compression_threads: cpus,
64            term_cache_blocks: 256,
65            store_cache_blocks: 32,
66            max_docs_per_segment: 100_000,
67            optimization: crate::structures::IndexOptimization::default(),
68        }
69    }
70}
71
72/// Multi-segment async Index
73///
74/// The main entry point for searching. Manages multiple segments
75/// and provides unified search across all of them.
76pub struct Index<D: Directory> {
77    directory: Arc<D>,
78    schema: Arc<Schema>,
79    config: IndexConfig,
80    segments: RwLock<Vec<Arc<SegmentReader>>>,
81    default_fields: Vec<crate::Field>,
82    tokenizers: Arc<crate::tokenizer::TokenizerRegistry>,
83    #[cfg(feature = "native")]
84    thread_pool: Arc<rayon::ThreadPool>,
85}
86
87impl<D: Directory> Index<D> {
88    /// Open an existing index from a directory
89    pub async fn open(directory: D, config: IndexConfig) -> Result<Self> {
90        let directory = Arc::new(directory);
91
92        // Read schema
93        let schema_slice = directory.open_read(Path::new("schema.json")).await?;
94        let schema_bytes = schema_slice.read_bytes().await?;
95        let schema: Schema = serde_json::from_slice(schema_bytes.as_slice())
96            .map_err(|e| Error::Serialization(e.to_string()))?;
97        let schema = Arc::new(schema);
98
99        // Read segment list
100        let segments = Self::load_segments(&directory, &schema, &config).await?;
101
102        #[cfg(feature = "native")]
103        let thread_pool = {
104            let pool = rayon::ThreadPoolBuilder::new()
105                .num_threads(config.num_threads)
106                .build()
107                .map_err(|e| Error::Io(std::io::Error::other(e)))?;
108            Arc::new(pool)
109        };
110
111        // Use schema's default_fields if specified, otherwise fall back to all indexed text fields
112        let default_fields: Vec<crate::Field> = if !schema.default_fields().is_empty() {
113            schema.default_fields().to_vec()
114        } else {
115            schema
116                .fields()
117                .filter(|(_, entry)| {
118                    entry.indexed && entry.field_type == crate::dsl::FieldType::Text
119                })
120                .map(|(field, _)| field)
121                .collect()
122        };
123
124        Ok(Self {
125            directory,
126            schema,
127            config,
128            segments: RwLock::new(segments),
129            default_fields,
130            tokenizers: Arc::new(crate::tokenizer::TokenizerRegistry::default()),
131            #[cfg(feature = "native")]
132            thread_pool,
133        })
134    }
135
136    async fn load_segments(
137        directory: &Arc<D>,
138        schema: &Arc<Schema>,
139        config: &IndexConfig,
140    ) -> Result<Vec<Arc<SegmentReader>>> {
141        // Read segments.json which lists all segment IDs
142        let segments_path = Path::new("segments.json");
143        if !directory.exists(segments_path).await? {
144            return Ok(Vec::new());
145        }
146
147        let segments_slice = directory.open_read(segments_path).await?;
148        let segments_bytes = segments_slice.read_bytes().await?;
149        let segment_ids: Vec<String> = serde_json::from_slice(segments_bytes.as_slice())
150            .map_err(|e| Error::Serialization(e.to_string()))?;
151
152        let mut segments = Vec::new();
153        let mut doc_id_offset = 0u32;
154
155        for id_str in segment_ids {
156            let segment_id = SegmentId::from_hex(&id_str)
157                .ok_or_else(|| Error::Corruption(format!("Invalid segment ID: {}", id_str)))?;
158            let reader = SegmentReader::open(
159                directory.as_ref(),
160                segment_id,
161                Arc::clone(schema),
162                doc_id_offset,
163                config.term_cache_blocks,
164            )
165            .await?;
166
167            doc_id_offset += reader.meta().num_docs;
168            segments.push(Arc::new(reader));
169        }
170
171        Ok(segments)
172    }
173
174    /// Get the schema
175    pub fn schema(&self) -> &Schema {
176        &self.schema
177    }
178
179    /// Get a reference to the underlying directory
180    pub fn directory(&self) -> &D {
181        &self.directory
182    }
183
184    /// Total number of documents across all segments
185    pub fn num_docs(&self) -> u32 {
186        self.segments.read().iter().map(|s| s.num_docs()).sum()
187    }
188
189    /// Get a document by global doc_id (async)
190    pub async fn doc(&self, doc_id: DocId) -> Result<Option<Document>> {
191        let segments = self.segments.read().clone();
192
193        let mut offset = 0u32;
194        for segment in segments.iter() {
195            let segment_docs = segment.meta().num_docs;
196            if doc_id < offset + segment_docs {
197                let local_doc_id = doc_id - offset;
198                return segment.doc(local_doc_id).await;
199            }
200            offset += segment_docs;
201        }
202
203        Ok(None)
204    }
205
206    /// Get posting lists for a term across all segments (async)
207    pub async fn get_postings(
208        &self,
209        field: Field,
210        term: &[u8],
211    ) -> Result<Vec<(Arc<SegmentReader>, BlockPostingList)>> {
212        let segments = self.segments.read().clone();
213        let mut results = Vec::new();
214
215        for segment in segments.iter() {
216            if let Some(postings) = segment.get_postings(field, term).await? {
217                results.push((Arc::clone(segment), postings));
218            }
219        }
220
221        Ok(results)
222    }
223
224    /// Execute CPU-intensive work on thread pool (native only)
225    #[cfg(feature = "native")]
226    pub async fn spawn_blocking<F, R>(&self, f: F) -> R
227    where
228        F: FnOnce() -> R + Send + 'static,
229        R: Send + 'static,
230    {
231        let (tx, rx) = tokio::sync::oneshot::channel();
232        self.thread_pool.spawn(move || {
233            let result = f();
234            let _ = tx.send(result);
235        });
236        rx.await.expect("Thread pool task panicked")
237    }
238
239    /// Get segment readers for query execution
240    pub fn segment_readers(&self) -> Vec<Arc<SegmentReader>> {
241        self.segments.read().clone()
242    }
243
244    /// Reload segments from directory (after new segments added)
245    pub async fn reload(&self) -> Result<()> {
246        let new_segments = Self::load_segments(&self.directory, &self.schema, &self.config).await?;
247        *self.segments.write() = new_segments;
248        Ok(())
249    }
250
251    /// Search across all segments
252    pub async fn search(
253        &self,
254        query: &dyn crate::query::Query,
255        limit: usize,
256    ) -> Result<Vec<crate::query::SearchResult>> {
257        let segments = self.segments.read().clone();
258        let mut all_results = Vec::new();
259
260        for segment in &segments {
261            let results = crate::query::search_segment(segment.as_ref(), query, limit).await?;
262            all_results.extend(results);
263        }
264
265        // Sort by score descending
266        all_results.sort_by(|a, b| {
267            b.score
268                .partial_cmp(&a.score)
269                .unwrap_or(std::cmp::Ordering::Equal)
270        });
271        all_results.truncate(limit);
272
273        Ok(all_results)
274    }
275
276    /// Search and return results with document addresses (no document content)
277    pub async fn search_with_addresses(
278        &self,
279        query: &dyn crate::query::Query,
280        limit: usize,
281    ) -> Result<crate::query::SearchResponse> {
282        let segments = self.segments.read().clone();
283        let mut all_results: Vec<(u128, crate::query::SearchResult)> = Vec::new();
284
285        for segment in &segments {
286            let segment_id = segment.meta().id;
287            let results = crate::query::search_segment(segment.as_ref(), query, limit).await?;
288            for result in results {
289                all_results.push((segment_id, result));
290            }
291        }
292
293        // Sort by score descending
294        all_results.sort_by(|a, b| {
295            b.1.score
296                .partial_cmp(&a.1.score)
297                .unwrap_or(std::cmp::Ordering::Equal)
298        });
299        all_results.truncate(limit);
300
301        let total_hits = all_results.len() as u32;
302        let hits: Vec<crate::query::SearchHit> = all_results
303            .into_iter()
304            .map(|(segment_id, result)| crate::query::SearchHit {
305                address: crate::query::DocAddress::new(segment_id, result.doc_id),
306                score: result.score,
307            })
308            .collect();
309
310        Ok(crate::query::SearchResponse { hits, total_hits })
311    }
312
313    /// Get a document by its unique address (segment_id + local doc_id)
314    pub async fn get_document(
315        &self,
316        address: &crate::query::DocAddress,
317    ) -> Result<Option<Document>> {
318        let segment_id = address
319            .segment_id_u128()
320            .ok_or_else(|| Error::Query(format!("Invalid segment ID: {}", address.segment_id)))?;
321
322        let segments = self.segments.read().clone();
323        for segment in &segments {
324            if segment.meta().id == segment_id {
325                return segment.doc(address.doc_id).await;
326            }
327        }
328
329        Ok(None)
330    }
331
332    /// Get the default fields for this index
333    pub fn default_fields(&self) -> &[crate::Field] {
334        &self.default_fields
335    }
336
337    /// Set the default fields for query parsing
338    pub fn set_default_fields(&mut self, fields: Vec<crate::Field>) {
339        self.default_fields = fields;
340    }
341
342    /// Get the tokenizer registry
343    pub fn tokenizers(&self) -> &Arc<crate::tokenizer::TokenizerRegistry> {
344        &self.tokenizers
345    }
346
347    /// Create a query parser for this index
348    ///
349    /// If the schema contains query router rules, they will be used to route
350    /// queries to specific fields based on regex patterns.
351    pub fn query_parser(&self) -> crate::dsl::QueryLanguageParser {
352        // Check if schema has query routers
353        let query_routers = self.schema.query_routers();
354        if !query_routers.is_empty() {
355            // Try to create a router from the schema's rules
356            if let Ok(router) = crate::dsl::QueryFieldRouter::from_rules(query_routers) {
357                return crate::dsl::QueryLanguageParser::with_router(
358                    Arc::clone(&self.schema),
359                    self.default_fields.clone(),
360                    Arc::clone(&self.tokenizers),
361                    router,
362                );
363            }
364        }
365
366        // Fall back to parser without router
367        crate::dsl::QueryLanguageParser::new(
368            Arc::clone(&self.schema),
369            self.default_fields.clone(),
370            Arc::clone(&self.tokenizers),
371        )
372    }
373
374    /// Parse and search using a query string
375    ///
376    /// Accepts both query language syntax (field:term, AND, OR, NOT, grouping)
377    /// and simple text (tokenized and searched across default fields).
378    /// Returns document addresses (segment_id + doc_id) without document content.
379    pub async fn query(
380        &self,
381        query_str: &str,
382        limit: usize,
383    ) -> Result<crate::query::SearchResponse> {
384        let parser = self.query_parser();
385        let query = parser.parse(query_str).map_err(Error::Query)?;
386        self.search_with_addresses(query.as_ref(), limit).await
387    }
388}
389
390/// Methods for opening index with slice caching
391impl<D: Directory> Index<SliceCachingDirectory<D>> {
392    /// Open an index with slice caching, automatically loading the cache file if present
393    ///
394    /// This wraps the directory in a SliceCachingDirectory and attempts to load
395    /// any existing slice cache file to prefill the cache with hot data.
396    pub async fn open_with_cache(
397        directory: D,
398        config: IndexConfig,
399        cache_max_bytes: usize,
400    ) -> Result<Self> {
401        let caching_dir = SliceCachingDirectory::new(directory, cache_max_bytes);
402
403        // Try to load existing slice cache
404        let cache_path = Path::new(SLICE_CACHE_FILENAME);
405        if let Ok(true) = caching_dir.inner().exists(cache_path).await
406            && let Ok(slice) = caching_dir.inner().open_read(cache_path).await
407            && let Ok(bytes) = slice.read_bytes().await
408        {
409            let _ = caching_dir.deserialize(bytes.as_slice());
410        }
411
412        Self::open(caching_dir, config).await
413    }
414
415    /// Serialize the current slice cache to the index directory
416    ///
417    /// This saves all cached slices to a single file that can be loaded
418    /// on subsequent index opens for faster startup.
419    #[cfg(feature = "native")]
420    pub async fn save_slice_cache(&self) -> Result<()>
421    where
422        D: DirectoryWriter,
423    {
424        let cache_data = self.directory.serialize();
425        let cache_path = Path::new(SLICE_CACHE_FILENAME);
426        self.directory
427            .inner()
428            .write(cache_path, &cache_data)
429            .await?;
430        Ok(())
431    }
432
433    /// Get slice cache statistics
434    pub fn slice_cache_stats(&self) -> crate::directories::SliceCacheStats {
435        self.directory.stats()
436    }
437}
438
439/// Warm up the slice cache by opening an index and performing typical read operations
440///
441/// This function opens an index using a SliceCachingDirectory, performs operations
442/// that would typically be done during search (reading term dictionaries, posting lists),
443/// and then serializes the cache to a file for future use.
444///
445/// The resulting cache file contains all the "hot" data that was read during warmup,
446/// allowing subsequent index opens to prefill the cache and avoid cold-start latency.
447#[cfg(feature = "native")]
448pub async fn warmup_and_save_slice_cache<D: DirectoryWriter>(
449    directory: D,
450    config: IndexConfig,
451    cache_max_bytes: usize,
452) -> Result<()> {
453    let caching_dir = SliceCachingDirectory::new(directory, cache_max_bytes);
454    let index = Index::open(caching_dir, config).await?;
455
456    // Warm up by loading segment metadata and term dictionaries
457    // The SegmentReader::open already reads essential metadata
458    // Additional warmup can be done by iterating terms or doing sample queries
459
460    // Save the cache
461    index.save_slice_cache().await?;
462
463    Ok(())
464}
465
466#[cfg(feature = "native")]
467impl<D: Directory> Clone for Index<D> {
468    fn clone(&self) -> Self {
469        Self {
470            directory: Arc::clone(&self.directory),
471            schema: Arc::clone(&self.schema),
472            config: self.config.clone(),
473            segments: RwLock::new(self.segments.read().clone()),
474            default_fields: self.default_fields.clone(),
475            tokenizers: Arc::clone(&self.tokenizers),
476            thread_pool: Arc::clone(&self.thread_pool),
477        }
478    }
479}
480
481/// Async IndexWriter for adding documents and committing segments
482///
483/// Features:
484/// - Parallel indexing with multiple segment builders
485/// - Streams documents to disk immediately (no in-memory document storage)
486/// - Uses string interning for terms (reduced allocations)
487/// - Uses hashbrown HashMap (faster than BTreeMap)
488#[cfg(feature = "native")]
489pub struct IndexWriter<D: DirectoryWriter> {
490    directory: Arc<D>,
491    schema: Arc<Schema>,
492    config: IndexConfig,
493    builder_config: SegmentBuilderConfig,
494    tokenizers: FxHashMap<Field, BoxedTokenizer>,
495    /// Multiple segment builders for parallel indexing
496    builders: Vec<AsyncMutex<Option<SegmentBuilder>>>,
497    /// Round-robin counter for document distribution
498    next_builder: std::sync::atomic::AtomicUsize,
499    /// List of committed segment IDs (hex strings)
500    segment_ids: AsyncMutex<Vec<String>>,
501}
502
503#[cfg(feature = "native")]
504impl<D: DirectoryWriter> IndexWriter<D> {
505    /// Create a new index in the directory
506    pub async fn create(directory: D, schema: Schema, config: IndexConfig) -> Result<Self> {
507        Self::create_with_config(directory, schema, config, SegmentBuilderConfig::default()).await
508    }
509
510    /// Create a new index with custom builder config
511    pub async fn create_with_config(
512        directory: D,
513        schema: Schema,
514        config: IndexConfig,
515        builder_config: SegmentBuilderConfig,
516    ) -> Result<Self> {
517        let directory = Arc::new(directory);
518        let schema = Arc::new(schema);
519
520        // Write schema
521        let schema_bytes =
522            serde_json::to_vec(&*schema).map_err(|e| Error::Serialization(e.to_string()))?;
523        directory
524            .write(Path::new("schema.json"), &schema_bytes)
525            .await?;
526
527        // Write empty segments list
528        let segments_bytes = serde_json::to_vec(&Vec::<String>::new())
529            .map_err(|e| Error::Serialization(e.to_string()))?;
530        directory
531            .write(Path::new("segments.json"), &segments_bytes)
532            .await?;
533
534        // Create multiple builders for parallel indexing
535        let num_builders = config.num_indexing_threads.max(1);
536        let mut builders = Vec::with_capacity(num_builders);
537        for _ in 0..num_builders {
538            builders.push(AsyncMutex::new(None));
539        }
540
541        Ok(Self {
542            directory,
543            schema,
544            config,
545            builder_config,
546            tokenizers: FxHashMap::default(),
547            builders,
548            next_builder: std::sync::atomic::AtomicUsize::new(0),
549            segment_ids: AsyncMutex::new(Vec::new()),
550        })
551    }
552
553    /// Open an existing index for writing
554    pub async fn open(directory: D, config: IndexConfig) -> Result<Self> {
555        Self::open_with_config(directory, config, SegmentBuilderConfig::default()).await
556    }
557
558    /// Open an existing index with custom builder config
559    pub async fn open_with_config(
560        directory: D,
561        config: IndexConfig,
562        builder_config: SegmentBuilderConfig,
563    ) -> Result<Self> {
564        let directory = Arc::new(directory);
565
566        // Read schema
567        let schema_slice = directory.open_read(Path::new("schema.json")).await?;
568        let schema_bytes = schema_slice.read_bytes().await?;
569        let schema: Schema = serde_json::from_slice(schema_bytes.as_slice())
570            .map_err(|e| Error::Serialization(e.to_string()))?;
571        let schema = Arc::new(schema);
572
573        // Read existing segment IDs (hex strings)
574        let segments_slice = directory.open_read(Path::new("segments.json")).await?;
575        let segments_bytes = segments_slice.read_bytes().await?;
576        let segment_ids: Vec<String> = serde_json::from_slice(segments_bytes.as_slice())
577            .map_err(|e| Error::Serialization(e.to_string()))?;
578
579        // Create multiple builders for parallel indexing
580        let num_builders = config.num_indexing_threads.max(1);
581        let mut builders = Vec::with_capacity(num_builders);
582        for _ in 0..num_builders {
583            builders.push(AsyncMutex::new(None));
584        }
585
586        Ok(Self {
587            directory,
588            schema,
589            config,
590            builder_config,
591            tokenizers: FxHashMap::default(),
592            builders,
593            next_builder: std::sync::atomic::AtomicUsize::new(0),
594            segment_ids: AsyncMutex::new(segment_ids),
595        })
596    }
597
598    /// Get the schema
599    pub fn schema(&self) -> &Schema {
600        &self.schema
601    }
602
603    /// Set tokenizer for a field
604    pub fn set_tokenizer<T: crate::tokenizer::Tokenizer>(&mut self, field: Field, tokenizer: T) {
605        self.tokenizers.insert(field, Box::new(tokenizer));
606    }
607
608    /// Add a document
609    ///
610    /// Documents are distributed round-robin across multiple builders for parallel indexing.
611    /// When a builder reaches `max_docs_per_segment`, it is committed and a new one starts.
612    pub async fn add_document(&self, doc: Document) -> Result<DocId> {
613        // Round-robin selection of builder
614        let builder_idx = self
615            .next_builder
616            .fetch_add(1, std::sync::atomic::Ordering::Relaxed)
617            % self.builders.len();
618
619        let mut builder_guard = self.builders[builder_idx].lock().await;
620
621        // Initialize builder if needed
622        if builder_guard.is_none() {
623            let mut builder =
624                SegmentBuilder::new((*self.schema).clone(), self.builder_config.clone())?;
625            for (field, tokenizer) in &self.tokenizers {
626                builder.set_tokenizer(*field, tokenizer.clone_box());
627            }
628            *builder_guard = Some(builder);
629        }
630
631        let builder = builder_guard.as_mut().unwrap();
632        let doc_id = builder.add_document(doc)?;
633
634        // Check if we need to commit
635        if builder.num_docs() >= self.config.max_docs_per_segment {
636            let full_builder = builder_guard.take().unwrap();
637            drop(builder_guard); // Release lock before async operation
638            self.commit_builder(full_builder).await?;
639        }
640
641        Ok(doc_id)
642    }
643
644    /// Get current builder statistics for debugging (aggregated from all builders)
645    pub async fn get_builder_stats(&self) -> Option<crate::segment::SegmentBuilderStats> {
646        let mut total_stats: Option<crate::segment::SegmentBuilderStats> = None;
647
648        for builder_mutex in &self.builders {
649            let guard = builder_mutex.lock().await;
650            if let Some(builder) = guard.as_ref() {
651                let stats = builder.stats();
652                if let Some(ref mut total) = total_stats {
653                    total.num_docs += stats.num_docs;
654                    total.unique_terms += stats.unique_terms;
655                    total.postings_in_memory += stats.postings_in_memory;
656                    total.interned_strings += stats.interned_strings;
657                    total.doc_field_lengths_size += stats.doc_field_lengths_size;
658                } else {
659                    total_stats = Some(stats);
660                }
661            }
662        }
663
664        total_stats
665    }
666
667    /// Commit all pending segments to disk
668    pub async fn commit(&self) -> Result<()> {
669        // Collect all builders that have documents
670        let mut builders_to_commit = Vec::new();
671
672        for builder_mutex in &self.builders {
673            let mut guard = builder_mutex.lock().await;
674            if let Some(builder) = guard.take()
675                && builder.num_docs() > 0
676            {
677                builders_to_commit.push(builder);
678            }
679        }
680
681        // Commit each builder
682        for builder in builders_to_commit {
683            self.commit_builder(builder).await?;
684        }
685
686        Ok(())
687    }
688
689    async fn commit_builder(&self, builder: SegmentBuilder) -> Result<()> {
690        let segment_id = SegmentId::new();
691        builder.build(self.directory.as_ref(), segment_id).await?;
692
693        // Update segment list
694        let mut segment_ids = self.segment_ids.lock().await;
695        segment_ids.push(segment_id.to_hex());
696
697        let segments_bytes =
698            serde_json::to_vec(&*segment_ids).map_err(|e| Error::Serialization(e.to_string()))?;
699        self.directory
700            .write(Path::new("segments.json"), &segments_bytes)
701            .await?;
702
703        Ok(())
704    }
705
706    /// Merge all segments into one (called explicitly via force_merge)
707    async fn do_merge(&self) -> Result<()> {
708        let segment_ids = self.segment_ids.lock().await;
709
710        if segment_ids.len() < 2 {
711            return Ok(());
712        }
713
714        let ids_to_merge: Vec<String> = segment_ids.clone();
715        drop(segment_ids);
716
717        // Load segment readers
718        let mut readers = Vec::new();
719        let mut doc_offset = 0u32;
720
721        for id_str in &ids_to_merge {
722            let segment_id = SegmentId::from_hex(id_str)
723                .ok_or_else(|| Error::Corruption(format!("Invalid segment ID: {}", id_str)))?;
724            let reader = SegmentReader::open(
725                self.directory.as_ref(),
726                segment_id,
727                Arc::clone(&self.schema),
728                doc_offset,
729                self.config.term_cache_blocks,
730            )
731            .await?;
732            doc_offset += reader.meta().num_docs;
733            readers.push(reader);
734        }
735
736        // Merge into new segment
737        let merger = SegmentMerger::new(Arc::clone(&self.schema));
738        let new_segment_id = SegmentId::new();
739        merger
740            .merge(self.directory.as_ref(), &readers, new_segment_id)
741            .await?;
742
743        // Update segment list
744        let mut segment_ids = self.segment_ids.lock().await;
745        segment_ids.clear();
746        segment_ids.push(new_segment_id.to_hex());
747
748        let segments_bytes =
749            serde_json::to_vec(&*segment_ids).map_err(|e| Error::Serialization(e.to_string()))?;
750        self.directory
751            .write(Path::new("segments.json"), &segments_bytes)
752            .await?;
753
754        // Delete old segments
755        for id_str in ids_to_merge {
756            if let Some(segment_id) = SegmentId::from_hex(&id_str) {
757                let _ = crate::segment::delete_segment(self.directory.as_ref(), segment_id).await;
758            }
759        }
760
761        Ok(())
762    }
763
764    /// Force merge all segments into one
765    pub async fn force_merge(&self) -> Result<()> {
766        // First commit any pending documents
767        self.commit().await?;
768        // Then merge all segments
769        self.do_merge().await
770    }
771}
772
773#[cfg(test)]
774mod tests {
775    use super::*;
776    use crate::directories::RamDirectory;
777    use crate::dsl::SchemaBuilder;
778
779    #[tokio::test]
780    async fn test_index_create_and_search() {
781        let mut schema_builder = SchemaBuilder::default();
782        let title = schema_builder.add_text_field("title", true, true);
783        let body = schema_builder.add_text_field("body", true, true);
784        let schema = schema_builder.build();
785
786        let dir = RamDirectory::new();
787        let config = IndexConfig::default();
788
789        // Create index and add documents
790        let writer = IndexWriter::create(dir.clone(), schema.clone(), config.clone())
791            .await
792            .unwrap();
793
794        let mut doc1 = Document::new();
795        doc1.add_text(title, "Hello World");
796        doc1.add_text(body, "This is the first document");
797        writer.add_document(doc1).await.unwrap();
798
799        let mut doc2 = Document::new();
800        doc2.add_text(title, "Goodbye World");
801        doc2.add_text(body, "This is the second document");
802        writer.add_document(doc2).await.unwrap();
803
804        writer.commit().await.unwrap();
805
806        // Open for reading
807        let index = Index::open(dir, config).await.unwrap();
808        assert_eq!(index.num_docs(), 2);
809
810        // Check postings
811        let postings = index.get_postings(title, b"world").await.unwrap();
812        assert_eq!(postings.len(), 1); // One segment
813        assert_eq!(postings[0].1.doc_count(), 2); // Two docs with "world"
814
815        // Retrieve document
816        let doc = index.doc(0).await.unwrap().unwrap();
817        assert_eq!(doc.get_first(title).unwrap().as_text(), Some("Hello World"));
818    }
819
820    #[tokio::test]
821    async fn test_multiple_segments() {
822        let mut schema_builder = SchemaBuilder::default();
823        let title = schema_builder.add_text_field("title", true, true);
824        let schema = schema_builder.build();
825
826        let dir = RamDirectory::new();
827        let config = IndexConfig {
828            max_docs_per_segment: 5, // Small segments for testing
829            ..Default::default()
830        };
831
832        let writer = IndexWriter::create(dir.clone(), schema.clone(), config.clone())
833            .await
834            .unwrap();
835
836        // Add documents in batches to create multiple segments
837        for batch in 0..3 {
838            for i in 0..5 {
839                let mut doc = Document::new();
840                doc.add_text(title, format!("Document {} batch {}", i, batch));
841                writer.add_document(doc).await.unwrap();
842            }
843            writer.commit().await.unwrap();
844        }
845
846        // Open and check
847        let index = Index::open(dir, config).await.unwrap();
848        assert_eq!(index.num_docs(), 15);
849        assert_eq!(index.segment_readers().len(), 3);
850    }
851
852    #[tokio::test]
853    async fn test_segment_merge() {
854        let mut schema_builder = SchemaBuilder::default();
855        let title = schema_builder.add_text_field("title", true, true);
856        let schema = schema_builder.build();
857
858        let dir = RamDirectory::new();
859        let config = IndexConfig {
860            max_docs_per_segment: 3,
861            ..Default::default()
862        };
863
864        let writer = IndexWriter::create(dir.clone(), schema.clone(), config.clone())
865            .await
866            .unwrap();
867
868        // Create multiple segments
869        for i in 0..9 {
870            let mut doc = Document::new();
871            doc.add_text(title, format!("Document {}", i));
872            writer.add_document(doc).await.unwrap();
873        }
874        writer.commit().await.unwrap();
875
876        // Should have 3 segments
877        let index = Index::open(dir.clone(), config.clone()).await.unwrap();
878        assert_eq!(index.segment_readers().len(), 3);
879
880        // Force merge
881        let writer = IndexWriter::open(dir.clone(), config.clone())
882            .await
883            .unwrap();
884        writer.force_merge().await.unwrap();
885
886        // Should have 1 segment now
887        let index = Index::open(dir, config).await.unwrap();
888        assert_eq!(index.segment_readers().len(), 1);
889        assert_eq!(index.num_docs(), 9);
890
891        // Verify all documents accessible
892        for i in 0..9 {
893            let doc = index.doc(i).await.unwrap().unwrap();
894            assert_eq!(
895                doc.get_first(title).unwrap().as_text(),
896                Some(format!("Document {}", i).as_str())
897            );
898        }
899    }
900
901    #[tokio::test]
902    async fn test_match_query() {
903        let mut schema_builder = SchemaBuilder::default();
904        let title = schema_builder.add_text_field("title", true, true);
905        let body = schema_builder.add_text_field("body", true, true);
906        let schema = schema_builder.build();
907
908        let dir = RamDirectory::new();
909        let config = IndexConfig::default();
910
911        let writer = IndexWriter::create(dir.clone(), schema.clone(), config.clone())
912            .await
913            .unwrap();
914
915        let mut doc1 = Document::new();
916        doc1.add_text(title, "rust programming");
917        doc1.add_text(body, "Learn rust language");
918        writer.add_document(doc1).await.unwrap();
919
920        let mut doc2 = Document::new();
921        doc2.add_text(title, "python programming");
922        doc2.add_text(body, "Learn python language");
923        writer.add_document(doc2).await.unwrap();
924
925        writer.commit().await.unwrap();
926
927        let index = Index::open(dir, config).await.unwrap();
928
929        // Test match query with multiple default fields
930        let results = index.query("rust", 10).await.unwrap();
931        assert_eq!(results.hits.len(), 1);
932
933        // Test match query with multiple tokens
934        let results = index.query("rust programming", 10).await.unwrap();
935        assert!(!results.hits.is_empty());
936
937        // Verify hit has address (segment_id + doc_id)
938        let hit = &results.hits[0];
939        assert!(!hit.address.segment_id.is_empty(), "Should have segment_id");
940
941        // Verify document retrieval by address
942        let doc = index.get_document(&hit.address).await.unwrap().unwrap();
943        assert!(
944            !doc.field_values().is_empty(),
945            "Doc should have field values"
946        );
947
948        // Also verify doc retrieval directly by global doc_id
949        let doc = index.doc(0).await.unwrap().unwrap();
950        assert!(
951            !doc.field_values().is_empty(),
952            "Doc should have field values"
953        );
954    }
955
956    #[tokio::test]
957    async fn test_slice_cache_warmup_and_load() {
958        use crate::directories::SliceCachingDirectory;
959
960        let mut schema_builder = SchemaBuilder::default();
961        let title = schema_builder.add_text_field("title", true, true);
962        let body = schema_builder.add_text_field("body", true, true);
963        let schema = schema_builder.build();
964
965        let dir = RamDirectory::new();
966        let config = IndexConfig::default();
967
968        // Create index with some documents
969        let writer = IndexWriter::create(dir.clone(), schema.clone(), config.clone())
970            .await
971            .unwrap();
972
973        for i in 0..10 {
974            let mut doc = Document::new();
975            doc.add_text(title, format!("Document {} about rust", i));
976            doc.add_text(body, format!("This is body text number {}", i));
977            writer.add_document(doc).await.unwrap();
978        }
979        writer.commit().await.unwrap();
980
981        // Open with slice caching and perform some operations to warm up cache
982        let caching_dir = SliceCachingDirectory::new(dir.clone(), 1024 * 1024);
983        let index = Index::open(caching_dir, config.clone()).await.unwrap();
984
985        // Perform a search to warm up the cache
986        let results = index.query("rust", 10).await.unwrap();
987        assert!(!results.hits.is_empty());
988
989        // Check cache stats - should have cached some data
990        let stats = index.slice_cache_stats();
991        assert!(stats.total_bytes > 0, "Cache should have data after search");
992
993        // Save the cache
994        index.save_slice_cache().await.unwrap();
995
996        // Verify cache file was written
997        assert!(
998            dir.exists(Path::new(super::SLICE_CACHE_FILENAME))
999                .await
1000                .unwrap()
1001        );
1002
1003        // Now open with cache loading
1004        let index2 = Index::open_with_cache(dir.clone(), config.clone(), 1024 * 1024)
1005            .await
1006            .unwrap();
1007
1008        // Cache should be prefilled
1009        let stats2 = index2.slice_cache_stats();
1010        assert!(
1011            stats2.total_bytes > 0,
1012            "Cache should be prefilled from file"
1013        );
1014
1015        // Search should still work
1016        let results2 = index2.query("rust", 10).await.unwrap();
1017        assert_eq!(results.hits.len(), results2.hits.len());
1018    }
1019
1020    #[tokio::test]
1021    async fn test_multivalue_field_indexing_and_search() {
1022        let mut schema_builder = SchemaBuilder::default();
1023        let uris = schema_builder.add_text_field("uris", true, true);
1024        let title = schema_builder.add_text_field("title", true, true);
1025        let schema = schema_builder.build();
1026
1027        let dir = RamDirectory::new();
1028        let config = IndexConfig::default();
1029
1030        // Create index and add document with multi-value field
1031        let writer = IndexWriter::create(dir.clone(), schema.clone(), config.clone())
1032            .await
1033            .unwrap();
1034
1035        let mut doc = Document::new();
1036        doc.add_text(uris, "one");
1037        doc.add_text(uris, "two");
1038        doc.add_text(title, "Test Document");
1039        writer.add_document(doc).await.unwrap();
1040
1041        // Add another document with different uris
1042        let mut doc2 = Document::new();
1043        doc2.add_text(uris, "three");
1044        doc2.add_text(title, "Another Document");
1045        writer.add_document(doc2).await.unwrap();
1046
1047        writer.commit().await.unwrap();
1048
1049        // Open for reading
1050        let index = Index::open(dir, config).await.unwrap();
1051        assert_eq!(index.num_docs(), 2);
1052
1053        // Verify document retrieval preserves all values
1054        let doc = index.doc(0).await.unwrap().unwrap();
1055        let all_uris: Vec<_> = doc.get_all(uris).collect();
1056        assert_eq!(all_uris.len(), 2, "Should have 2 uris values");
1057        assert_eq!(all_uris[0].as_text(), Some("one"));
1058        assert_eq!(all_uris[1].as_text(), Some("two"));
1059
1060        // Verify to_json returns array for multi-value field
1061        let json = doc.to_json(index.schema());
1062        let uris_json = json.get("uris").unwrap();
1063        assert!(uris_json.is_array(), "Multi-value field should be an array");
1064        let uris_arr = uris_json.as_array().unwrap();
1065        assert_eq!(uris_arr.len(), 2);
1066        assert_eq!(uris_arr[0].as_str(), Some("one"));
1067        assert_eq!(uris_arr[1].as_str(), Some("two"));
1068
1069        // Verify both values are searchable
1070        let results = index.query("uris:one", 10).await.unwrap();
1071        assert_eq!(results.hits.len(), 1, "Should find doc with 'one'");
1072        assert_eq!(results.hits[0].address.doc_id, 0);
1073
1074        let results = index.query("uris:two", 10).await.unwrap();
1075        assert_eq!(results.hits.len(), 1, "Should find doc with 'two'");
1076        assert_eq!(results.hits[0].address.doc_id, 0);
1077
1078        let results = index.query("uris:three", 10).await.unwrap();
1079        assert_eq!(results.hits.len(), 1, "Should find doc with 'three'");
1080        assert_eq!(results.hits[0].address.doc_id, 1);
1081
1082        // Verify searching for non-existent value returns no results
1083        let results = index.query("uris:nonexistent", 10).await.unwrap();
1084        assert_eq!(results.hits.len(), 0, "Should not find non-existent value");
1085    }
1086}