Struct Duckdb 

pub struct Duckdb<T: Chunk = String> { /* private fields */ }

Available on crate feature duckdb only.

Provides Persist, Retrieve, and NodeCache for duckdb

Unfortunately Metadata is not stored.

Supports the following search strategies:

• SimilaritySingleEmbedding
• HybridSearch (https://motherduck.com/blog/search-using-duckdb-part-3/)
• Custom

NOTE: The integration is not optimized for ultra large datasets / load. It might work, if it doesn’t let us know <3.

Implementations

impl Duckdb<String>

pub fn builder() -> DuckdbBuilder<String>

impl<T: Chunk> Duckdb<T>

pub fn table_name(&self) -> &str

Name of the indexing table

pub fn cache_table(&self) -> &str

Name of the cache table

pub fn connection(&self) -> &Mutex<Connection>

Returns the connection to the database

pub fn create_vector_indices(&self) -> Result<()>

Creates HNSW indices on the vector fields

These are not persisted. You must recreate them on startup.

If you want to persist them, refer to the duckdb documentation.

Errors

Errors if the connection or statement fails

Panics

If the mutex locking the connection is poisoned

pub async fn lazy_create_cache(&self) -> Result<()>

Safely creates the cache table if it does not exist. Can be used concurrently

Errors

Errors if the table or index could not be created

Panics

If the mutex locking the connection is poisoned

pub fn node_key(&self, node: &Node<T>) -> String

Formats a node key for the cache table

Trait Implementations

impl<T: Clone + Chunk> Clone for Duckdb<T>

fn clone(&self) -> Duckdb<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Chunk> Debug for Duckdb<T>

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

Formats the value using the given formatter.

impl<T: Chunk> NodeCache for Duckdb<T>

type Input = T

fn get<'life0, 'life1, 'async_trait>( &'life0 self, node: &'life1 Node<T>, ) -> Pin<Box<dyn Future<Output = bool> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

fn set<'life0, 'life1, 'async_trait>( &'life0 self, node: &'life1 Node<T>, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

fn clear<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Optionally provide a method to clear the cache

fn name(&self) -> &'static str

impl<T: Chunk + AsRef<str>> Persist for Duckdb<T>

type Input = T

type Output = T

fn setup<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

fn store<'life0, 'async_trait>( &'life0 self, node: Node<T>, ) -> Pin<Box<dyn Future<Output = Result<Node<T>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

fn batch_store<'life0, 'async_trait>( &'life0 self, nodes: Vec<Node<T>>, ) -> Pin<Box<dyn Future<Output = IndexingStream<T>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

fn batch_size(&self) -> Option<usize>

fn name(&self) -> &'static str

impl<T: Chunk> Retrieve<CustomStrategy<String>> for Duckdb<T>

fn retrieve<'life0, 'life1, 'async_trait>( &'life0 self, search_strategy: &'life1 CustomStrategy<String>, query: Query<Pending>, ) -> Pin<Box<dyn Future<Output = Result<Query<Retrieved>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

fn name(&self) -> &'static str

impl<T: Chunk> Retrieve<HybridSearch> for Duckdb<T>

fn retrieve<'life0, 'life1, 'async_trait>( &'life0 self, search_strategy: &'life1 HybridSearch, query: Query<Pending>, ) -> Pin<Box<dyn Future<Output = Result<Query<Retrieved>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

fn name(&self) -> &'static str

impl<T: Chunk> Retrieve<SimilaritySingleEmbedding> for Duckdb<T>

fn retrieve<'life0, 'life1, 'async_trait>( &'life0 self, search_strategy: &'life1 SimilaritySingleEmbedding, query: Query<Pending>, ) -> Pin<Box<dyn Future<Output = Result<Query<Retrieved>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

fn name(&self) -> &'static str