Module lifecycle 

Store lifecycle and memory accounting. Store lifecycle and memory accounting.

Modules

durability

Explicit per-store and per-commit durability policy.

lock

Store ownership via a process-local registry and an OS file lock.

Structs

CancelToken

A clonable, thread-safe request to cancel one query without partial results.

CascadeRule

A child namespace’s ownership reference to a parent namespace.

Deadline

A monotonic absolute query deadline.

DocumentCount

Exact live-row count from one pinned store generation.

DocumentFields

Bit-set selecting the optional fields copied by Store::get_documents.

DocumentGroup

One group and its exact live-document count.

DocumentGroupCounts

Grouped live-document counts from one pinned store generation.

DocumentScanCursor

Opaque-to-callers continuation for one published store generation.

DocumentScanPage

One bounded page returned by Store::scan_documents.

DocumentScanRequest

One bounded document-scan request.

GraphSearchOptions

Traversal controls carried only when a caller explicitly selects the graph tier.

InMemorySegment

One complete already-built segment whose vector buffers can be adopted by a store.

LiveNamespaceMutation

A same-process writable participant and its ordered mutations.

MaterializedRow

One owned source row corresponding to a ranked query hit.

NamespaceMutation

One namespace’s ordered upserts, deletes, then predicate delete.

NamespaceRootId

Random, nonzero identity of a complete namespace root, independent of its path.

OpenMigrations

Changes completed by this open. Format versions remain manifest v2 / WAL v1.

OpenOptions

Store-open configuration.

PreparedSegment

Store-owned, exactly accounted anonymous buffers waiting to be sealed.

PublishedSnapshot

One atomically published generation and its immutable segment readers.

QueryCancellation

Cheap cooperative stop check shared by one query and its snapshot lease.

QueryFilter

Validated scan-compatible query constraints. Ranking statistics remain corpus-wide.

QueryMaterializer

Rank-addressed text access available only inside a Store query callback.

ScanRescoreOptions

Controls the candidate frontier of each active or sealed segment.

SearchOptions

Store-search controls, separating scan worker budget from tier selection.

SnapshotLease

One admitted read’s strong ownership of its published snapshot.

Stats

One point-in-time snapshot of resources owned by an open Store.

Store

One explicitly closeable embedded-store handle.

StoredDocument

One live document copied from a single pinned store generation.

SystemMonotonicClock

The standard-library monotonic clock used by ordinary stores.

Enums

AccessMode

Filesystem authority requested for one store handle.

DeadlineError

Failure while constructing a monotonic deadline.

DocumentGroupValue

The value shared by every document of one group.

DocumentScanSource

Source position named by a document-scan continuation.

HybridPreparationError

Preserves a deferred vector producer’s typed error separately from search.

InMemorySegmentFactors

Owned vector-factor buffers for one already-built in-memory segment.

MaterializationError

A ranked row could not be materialized faithfully.

QueryControl

The mandatory cooperative stop mechanism carried by one store query.

QueryError

Typed failure from a store-admitted query.

ScanDirection

Direction of an attribute-ordered document scan.

ScanOrder

Deterministic ordering used by Store::scan_documents.

SearchTier

Per-query execution tier at the public store seam.

SnapshotTargetReason

Why a snapshot target was rejected.

StoreError

An open, lifecycle, or close operation was rejected.

StoreErrorKind

Coarse, exhaustive classification of a StoreError, stable for hosts that map engine failures onto their own status codes. Every variant of StoreError maps to exactly one kind; adding a variant is a compile error here until it is classified.

StoreState

Explicit lifecycle state for one store handle.

Constants

DEFAULT_READER_DRAIN_TIMEOUT

Default grace period given to admitted readers before close cancellation.

MAX_DOCUMENT_GROUP_LIMIT

Largest group limit accepted by Store::count_documents_grouped.

MAX_DOCUMENT_SCAN_LIMIT

Largest document page accepted by the core and C ABI.

Traits

MonotonicClock

A monotonic time source.

Functions

namespace_batch

Atomically commits ordered namespace mutations through one root rename.

namespace_batch_live

Commits changes through caller-owned writable namespace handles.

namespace_declare_cascade

Durably declares a cascade while owning the root and participant writer locks. Participants supply the existing parent/child specs; mutation fields must be empty.

namespace_delete_cascade

Deletes explicit IDs and all declared transitive dependants in one root commit. Supply every reachable namespace with its existing options. Only deletes may be populated. All ZE-239 closed-writer and logical-deletion limits apply.

namespace_relocate

Converts a complete legacy namespace root into an absent destination.