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 clone;
21pub mod collection;
22pub mod collection_config;
23pub mod columnar;
24pub mod conversion;
25pub mod datetime;
26pub mod document;
27pub mod dropped_collection;
28pub mod error;
29pub mod filter;
30pub mod geometry;
31pub mod graph;
32pub mod hlc;
33pub mod hnsw;
34pub mod id;
35pub mod id_gen;
36pub mod json_msgpack;
37pub mod kv;
38pub mod kv_parsing;
39pub mod lsn;
40pub mod mirror;
41pub mod multi_vector;
42pub mod namespace;
43pub mod protocol;
44pub mod result;
45pub mod sparse_vector;
46pub mod surrogate;
47pub mod surrogate_bitmap;
48pub mod sync;
49pub mod temporal;
50pub mod text_search;
51pub mod timeseries;
52pub mod trace;
53pub mod typeguard;
54pub mod value;
55pub mod vector_ann;
56pub mod vector_distance;
57pub mod vector_index_stats;
58pub mod vector_model;
59pub mod wire_version;
60
61pub use approx::{CountMinSketch, HyperLogLog, SpaceSaving, TDigest};
62pub use array_cell::ArrayCell;
63pub use audit_dml::AuditDmlMode;
64pub use bbox::{BoundingBox, geometry_bbox};
65pub use clone::{CloneOrigin, CloneStatus, MAX_CLONE_DEPTH};
66pub use collection::{CollectionType, CollectionTypeParseError};
67pub use collection_config::{PayloadAtom, PayloadIndexKind, PrimaryEngine, VectorPrimaryConfig};
68pub use columnar::{
69    ColumnDef, ColumnType, ColumnarProfile, ColumnarSchema, DocumentMode, SchemaError, StrictSchema,
70};
71pub use config::TuningConfig;
72pub use datetime::{NdbDateTime, NdbDateTimeError, NdbDuration};
73pub use document::Document;
74pub use dropped_collection::DroppedCollection;
75pub use error::NodeDbError;
76pub use filter::{EdgeFilter, MetadataFilter};
77pub use graph::Direction;
78pub use hlc::{Hlc, HlcClock};
79pub use hnsw::{HnswCheckpoint, HnswNodeSnapshot, HnswParams};
80pub use id::{
81    CollectionId, DatabaseId, DocumentId, EdgeId, EdgeIdParseError, IdError, IdType, NodeId,
82    ShapeId, TenantId,
83};
84pub use json_msgpack::{
85    JsonValue, json_from_msgpack, json_to_msgpack, json_to_msgpack_or_empty,
86    msgpack_to_json_string, value_from_msgpack, value_to_msgpack,
87};
88pub use kv::{KV_DEFAULT_INLINE_THRESHOLD, KvConfig, KvTtlPolicy, is_valid_kv_key_type};
89pub use lsn::Lsn;
90pub use mirror::{MirrorLagRecord, MirrorMode, MirrorOrigin, MirrorStatus};
91pub use multi_vector::{MultiVector, MultiVectorError, MultiVectorScoreMode};
92pub use namespace::Namespace;
93pub use quota::{
94    PriorityClass, PriorityClassParseError, QuotaRecord, QuotaSpec, QuotaValidationError,
95};
96pub use result::{QueryResult, SearchResult, SubGraph};
97pub use sparse_vector::{SparseVector, SparseVectorError};
98pub use surrogate::Surrogate;
99pub use surrogate_bitmap::SurrogateBitmap;
100pub use sync::compensation::CompensationHint;
101pub use sync::shape::{ShapeDefinition, ShapeType};
102pub use sync::violation::ViolationType;
103pub use sync::wire::{SyncFrame, SyncMessageType};
104pub use temporal::{
105    BitemporalFilter, BitemporalInterval, LsnMapError, LsnMsAnchor, LsnMsMap, NANOS_PER_MS,
106    OPEN_UPPER, OrdinalClock, ValidTimePredicate, lsn_to_ms, ms_to_ordinal_upper, ordinal_to_ms,
107};
108pub use text_search::{Bm25Params, QueryMode, TextSearchParams};
109pub use trace::{SpanId, TraceId};
110pub use typeguard::TypeGuardFieldDef;
111pub use value::Value;
112pub use vector_ann::{VectorAnnOptions, VectorQuantization};
113pub use vector_index_stats::{VectorIndexQuantization, VectorIndexStats, VectorIndexType};
114pub use vector_model::{VectorModelEntry, VectorModelMetadata};
nodedb_types/lib.rs

nodedb_types/
lib.rs
