Struct LanceDB

pub struct LanceDB { /* private fields */ }

Available on crate feature lancedb only.

LanceDB is a columnar database that separates data and compute.

This enables local, embedded databases, or storing in a cloud storage.

See examples for more information.

Implements Persist and Retrieve.

If you want to store / retrieve metadata in Lance, the columns can be defined with with_metadata.

Note: For querying large tables you manually need to create an index. You can get an active connection via get_connection.

Example

LanceDB::builder()
.uri("/my/lancedb")
.vector_size(1536)
.with_vector(EmbeddedField::Combined)
.with_metadata("Metadata field to also store")
.table_name("swiftide_test")
.build()
.unwrap();

Implementations

impl LanceDB

pub fn builder() -> LanceDBBuilder

pub async fn get_connection(&self) -> Result<Object<LanceDBPoolManager>>

Get a connection to LanceDB from the connection pool

Errors

Returns an error if the connection cannot be retrieved.

pub async fn open_table(&self) -> Result<Table>

Opens the lancedb table

Errors

Returns an error if the table cannot be opened or the connection cannot be acquired.

Trait Implementations

impl Clone for LanceDB

fn clone(&self) -> LanceDB

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LanceDB

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

Formats the value using the given formatter.

impl Persist for LanceDB

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, ) -> Pin<Box<dyn Future<Output = Result<Node>> + Send + 'async_trait>>

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

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

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

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

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

impl<Q: ExecutableQuery + Send + Sync + 'static> Retrieve<CustomStrategy<Q>> for LanceDB

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

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

Implements vector similarity search for LanceDB using a custom query strategy.

Type Parameters

• VectorQuery - LanceDB’s query type for vector similarity search

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

impl Retrieve<SimilaritySingleEmbedding<String>> for LanceDB

Implement the Retrieve trait for SimilaritySingleEmbedding search strategy.

Can be used in the query pipeline to retrieve documents from LanceDB.

Supports filters as strings. Refer to the LanceDB documentation for the format.

fn retrieve<'life0, 'life1, 'async_trait>( &'life0 self, search_strategy: &'life1 SimilaritySingleEmbedding<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 Retrieve<SimilaritySingleEmbedding> for LanceDB

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