Skip to main content

Crate tauri_plugin_velesdb

Crate tauri_plugin_velesdb 

Source
Expand description

§tauri-plugin-velesdb

A Tauri plugin for VelesDB - Vector search in desktop applications.

This plugin provides seamless integration of VelesDB’s vector database capabilities into Tauri desktop applications.

§Features

  • Collection Management: Create, list, and delete vector collections
  • Vector Operations: Insert, update, and delete vectors with payloads
  • Vector Search: Fast similarity search with multiple distance metrics
  • Text Search: BM25 full-text search across payloads
  • Hybrid Search: Combined vector + text search with RRF fusion
  • VelesQL: SQL-like query language for advanced searches

§Usage

§Rust (Plugin Registration)

fn main() {
    tauri::Builder::default()
        .plugin(tauri_plugin_velesdb::init("./data"))
        .run(tauri::generate_context!())
        .expect("error while running tauri application");
}

§JavaScript (Frontend)

import { invoke } from '@tauri-apps/api/core';

// Create a collection
await invoke('plugin:velesdb|create_collection', {
  request: { name: 'documents', dimension: 768, metric: 'cosine' }
});

// Insert vectors
await invoke('plugin:velesdb|upsert', {
  request: {
    collection: 'documents',
    points: [{ id: 1, vector: [...], payload: { title: 'Doc' } }]
  }
});

// Search
const results = await invoke('plugin:velesdb|search', {
  request: { collection: 'documents', vector: [...], topK: 10 }
});

Re-exports§

pub use error::CommandError;
pub use error::Error;
pub use error::Result;
pub use state::VelesDbState;

Modules§

commands
Tauri commands for VelesDB operations exposed via IPC.
commands_graph
Knowledge Graph Tauri commands (EPIC-061/US-008 refactoring).
error
Error types for the VelesDB Tauri plugin.
events
Tauri event system for VelesDB notifications (EPIC-015 US-004).
helpers
Helper functions for Tauri commands.
state
State management for the VelesDB Tauri plugin.
types
Request/Response DTOs for Tauri commands.

Structs§

SimpleIndexHandle
Handle to interact with the simple vector index.
SimpleIndexState
State for the simple vector index (used by VelesDbExt).
SimpleVectorIndex
Simple in-memory vector index for demo purposes. For production, use the full plugin commands with persistent storage.

Traits§

VelesDbExt
Extension trait for easy access to VelesDB from Tauri AppHandle.

Functions§

get_app_data_dir
Returns the platform-specific app data directory for VelesDB.
init
Initializes the VelesDB plugin with the default settings.
init_default
Alias for init() for backward compatibility.
init_with_app_data
Initializes the VelesDB plugin using the platform’s app data directory.
init_with_path
Initializes the VelesDB plugin with a custom data directory.