surrealdb-core 3.2.3

A scalable, distributed, collaborative, document-graph database, for the realtime web
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

//! Index support for the streaming executor.
//!
//! This module provides index analysis, access path selection, and index iteration
//! for the new streaming query executor. It supports:
//!
//! - B-tree indexes (Idx, Uniq) with equality, range, and compound access patterns
//! - Full-text search indexes (FullText) with MATCHES operator
//! - Vector similarity indexes (Hnsw) with KNN search
//! - Count indexes for COUNT(*) optimization
//!
//! ## Architecture
//!
//! ```text
//! ┌─────────────────────────────────────────────────────────────────┐
//! │                        Planner Phase                            │
//! ├─────────────────────────────────────────────────────────────────┤
//! │  IndexAnalyzer   →   IndexCandidate[]   →   select_access_path  │
//! │  (match WHERE)       (possible plans)       (choose best)       │
//! └─────────────────────────────────────────────────────────────────┘
//!                              │
//!                              ▼
//! ┌─────────────────────────────────────────────────────────────────┐
//! │                       Execution Phase                           │
//! ├─────────────────────────────────────────────────────────────────┤
//! │  AccessPath  →  IndexScan/FullTextScan/KnnScan  →  ValueBatch   │
//! └─────────────────────────────────────────────────────────────────┘
//! ```

pub(crate) mod access_path;
pub(crate) mod analysis;
pub(crate) mod iterator;

pub use analysis::IndexCandidate;