Struct SqliteSearchFilter 

pub struct SqliteSearchFilter { /* private fields */ }

Available on crate feature sqlite only.

Search filter for SQLite vector searches.

SQLite vector search applies simple indexed metadata comparisons and ranges during sqlite-vec KNN candidate search when possible. Other supported document-table expressions, including JSON expressions, OR, null checks, LIKE, and GLOB, are applied after candidate search with an exhaustive candidate limit so custom document columns can still be filtered correctly.

For hot scalar filters, prefer marking columns with Column::indexed so they can be pushed into sqlite-vec metadata constraints instead of requiring exhaustive candidate retrieval.

Implementations

impl SqliteSearchFilter

pub fn not(self) -> SqliteSearchFilter

Negates a filter.

SQLite vector search lowers NOT over simple indexed metadata comparisons to native operators such as !=, <=, and >=. Broader negations are applied as document-table post-filters when their expressions can be lowered safely.

pub fn between<N>(key: String, range: RangeInclusive<N>) -> SqliteSearchFilter

where N: Into<Value>,

Tests whether a value is contained in the range.

Non-boolean indexed metadata ranges are applied during sqlite-vec candidate search. Document-table ranges are applied after candidate search and may require exhaustive candidate retrieval.

pub fn is_null(key: String) -> SqliteSearchFilter

pub fn is_not_null(key: String) -> SqliteSearchFilter

pub fn glob(key: String, pattern: impl Into<String>) -> SqliteSearchFilter

Tests whether the value at key satisfies the glob pattern.

sqlite-vec cannot enforce GLOB during candidate search, so this is applied as a document-table post-filter.

pub fn like(key: String, pattern: impl Into<String>) -> SqliteSearchFilter

Tests whether the value at key satisfies the LIKE pattern.

sqlite-vec cannot enforce LIKE during candidate search, so this is applied as a document-table post-filter.

Trait Implementations

impl Clone for SqliteSearchFilter

fn clone(&self) -> SqliteSearchFilter

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SqliteSearchFilter

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

Formats the value using the given formatter.

impl Default for SqliteSearchFilter

fn default() -> SqliteSearchFilter

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SqliteSearchFilter

fn deserialize<__D>( __deserializer: __D, ) -> Result<SqliteSearchFilter, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl SearchFilter for SqliteSearchFilter

type Value = Value

fn eq( key: impl AsRef<str>, value: <SqliteSearchFilter as SearchFilter>::Value, ) -> SqliteSearchFilter

fn gt( key: impl AsRef<str>, value: <SqliteSearchFilter as SearchFilter>::Value, ) -> SqliteSearchFilter

fn lt( key: impl AsRef<str>, value: <SqliteSearchFilter as SearchFilter>::Value, ) -> SqliteSearchFilter

fn and(self, rhs: SqliteSearchFilter) -> SqliteSearchFilter

fn or(self, rhs: SqliteSearchFilter) -> SqliteSearchFilter

impl Serialize for SqliteSearchFilter

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.