Skip to main content

Crate reddb

Crate reddb 

Source
Expand description

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
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
LocalBackend
Local filesystem backend. Copies files between paths. This is the default backend – operates entirely on local disk.
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.
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
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
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
SortOrder
StorageMode
StoreError
Errors from UnifiedStore operations
TraversalDirection
UnifiedMetadataFilter
Metadata filter operations

Constants§

DEFAULT_EXPORT_RETENTION
DEFAULT_MANIFEST_EVENT_HISTORY
DEFAULT_SNAPSHOT_RETENTION
PHYSICAL_METADATA_PROTOCOL_VERSION
REDDB_FORMAT_VERSION
REDDB_PROTOCOL_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
has_keyring_password
Check if keyring has a stored password
resolve_password
Resolve password from multiple sources (priority order)
save_to_keyring
Save password to system keyring
snapshot_store

Type Aliases§

IndexCatalogSnapshot
RedDBResult
UnifiedSegmentId
Unique identifier for a segment