Skip to main content

khive_storage/
lib.rs

1//! Storage capability traits: `SqlAccess`, `VectorStore`, `TextSearch`,
2//! `GraphStore`, `NoteStore`, `EntityStore`, `EventStore`, `SparseStore`,
3//! `BlobStore`, and `AttachmentStore`.
4
5pub mod agent;
6pub mod attachment;
7pub mod blob;
8pub mod capability;
9pub mod entity;
10pub mod error;
11pub mod event;
12pub mod graph;
13pub mod note;
14pub mod operation_context;
15pub mod request_context;
16pub mod sparse;
17pub mod sql;
18pub mod telemetry;
19#[cfg(feature = "test-support")]
20pub mod test_support;
21pub mod text;
22pub mod tx_registry;
23pub mod types;
24pub mod usage;
25pub mod vectors;
26
27pub use agent::AgentStore;
28pub use attachment::{Attachment, AttachmentStore, AttachmentSubstrate, NewAttachment};
29pub use blob::{
30    BlobOrphanSweepConfig, BlobOrphanSweepResult, BlobStore, ContentRef, UploadId,
31    MAX_BLOB_WHOLE_BYTES,
32};
33pub use capability::StorageCapability;
34pub use entity::{Entity, EntityFilter, EntityStore};
35pub use error::{StorageError, WriterTaskRequestState};
36
37pub use event::{
38    Event, EventFilter, EventObservation, EventStore, EventView, ObservationRole, ReferentKind,
39};
40pub use graph::GraphStore;
41pub use note::{FilterOp, Note, NoteFilter, NoteStore, SortDir};
42pub use request_context::{
43    await_request_read_phase, capture_request_read_context, effective_request_read_deadline,
44    ensure_request_read_active, inherit_request_read_cancellation, inherit_request_read_context,
45    request_read_is_cancelled, request_read_timeout_from_env, scope_request_read_cancellation,
46    scope_request_read_deadline, scope_request_read_deadline_at,
47    wait_for_request_read_cancellation, RequestReadContext, RequestReadDeadline,
48    RequestReadStopReason, DEFAULT_REQUEST_READ_TIMEOUT_SECS,
49};
50pub use sparse::SparseStore;
51pub use sql::{AtomicUnitOp, BoxFuture, SqlAccess, SqlReader, SqlWriter, TopLevelMaintenance};
52pub use telemetry::{
53    ChannelBackoffArmedPayload, ChannelBackoffResetPayload, ChannelHeartbeatPersistFailedPayload,
54    ChannelPollFailedPayload, ChannelPollStartedPayload, ChannelPollSucceededPayload,
55    CheckpointOutcomeRecordedPayload, ConfigLockedPayload, LifecycleEvent, PhaseCancelledPayload,
56    PhaseCompletedPayload, PhaseStartedPayload,
57};
58pub use text::TextSearch;
59pub use types::StorageResult;
60pub use vectors::VectorStore;
61
62pub use types::{
63    BatchWriteError, BatchWriteErrorClass, BatchWriteErrorCount, BatchWriteRetryability,
64    BatchWriteSummary, BoundedCount, DeleteMode, DirectedNeighborHit, Direction, Edge, EdgeFilter,
65    EdgeSeekPage, EdgeSortField, EdgeUpsertDisposition, EdgeUpsertRefusal, EdgeUpsertRequest,
66    EdgeUpsertResult, GraphPath, GuardedBatchOutcome, GuardedBatchRefusal, GuardedEdgeBatchRefusal,
67    GuardedEdgeBatchUpsertOutcome, GuardedEdgeUpsertOutcome, GuardedWriteOutcome,
68    IndexRebuildScope, LimitReport, LinkId, MissingEndpoints, NeighborCursor, NeighborHit,
69    NeighborQuery, OrphanSweepConfig, OrphanSweepResult, Page, PageRequest, PathNode,
70    PropertyFilter, PropertyOp, SeekCursor, SeekPage, SortDirection, SortOrder, SparseRecord,
71    SparseSearchHit, SparseSearchRequest, SparseVector, SqlRow, SqlStatement, SqlValue,
72    TextDocument, TextFilter, TextGatherMode, TextIndexStats, TextQueryMode, TextSearchHit,
73    TextSearchOptions, TextSearchRequest, TextTermStats, TextTermStatsRequest, TimeRange,
74    TraversalExecutionBudget, TraversalOptions, TraversalRequest, VectorIndexKind,
75    VectorMetadataFilter, VectorRecord, VectorSearchHit, VectorSearchRequest,
76    VectorStoreCapabilities, VectorStoreInfo, DEFAULT_TRAVERSAL_LIMIT,
77    MAX_BATCH_WRITE_ERROR_DETAILS, MAX_BATCH_WRITE_ERROR_MESSAGE_CHARS, MAX_SPARSE_SEARCH_TOP_K,
78    MAX_TRAVERSAL_DEPTH, MAX_TRAVERSAL_LIMIT, MAX_TRAVERSAL_MILLIS, MAX_TRAVERSAL_ROOTS,
79    MAX_TRAVERSAL_WORK,
80};
81
82pub use khive_types::{
83    AgentRecord, AgentState, EdgeCategory, EdgeRelation, EventOutcome, SubstrateKind,
84    TerminalReason,
85};