Skip to main content

Crate reddb_server

Crate reddb_server 

Source

Re-exports§

pub use crate::api::tier_wiring;
pub use crate::api::Capability;
pub use crate::api::CapabilitySet;
pub use crate::api::CatalogService;
pub use crate::api::CatalogSnapshot;
pub use crate::api::CollectionStats;
pub use crate::api::DataOps;
pub use crate::api::QueryPlanner;
pub use crate::api::RedDBError;
pub use crate::api::RedDBOptions;
pub use crate::api::RedDBResult;
pub use crate::api::SchemaManifest;
pub use crate::api::StorageMode;
pub use crate::api::DEFAULT_EXPORT_RETENTION;
pub use crate::api::DEFAULT_SNAPSHOT_RETENTION;
pub use crate::api::REDDB_FORMAT_VERSION;
pub use crate::api::REDDB_PROTOCOL_VERSION;
pub use crate::application::AdminUseCases;
pub use crate::application::CatalogUseCases;
pub use crate::application::EntityUseCases;
pub use crate::application::GraphUseCases;
pub use crate::application::NativeUseCases;
pub use crate::application::QueryUseCases;
pub use crate::application::RuntimeAdminPort;
pub use crate::application::RuntimeCatalogPort;
pub use crate::application::RuntimeEntityPort;
pub use crate::application::RuntimeGraphPort;
pub use crate::application::RuntimeNativePort;
pub use crate::application::RuntimeQueryPort;
pub use crate::application::RuntimeSchemaPort;
pub use crate::application::SchemaUseCases;
pub use crate::catalog::snapshot_store;
pub use crate::catalog::CatalogModelSnapshot;
pub use crate::catalog::CollectionDescriptor;
pub use crate::catalog::SchemaMode;
pub use crate::engine::EngineInfo;
pub use crate::engine::EngineStats;
pub use crate::engine::RedDBEngine;
pub use crate::grpc::GrpcServerOptions;
pub use crate::grpc::GrpcTlsOptions;
pub use crate::grpc::RedDBGrpcServer;
pub use crate::health::HealthIssue;
pub use crate::health::HealthProvider;
pub use crate::health::HealthReport;
pub use crate::health::HealthState;
pub use crate::index::IndexCatalog;
pub use crate::index::IndexCatalogSnapshot;
pub use crate::index::IndexConfig;
pub use crate::index::IndexKind;
pub use crate::index::IndexMetric;
pub use crate::index::IndexRuntime;
pub use crate::index::IndexStats;
pub use crate::physical::provision_shm;
pub use crate::physical::read_shm_header;
pub use crate::physical::set_shm_provisioning_enabled;
pub use crate::physical::shm_path_for;
pub use crate::physical::shm_provisioning_enabled;
pub use crate::physical::ArtifactState;
pub use crate::physical::CompactionPolicy;
pub use crate::physical::GridLayout;
pub use crate::physical::PhysicalIndexState;
pub use crate::physical::PhysicalLayout;
pub use crate::physical::PhysicalMetadataFile;
pub use crate::physical::ShmHandle;
pub use crate::physical::ShmProvisionState;
pub use crate::physical::WalPolicy;
pub use crate::physical::DEFAULT_MANIFEST_EVENT_HISTORY;
pub use crate::replication::ReplicationConfig;
pub use crate::replication::ReplicationRole;
pub use crate::runtime::ConnectionPoolConfig;
pub use crate::runtime::RedDBRuntime;
pub use crate::runtime::RuntimeConnection;
pub use crate::runtime::RuntimeFilter;
pub use crate::runtime::RuntimeFilterValue;
pub use crate::runtime::RuntimeGraphCentralityAlgorithm;
pub use crate::runtime::RuntimeGraphCentralityResult;
pub use crate::runtime::RuntimeGraphCentralityScore;
pub use crate::runtime::RuntimeGraphClusteringResult;
pub use crate::runtime::RuntimeGraphCommunity;
pub use crate::runtime::RuntimeGraphCommunityAlgorithm;
pub use crate::runtime::RuntimeGraphCommunityResult;
pub use crate::runtime::RuntimeGraphComponent;
pub use crate::runtime::RuntimeGraphComponentsMode;
pub use crate::runtime::RuntimeGraphComponentsResult;
pub use crate::runtime::RuntimeGraphCyclesResult;
pub use crate::runtime::RuntimeGraphDegreeScore;
pub use crate::runtime::RuntimeGraphDirection;
pub use crate::runtime::RuntimeGraphEdge;
pub use crate::runtime::RuntimeGraphHitsResult;
pub use crate::runtime::RuntimeGraphNeighborhoodResult;
pub use crate::runtime::RuntimeGraphNode;
pub use crate::runtime::RuntimeGraphPath;
pub use crate::runtime::RuntimeGraphPathAlgorithm;
pub use crate::runtime::RuntimeGraphPathResult;
pub use crate::runtime::RuntimeGraphPattern;
pub use crate::runtime::RuntimeGraphProjection;
pub use crate::runtime::RuntimeGraphTopologicalSortResult;
pub use crate::runtime::RuntimeGraphTraversalResult;
pub use crate::runtime::RuntimeGraphTraversalStrategy;
pub use crate::runtime::RuntimeGraphVisit;
pub use crate::runtime::RuntimeIvfMatch;
pub use crate::runtime::RuntimeIvfSearchResult;
pub use crate::runtime::RuntimeQueryResult;
pub use crate::runtime::RuntimeQueryWeights;
pub use crate::runtime::RuntimeStats;
pub use crate::runtime::ScanCursor;
pub use crate::runtime::ScanPage;
pub use crate::server::RedDBServer;
pub use crate::server::ServerOptions;
pub use crate::server::ServerReplicationState;
pub use reddb_wire as wire_proto;
pub use crate::storage::*;

