nodedb_types/
lib.rs

1// SPDX-License-Identifier: Apache-2.0
2
3//! Shared NodeDB type definitions: strong IDs (TenantId, VShardId, RequestId,
4//! Lsn, Surrogate), error types (NodeDbError + ErrorCode + ErrorDetails), wire
5//! types for cross-plane and cross-node messages, value types, configuration
6//! schemas, and the approximate-aggregate sketches.
7//!
8//! Every NodeDB workspace crate depends on this. Items here form the stable
9//! cross-crate vocabulary; types specific to one engine live in that engine's
10//! crate.
11
12pub mod audit_dml;
13pub mod config;
14pub mod quota;
15
16pub mod approx;
17pub mod array_cell;
18pub mod backup_envelope;
19pub mod bbox;
20pub mod calvin;
21pub mod clone;
22pub mod collection;
23pub mod collection_config;
24pub mod columnar;
25pub mod conversion;
26pub mod datetime;
27pub mod diagnostic;
28pub mod document;
29pub mod dropped_collection;
30pub mod error;
31pub mod filter;
32pub mod geometry;
33pub mod graph;
34pub mod hlc;
35pub mod hnsw;
36pub mod id;
37pub mod id_gen;
38pub mod json_msgpack;
39pub mod kv;
40pub mod kv_parsing;
41pub mod lsn;
42pub mod mirror;
43pub mod multi_vector;
44pub mod namespace;
45pub mod protocol;
46pub mod result;
47pub mod sparse_vector;
48pub mod surrogate;
49pub mod surrogate_bitmap;
50pub mod sync;
51pub mod temporal;
52pub mod text_search;
53pub mod timeseries;
54pub mod trace;
55pub mod typeguard;
56pub mod value;
57pub mod vector_ann;
58pub mod vector_distance;
59pub mod vector_dtype;
60pub mod vector_index_stats;
61pub mod vector_model;
62pub mod wire_version;
63
64pub use approx::{CountMinSketch, HyperLogLog, SpaceSaving, TDigest};
65pub use array_cell::ArrayCell;
66pub use audit_dml::AuditDmlMode;
67pub use bbox::{BoundingBox, geometry_bbox};
68pub use clone::{CloneOrigin, CloneStatus, MAX_CLONE_DEPTH};
69pub use collection::{CollectionType, CollectionTypeParseError};
70pub use collection_config::{PayloadAtom, PayloadIndexKind, PrimaryEngine, VectorPrimaryConfig};
71pub use columnar::{
72    ColumnDef, ColumnType, ColumnarProfile, ColumnarSchema, DocumentMode, SchemaError, StrictSchema,
73};
74pub use config::TuningConfig;
75pub use datetime::{NdbDateTime, NdbDateTimeError, NdbDuration};
76pub use document::Document;
77pub use dropped_collection::DroppedCollection;
78pub use error::NodeDbError;
79pub use filter::{EdgeFilter, MetadataFilter};
80pub use graph::{Direction, GraphStats};
81pub use hlc::{Hlc, HlcClock};
82pub use hnsw::{HnswCheckpoint, HnswNodeSnapshot, HnswParams};
83pub use id::{
84    CollectionId, DatabaseId, DocumentId, EdgeId, EdgeIdParseError, IdError, IdType, NodeId,
85    ShapeId, TenantId,
86};
87pub use json_msgpack::{
88    JsonValue, json_from_msgpack, json_to_msgpack, json_to_msgpack_or_empty,
89    msgpack_to_json_string, value_from_msgpack, value_to_msgpack,
90};
91pub use kv::{KV_DEFAULT_INLINE_THRESHOLD, KvConfig, KvTtlPolicy, is_valid_kv_key_type};
92pub use lsn::Lsn;
93pub use mirror::{MirrorLagRecord, MirrorMode, MirrorOrigin, MirrorStatus};
94pub use multi_vector::{MultiVector, MultiVectorError, MultiVectorScoreMode};
95pub use namespace::Namespace;
96pub use quota::{
97    PriorityClass, PriorityClassParseError, QuotaRecord, QuotaSpec, QuotaValidationError,
98};
99pub use result::{QueryResult, SearchResult, SubGraph};
100pub use sparse_vector::{SparseVector, SparseVectorError};
101pub use surrogate::Surrogate;
102pub use surrogate_bitmap::SurrogateBitmap;
103pub use sync::compensation::CompensationHint;
104pub use sync::shape::{ShapeDefinition, ShapeType};
105pub use sync::violation::ViolationType;
106pub use sync::wire::{SyncFrame, SyncMessageType};
107pub use temporal::{
108    BitemporalFilter, BitemporalInterval, LsnMapError, LsnMsAnchor, LsnMsMap, NANOS_PER_MS,
109    OPEN_UPPER, OrdinalClock, ValidTimePredicate, lsn_to_ms, ms_to_ordinal_upper, ordinal_to_ms,
110};
111pub use text_search::{Bm25Params, QueryMode, TextSearchParams};
112pub use trace::{SpanId, TraceId};
113pub use typeguard::TypeGuardFieldDef;
114pub use value::Value;
115pub use vector_ann::{VectorAnnOptions, VectorQuantization};
116pub use vector_dtype::VectorStorageDtype;
117pub use vector_index_stats::{VectorIndexQuantization, VectorIndexStats, VectorIndexType};
118pub use vector_model::{VectorModelEntry, VectorModelMetadata};
nodedb_types/lib.rs

nodedb_types/
lib.rs
