Expand description
Storage capability traits — contracts that backend implementations satisfy.
This crate contains zero implementations. It defines:
SqlAccess: base SQL capability (reader / writer / transaction)VectorStore: embedding storage and similarity searchTextSearch: full-text search and document indexingGraphStore: directed edge CRUD and graph traversalNoteStore: temporal-referential note CRUDEventStore: append-only operation log- Shared types (
SqlValue,VectorSearchHit,TextSearchHit, etc.) StorageError: unified error type
Re-exports§
pub use capability::StorageCapability;pub use entity::Entity;pub use entity::EntityFilter;pub use entity::EntityStore;pub use error::StorageError;pub use event::Event;pub use event::EventFilter;pub use event::EventStore;pub use graph::GraphStore;pub use note::Note;pub use note::NoteStore;pub use sql::SqlAccess;pub use sql::SqlReader;pub use sql::SqlTransaction;pub use sql::SqlWriter;pub use text::TextSearch;pub use types::StorageResult;pub use vectors::VectorStore;pub use types::BatchWriteSummary;pub use types::DeleteMode;pub use types::Direction;pub use types::Edge;pub use types::EdgeFilter;pub use types::EdgeSortField;pub use types::GraphPath;pub use types::IndexRebuildScope;pub use types::LinkId;pub use types::NeighborHit;pub use types::NeighborQuery;pub use types::Page;pub use types::PageRequest;pub use types::PathNode;pub use types::SortDirection;pub use types::SortOrder;pub use types::SqlIsolation;pub use types::SqlRow;pub use types::SqlStatement;pub use types::SqlTxOptions;pub use types::SqlValue;pub use types::TextDocument;pub use types::TextFilter;pub use types::TextIndexStats;pub use types::TextQueryMode;pub use types::TextSearchHit;pub use types::TextSearchRequest;pub use types::TimeRange;pub use types::TraversalOptions;pub use types::TraversalRequest;pub use types::VectorIndexKind;pub use types::VectorMetadataFilter;pub use types::VectorRecord;pub use types::VectorSearchHit;pub use types::VectorSearchRequest;pub use types::VectorStoreCapabilities;pub use types::VectorStoreInfo;
Modules§
- capability
- Storage capability surface identifiers.
- entity
- Entity storage capability — graph node CRUD.
- error
- Storage error types shared across all backend implementations.
- event
- Event storage capability — append-only operation log (ADR-004).
- graph
- Graph storage capability — edge CRUD and traversal.
- note
- Note storage capability — temporal-referential record CRUD.
- sql
- SQL access capability traits.
- text
- Full-text search capability (ADR-024).
- types
- Shared types used across storage capability traits.
- vectors
- Vector embedding storage and similarity search capability (ADR-024, ADR-041).
Enums§
- Edge
Category - The 6 structural categories that group the 13 canonical edge relations.
- Edge
Relation - Closed set of 13 canonical edge relations (ADR-002, ADR-021).
- Event
Outcome - Substrate
Kind - The 3 substrate types in khive OSS (ADR-004).