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

nodedb_types/
lib.rs
