Struct VectorTable 

pub struct VectorTable {
    pub name: String,
    pub schema: VectorSchema,
    pub engine: Engine,
    /* private fields */
}

One registered vector index.

A VectorTable couples the protocol-level VectorSchema (what the client asked for) with the storage-level Engine (what is actually persisted). The pair is immutable for the lifetime of the index; rebuilding a schema means dropping and recreating the table.

Alongside the schema and engine, the table tracks the set of document keys that the FT.* surface has indexed via HSET interception. The set is used by VectorRegistry::drop_with_dd to enumerate the underlying hash documents that should also be removed.

Fields

name: String

Index name (the FT.CREATE first argument).

schema: VectorSchema

Compiled schema.

engine: Engine

Storage + index engine.

Implementations

impl VectorTable

pub fn record_indexed_key(&self, key: Vec<u8>)

Record key as having been indexed. Idempotent.

pub fn indexed_keys(&self) -> Vec<Vec<u8>>

Snapshot the set of indexed keys.

pub fn has_text_field(&self, field: &str) -> bool

True when the schema declares a TEXT field named field. The check is case-sensitive (the FT.CREATE parser preserves the field name verbatim). After an FT.ALTER ADD <field> TEXT the schema vector remains frozen (it lives on an immutable Arc<VectorTable>), so this method also consults the runtime TextFieldIndex map: a field that the registry has provisioned a trigram index for is treated as a TEXT field for the lifetime of the table.

pub fn add_text_field(&self, field: &str) -> bool

Provision a runtime TextFieldIndex for field.

Used by FT.ALTER ADD <field> TEXT to extend an already-registered table with a new text-indexed field. Idempotent: a second call for the same field is a no-op and returns false.

Returns true when a new index slot was provisioned, false when the field was already known (either as part of the original schema or because a prior FT.ALTER provisioned it).

pub fn text_field_names(&self) -> Vec<String>

Snapshot the set of TEXT fields known to this table: the original SCHEMA declarations plus anything provisioned later through Self::add_text_field. Names are returned in lexicographic order.

pub fn has_text_index(&self, field: &str) -> bool

True when the registry has provisioned a TextIndex for field. The check returns true exactly when Self::has_text_field returns true; exposed separately so wire-level tests can assert that the FT.CREATE path actually populated the registry rather than just recorded the schema.

pub fn text_index_doc_count(&self, field: &str) -> Option<usize>

Number of documents currently indexed under field. Returns None when no TEXT field by that name is declared in the schema.

pub fn upsert_text_field(&self, field: &str, key: &[u8], text: &[u8])

Insert text into the TextIndex for field, associating it with the user-visible key. If the same key had a prior entry under this field it is removed first so the postings index never accumulates stale doc ids.

No-op when the schema has no TEXT field by that name; callers can therefore call this for every HSET field/value pair without prior schema lookup.

pub fn search_text_substring( &self, field: &str, query: &[u8], ) -> Option<Vec<TextHit>>

Run an exact-substring lookup against the TextIndex registered under field. Returns the user-visible keys whose stored text contains query as a contiguous byte substring, paired with the original text bytes.

Returns None when no TEXT field by that name is declared in the schema. Callers translate that into a -ERR reply.

pub fn search_text_regex(&self, field: &str, pattern: &str) -> TextRegexResult

Run an exact-regex lookup against the TextIndex registered under field. Returns the user-visible keys whose stored text matches pattern, paired with the original text bytes.

Returns None when no TEXT field by that name is declared in the schema, or Some(Err(...)) when the pattern fails to compile.

pub fn search_text_regex_approx( &self, field: &str, pattern: &str, max_errors: u16, ) -> TextRegexApproxResult

Run an approximate-regex lookup against the TextIndex registered under field with up to max_errors edit operations. Returns the user-visible keys whose stored text approximately matches pattern, paired with the original text bytes.

Returns None when no TEXT field by that name is declared in the schema, or Some(Err(...)) when the pattern fails to compile through the TRE engine.

Trait Implementations

impl Debug for VectorTable

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.