Package com.apple.foundationdb.async.guardiann

package com.apple.foundationdb.async.guardiann

Classes related to GUARDIANN - Guided Updatable cluster Assignment and Routing via Distance-based Indexing for ANN searches. See Guardiann for an introduction.

Related Packages

Package	Description
com.apple.foundationdb.async	Utility functions for use within an asynchronous environment.
com.apple.foundationdb.async.common	Common logic for all kinds of structures for effectively searching, retrieving and managing vectors.
com.apple.foundationdb.async.hnsw	Classes and interfaces related to the HNSW implementation as used for vector indexes.
com.apple.foundationdb.async.rtree	Classes and interfaces related to the Hilbert R-tree implementation.

Class	Description
ClusterCapacityExceededException	Thrown by an insert when a primary cluster reaches its configured hard cap (primaryClusterHardMax) while the write path is not draining deferred maintenance tasks in the writing transaction.
Config	Configuration for the Guardiann vector structure.
Config.ConfigBuilder	Builder for Config.
Guardiann	A transactional approximate nearest neighbor (ANN) vector structure built on top of FoundationDB.
Locator	Wires up and holds the shared collaborators of a Guardiann structure: its StorageAdapter, the Executor, and the lazily-created Primitives, Search, Insert and Delete operation objects.
OnReadListener	Callbacks invoked whenever the structure reads from the database.
OnWriteListener	Interface for callbacks whenever we write data to the database.
SearchConfig	The performance/recall tuning knobs for a single Guardiann search.
SearchConfig.SearchConfigBuilder	Builder for SearchConfig.
TaskKind	The kinds of deferred task Guardiann enqueues.