Crate reddb 

RedDB umbrella crate.

This crate is the published face of RedDB: it hosts the red binary and re-exports the workspace members so existing use reddb::… import paths keep resolving after the workspace split (PRD #54). The actual code lives in the four sibling crates:

• reddb-wire — connection-string parser + RedWire frames
• reddb-grpc-proto — generated tonic protobuf stubs
• reddb-server — engine, storage, runtime, replication, MCP, AI, server dispatch
• reddb-client — gRPC client + REPL used by the bins, plus the published high-level driver

Re-exports

pub use reddb_wire as wire_proto;

pub use reddb_client as client;

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

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

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

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

server

Minimal HTTP server for RedDB management and remote access.

service_cli

sqlstate

SQLSTATE error codes — Post-MVP credibility item.

storage

telemetry

Structured logging façade over tracing + tracing-subscriber.

utils

wire

wire_proto

RedDB wire protocol vocabulary.

Macros

json

Structs

AdjacencyEntry

An adjacency entry representing a single edge

AdminUseCases

BlockReference

CapabilitySet

CatalogModelSnapshot

CatalogSnapshot

CatalogUseCases

CollectionDescriptor

CollectionStats

ConnectionPoolConfig

CrossRef

A cross-reference between entities

DslFilter

A filter condition

EdgeData

Data for a graph edge

EmbeddingSlot

A slot for embedding a specific aspect of an entity

EngineInfo

EngineStats

Entity

A unified entity that can represent any storage type

EntityId

Unique identifier for any entity in the unified storage

EntityUseCases

ExportDescriptor

GraphAdjacencyIndex

Graph adjacency index for fast edge/neighbor lookups

GraphQueryBuilder

Builder for graph traversal queries

GraphUseCases

GridLayout

GrpcServerOptions

GrpcTlsOptions

PEM-encoded TLS material for gRPC’s tonic-rustls server.

HealthIssue

HealthReport

HybridQueryBuilder

Builder for complex hybrid queries

IndexCatalog

IndexConfig

IndexEvent

Index lifecycle event for tracking

IndexManager

Integrated Index Manager combining all index types

IndexMetric

IndexStats

IntegratedIndexConfig

Configuration for the integrated index system

IntegratedIndexManager

Integrated Index Manager combining all index types

InvertedIndex

Inverted index for full-text search

LayoutOverrides

Optional per-toggle override applied after preset expansion.

LayoutToggles

Fully expanded layout toggles after applying a preset and overrides.

LocalBackend

Local filesystem backend. Copies files between paths. This is the default backend – operates entirely on local disk.

LogRoutingOverrides

Per-log destination overrides. None keeps the tier default.

ManagerConfig

Configuration for the segment manager

ManagerStats

Manager statistics

ManifestEvent

ManifestPointers

MatchComponents

Score components from different query modes

Metadata

Metadata for an entity (key-value pairs)

MetadataStorage

Type-aware metadata storage

NativeUseCases

NodeData

Data for a graph node

PhysicalAnalyticsJob

PhysicalGraphProjection

PhysicalIndexState

PhysicalLayout

PhysicalMetadataFile

Query

Query builder entry point. Start all queries with Q::.

QueryResult

Result from a DSL query execution

QueryResultItem

Single item in query results

QueryUseCases

RedDB

RedDB - Unified Database with Best-in-Class DevX

RedDBEngine

RedDBGrpcServer

RedDBOptions

RedDBRuntime

RedDBServer

RefQueryBuilder

Builder for cross-reference traversal

ReplicationConfig

Configuration for replication.

RowData

Data for a table row

RuntimeConnection

RuntimeFilter

RuntimeGraphCentralityResult

RuntimeGraphCentralityScore

RuntimeGraphClusteringResult

RuntimeGraphCommunity

RuntimeGraphCommunityResult

RuntimeGraphComponent

RuntimeGraphComponentsResult

RuntimeGraphCyclesResult

RuntimeGraphDegreeScore

RuntimeGraphEdge

RuntimeGraphHitsResult

RuntimeGraphNeighborhoodResult

RuntimeGraphNode

RuntimeGraphPath

RuntimeGraphPathResult

RuntimeGraphPattern

RuntimeGraphProjection

RuntimeGraphTopologicalSortResult

RuntimeGraphTraversalResult

RuntimeGraphVisit

RuntimeIvfMatch

RuntimeIvfSearchResult

RuntimeQueryResult

RuntimeQueryWeights

RuntimeStats

ScanCursor

ScanPage

ScanQueryBuilder

Builder for full collection scans

SchemaManifest

SchemaUseCases

ScoredMatch

A matched entity with score and source information

SegmentManager

Segment manager for a collection

SegmentStats

Segment statistics

ServerOptions

ServerReplicationState

Replication state exposed to the HTTP server.

ShmHandle

Handle to the provisioned -shm file. Drop semantics intentionally minimal in this slice — callers must invoke Self::detach_reader explicitly to mirror the eventual mmap-backed lifecycle.

ShmHeader

SimilarResult

Result of a similarity search

SnapshotDescriptor

SparseVector

Sparse vector representation

Store

Unified storage for tables, graphs, and vectors

StoreStats

Statistics for UnifiedStore

SuperblockHeader

TableQueryBuilder

Builder for table/collection queries

TextSearchBuilder

Builder for full-text search queries

TextSearchResult

Result from a text search

TieredLayoutPaths

Deterministic paths derived from a data file and expanded layout.

TimeSeriesData

Time-series data point

TimeSeriesPointKind

UnifiedEntity

A unified entity that can represent any storage type

UnifiedSegmentConfig

Configuration for segments

UnifiedStore

Unified storage for tables, graphs, and vectors

UnifiedStoreConfig

Configuration for UnifiedStore

VectorData

Data for a vector

VectorQueryBuilder

Builder for vector similarity queries

VectorSearchResult

Result from a vector similarity search

WalPolicy

WhereClause

Fluent where clause for filter conditions

Enums

ArtifactState

Canonical artifact lifecycle states.

BackendError

Error type for backend operations.

Capability

CollectionModel

CompactionPolicy

EdgeDirection

Edge direction for adjacency lookups

EntityData

The actual data content of an entity

EntityKind

The kind of entity (what storage type it belongs to)

FilterOp

Filter operation

FilterValue

Filter value

HealthState

IndexEventKind

IndexKind

IndexStatus

Status of an index operation

IndexType

Types of indices that can be managed

LifecycleEvent

Lifecycle events for monitoring

LogDestination

Where a log stream should be written.

ManifestEventKind

MetadataQueryFilter

Filter for metadata queries

MetadataType

Metadata type enumeration

MetadataValue

Metadata value types

NativeHeaderRepairPolicy

PasswordSource

Result of password resolution

RedDBError

RefType

Types of cross-references between entities

ReplicationRole

Role of this RedDB instance in a replication cluster.

RuntimeFilterValue

RuntimeGraphCentralityAlgorithm

RuntimeGraphCommunityAlgorithm

RuntimeGraphComponentsMode

RuntimeGraphDirection

RuntimeGraphPathAlgorithm

RuntimeGraphTraversalStrategy

SchemaMode

SegmentError

Segment error types

SegmentState

Segment state in its lifecycle

ShmProvisionState

Outcome of a provisioning attempt — distinguishes a clean takeover from a crash recovery for diagnostics and tests.

SortOrder

StorageLayout

Storage layout preset for future tier-aware startup integration.

StorageMode

StoreError

Errors from UnifiedStore operations

TraversalDirection

UnifiedMetadataFilter

Metadata filter operations

Constants

DEFAULT_EXPORT_RETENTION

DEFAULT_MANIFEST_EVENT_HISTORY

DEFAULT_METADATA_JOURNAL_RETENTION

Retention applied when the seq-N catalog journal is enabled at the Max tier. See seqn_journal_retention.

DEFAULT_SNAPSHOT_RETENTION

OPT_IN_METADATA_JOURNAL_RETENTION

Retention applied when the seq-N catalog journal is opt-in enabled outside of the Max tier — keeps forensics surface minimal on lower tiers.

PHYSICAL_METADATA_PROTOCOL_VERSION

REDDB_FORMAT_VERSION

REDDB_PROTOCOL_VERSION

SHM_FILE_SIZE

SHM_HEADER_SIZE

SHM_MAGIC

SHM_VERSION

Traits

CatalogService

DataOps

HealthProvider

IndexRuntime

QueryPlanner

RemoteBackend

Trait for remote storage backends.

RuntimeAdminPort

RuntimeCatalogPort

RuntimeEntityPort

RuntimeGraphPort

RuntimeNativePort

RuntimeQueryPort

RuntimeSchemaPort

UnifiedSegment

A unified segment that stores all entity types

Functions

clear_keyring

Remove password from system keyring

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.

has_keyring_password

Check if keyring has a stored password

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 (escape hatch for ad-hoc debugging of a non-Max instance). Reads always tolerate either JSON or binary.

provision_shm

Provision the -shm substrate for a data file. Idempotent; safe to call from every open. See module docs for the lock protocol.

read_shm_header

Read the current header without taking ownership. Returns Ok(None) when the file does not exist; surfaces a real I/O error if the file is present but unreadable.

resolve_password

Resolve password from multiple sources (priority order)

save_to_keyring

Save password to system keyring

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 (4) — the conservative off-tier baseline.

set_fold_dwb_into_wal_enabled

Process-wide opt-in for folding the double-write buffer into the WAL via full-page-image (FPI) records. When enabled, the pager does not open or write <data>-dwb; recovery rebuilds torn pages from FPI records replayed before normal redo. Defaults off.

set_fold_pager_meta_enabled

Process-wide opt-in for folding pager metadata (page 1) into the datafile without an adjacent <data>-meta shadow. When enabled, the corruption- recovery shadow at <data>-meta is not written; readers trust page 1 (plus its overflow chain) as the single source of truth. Defaults off.

set_meta_json_sidecar_enabled

Process-wide opt-in for the legacy <data>.meta.json sidecar. Call once at startup after resolving the active [StorageLayout].

set_seqn_journal_enabled

Process-wide opt-in for the seq-N catalog journal (<data>.meta.rdbx.seq-N snapshot trail). Defaults off so non-Max tiers don’t accumulate forensic artifacts. Tier wiring should call this with true for Max. Escape hatch: REDDB_SEQN_JOURNAL=1.

set_seqn_journal_retention

Process-wide retention for the seq-N catalog journal. Tier wiring should call this with DEFAULT_METADATA_JOURNAL_RETENTION (32) for Max and OPT_IN_METADATA_JOURNAL_RETENTION (4) for opt-in non-Max use. 0 resets to defaults (env or off-tier baseline).

set_shm_provisioning_enabled

Process-wide opt-in for <data>.shm provisioning. Default off so existing single-writer flows (minimal) keep their current shape. Tier wiring should call this with true when tier >= Standard. Escape hatch: REDDB_SHM_PROVISION=1.

shm_path_for

Sibling path of the -shm substrate file for a given data file.

shm_provisioning_enabled

Whether the open path should provision a <data>.shm file.

snapshot_store

Type Aliases

IndexCatalogSnapshot

RedDBResult

UnifiedSegmentId

Unique identifier for a segment