Modules§

ai
External AI provider integration primitives.
api
Public API layer for the RedDB crate.
application
auth
Authentication & Authorization
backup_bootstrap
Env-driven BackupBootstrap (issue #517).
catalog
Logical catalog structures for the unified multi-structure model.
cli
cluster
Shared cluster identity and membership model.
config
crypto
ec
engine
Engine layer facade.
geo
Geographic computation module.
grpc
health
Health and diagnostics types for RedDB services.
index
Index layer contracts and in-memory index catalogue.
json
Re-export shim for the in-house JSON aggregator + json! macro (ADR 0053). Both the crate::json::{Value, Map, to_vec, ...} aggregator module and the crate::json! macro now live in reddb-io-types; this single re-export carries both namespaces so every existing call-site (200+ uses of crate::json::... and crate::json!(...)) compiles unchanged. Replaces the former pub mod json; + local json.rs aggregator.
json_field
SerializedJsonField — typed guard for JSON-envelope construction.
log
High-performance append-only log collections.
mcp
MCP (Model Context Protocol) server for RedDB.
modules
notifications
Ephemeral notification primitive (issue #720, PRD #718).
operational_bootstrap
Operational bootstrap planning for deployment topology and runtime config.
physical
Physical storage design primitives for RedDB’s deterministic on-disk layout.
prelude
regress
Regression test harness — Post-MVP credibility item.
replication
Replication Module
rpc_stdio
JSON-RPC 2.0 line-delimited stdio mode for the red binary.
runtime
Embedded runtime with connection pooling, scans and health.
serde_json
Re-export shim: the in-house JSON encode/decode stack now lives in reddb-io-types (ADR 0053). This module preserves every crate::serde_json::... import path — including the json! macro re-exported into this namespace — so the 200+ call-sites across the server compile unchanged. The byte layout of Value is owned by reddb_types::serde_json; nothing about the wire/payload format changed in the move.
server
Minimal HTTP server for RedDB management and remote access.
service_cli
sqlstate
SQLSTATE error codes — Post-MVP credibility item.
storage
streams
Durable stream primitive (issue #721, PRD #718).
telemetry
Structured logging façade over tracing + tracing-subscriber.
utils
wire

Macros§

json
Re-export shim for the in-house JSON aggregator + json! macro (ADR 0053). Both the crate::json::{Value, Map, to_vec, ...} aggregator module and the crate::json! macro now live in reddb-io-types; this single re-export carries both namespaces so every existing call-site (200+ uses of crate::json::... and crate::json!(...)) compiles unchanged. Replaces the former pub mod json; + local json.rs aggregator.

Structs§

BlockReference
ExportDescriptor
ManifestEvent
ManifestPointers
PhysicalAnalyticsJob
PhysicalGraphProjection
ShmHeader
SnapshotDescriptor
SuperblockHeader
TimelineHistory
TimelineId

Enums§

CollectionModel
The logical multi-structure model a collection presents (table, graph, vector, queue, …). Referenced as a field type by the canonical SQL AST (CreateCollectionQuery/CreateTableQuery and their builders), so it is re-homed here (ADR 0053, RQL Phase 2) to keep the AST free of a reddb-server leaf edge. The server’s crate::catalog re-export shim keeps existing call-sites untouched.
ManifestEventKind

Constants§

DEFAULT_METADATA_JOURNAL_RETENTION
Retention applied when the seq-N catalog journal is enabled at the Max tier. See seqn_journal_retention.
OPT_IN_METADATA_JOURNAL_RETENTION
Retention applied when the seq-N catalog journal is opt-in enabled outside of the Max tier, keeping forensics surface minimal on lower tiers.
PHYSICAL_METADATA_PROTOCOL_VERSION
SHM_FILE_SIZE
SHM_HEADER_SIZE
SHM_MAGIC
SHM_VERSION

Functions§

fold_dwb_into_wal_enabled
Whether the pager should fold DWB into WAL (no <data>-dwb sidecar). Reads still tolerate the legacy sidecar so existing databases keep working through the flag flip.
fold_pager_meta_enabled
Whether the pager should fold metadata into page 1 only and skip the <data>-meta sidecar shadow. Reads still tolerate the sidecar so existing databases keep working through the flag flip.
meta_json_sidecar_enabled
Whether new metadata writes should additionally emit the JSON sidecar. Defaults to false; opt-in via set_meta_json_sidecar_enabled or the REDDB_META_JSON_SIDECAR=1 env var. Reads always tolerate either JSON or binary.
seqn_journal_enabled
Whether new metadata saves should also emit a seq-N journal entry.
seqn_journal_retention
Resolved retention bound for the seq-N journal. Falls back to env REDDB_SEQN_JOURNAL_RETENTION, then to OPT_IN_METADATA_JOURNAL_RETENTION.
set_fold_dwb_into_wal_enabled
Process-wide opt-in for folding the double-write buffer into the WAL via full-page-image records.
set_fold_pager_meta_enabled
Process-wide opt-in for folding pager metadata (page 1) into the datafile without an adjacent <data>-meta shadow.
set_meta_json_sidecar_enabled
Process-wide opt-in for the legacy <data>.meta.json sidecar.
set_seqn_journal_enabled
Process-wide opt-in for the seq-N catalog journal.
set_seqn_journal_retention
Process-wide retention for the seq-N journal. 0 resets to defaults (env or off-tier baseline).