ruvector_collections/lib.rs
1//! # Ruvector Collections
2//!
3//! Multi-collection management with aliases for organizing vector databases,
4//! plus the workspace's shared primality utility (ADR-151 / PIAL).
5//!
6//! ## Features
7//!
8//! - **Multiple Collections**: Organize vectors into separate collections
9//! - **Alias Management**: Create aliases for collection names
10//! - **Collection Statistics**: Track collection metrics
11//! - **Thread-safe**: Concurrent access using DashMap
12//! - **Persistence**: Store collections on disk
13//! - **Primality**: Deterministic Miller-Rabin + tabled fast paths for prime
14//! moduli used by ruvector-graph, micro-hnsw-wasm, sparsifier, attn-mincut,
15//! and pi-brain (see [`primality`])
16//!
17//! ## Example
18//!
19//! ```no_run
20//! use ruvector_collections::{CollectionManager, CollectionConfig};
21//! use ruvector_core::types::{DistanceMetric, HnswConfig};
22//! use std::path::PathBuf;
23//!
24//! # fn main() -> Result<(), Box<dyn std::error::Error>> {
25//! // Create a collection manager
26//! let manager = CollectionManager::new(PathBuf::from("./collections"))?;
27//!
28//! // Create a collection
29//! let config = CollectionConfig {
30//! dimensions: 384,
31//! distance_metric: DistanceMetric::Cosine,
32//! hnsw_config: Some(HnswConfig::default()),
33//! quantization: None,
34//! on_disk_payload: true,
35//! };
36//!
37//! manager.create_collection("documents", config)?;
38//!
39//! // Create an alias
40//! manager.create_alias("current_docs", "documents")?;
41//!
42//! // Get collection by name or alias
43//! let collection = manager.get_collection("current_docs").unwrap();
44//! # Ok(())
45//! # }
46//! ```
47
48#![warn(missing_docs)]
49#![warn(clippy::all)]
50
51pub mod collection;
52pub mod error;
53pub mod manager;
54pub mod primality;
55
56pub use collection::{Collection, CollectionConfig, CollectionStats};
57pub use error::{CollectionError, Result};
58pub use manager::CollectionManager;