tauri-plugin-velesdb

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

Features

• 🚀 Fast Vector Search - Microsecond latency similarity search
• 📝 Text Search - BM25 full-text search across payloads
• 🔀 Hybrid Search - Combined vector + text with RRF fusion
• 🔄 Multi-Query Fusion - MQG support with RRF/Weighted strategies
• 🗃️ Collection Management - Create, list, and delete collections
• 📊 VelesQL - SQL-like query language
• 🕸️ Knowledge Graph - Add edges, traverse, get node degrees ⭐ NEW
• 📡 Event System - Real-time notifications for data changes ⭐ NEW
• 🔒 Local-First - All data stays on the user's device

Installation

Rust (Cargo.toml)

[dependencies]
tauri-plugin-velesdb = "0.1"

JavaScript (package.json)

{
  "dependencies": {
    "@wiscale/tauri-plugin-velesdb": "^0.6.0"
  }
}

npm install @wiscale/tauri-plugin-velesdb
# pnpm add @wiscale/tauri-plugin-velesdb
# yarn add @wiscale/tauri-plugin-velesdb

Usage

Rust - Plugin Registration

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

JavaScript - Frontend API

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

// Create a collection
await invoke('plugin:velesdb|create_collection', {
  request: {
    name: 'documents',
    dimension: 768,
    metric: 'cosine',  // cosine, euclidean, dot, hamming, jaccard
    storageMode: 'full'  // full, sq8, binary
  }
});

// List collections
const collections = await invoke('plugin:velesdb|list_collections');
console.log(collections);
// [{ name: 'documents', dimension: 768, metric: 'cosine', count: 0 }]

// Insert vectors
await invoke('plugin:velesdb|upsert', {
  request: {
    collection: 'documents',
    points: [
      {
        id: 1,
        vector: [0.1, 0.2, 0.3, /* ... 768 dims */],
        payload: { title: 'Introduction to AI', category: 'tech' }
      },
      {
        id: 2,
        vector: [0.4, 0.5, 0.6, /* ... */],
        payload: { title: 'Machine Learning Guide', category: 'tech' }
      }
    ]
  }
});

// Vector similarity search
const results = await invoke('plugin:velesdb|search', {
  request: {
    collection: 'documents',
    vector: [0.15, 0.25, 0.35, /* ... */],
    topK: 5
  }
});
console.log(results);
// { results: [{ id: 1, score: 0.98, payload: {...} }], timingMs: 0.5 }

// Text search (BM25)
const textResults = await invoke('plugin:velesdb|text_search', {
  request: {
    collection: 'documents',
    query: 'machine learning guide',
    topK: 10
  }
});

// Hybrid search (vector + text)
const hybridResults = await invoke('plugin:velesdb|hybrid_search', {
  request: {
    collection: 'documents',
    vector: [0.1, 0.2, /* ... */],
    query: 'AI introduction',
    topK: 10,
    vectorWeight: 0.7  // 0.0-1.0, higher = more vector influence
  }
});

// Multi-query fusion search (MQG) ⭐ NEW
const mqResults = await invoke('plugin:velesdb|multi_query_search', {
  request: {
    collection: 'documents',
    vectors: [
      [0.1, 0.2, /* ... query 1 */],
      [0.3, 0.4, /* ... query 2 */],
      [0.5, 0.6, /* ... query 3 */]
    ],
    topK: 10,
    fusion: 'rrf',  // 'rrf', 'average', 'maximum', 'weighted'
    fusionParams: { k: 60 }  // RRF parameter
  }
});

// Weighted fusion (like SearchXP scoring)
const weightedResults = await invoke('plugin:velesdb|multi_query_search', {
  request: {
    collection: 'documents',
    vectors: [[...], [...], [...]],
    topK: 10,
    fusion: 'weighted',
    fusionParams: {
      avgWeight: 0.6,
      maxWeight: 0.3,
      hitWeight: 0.1
    }
  }
});

// VelesQL query
const queryResults = await invoke('plugin:velesdb|query', {
  request: {
    query: "SELECT * FROM documents WHERE content MATCH 'rust' LIMIT 10",
    params: {}
  }
});

// Delete collection
await invoke('plugin:velesdb|delete_collection', { name: 'documents' });

// ============================================
// Knowledge Graph API ⭐ NEW
// ============================================

// Add an edge to the knowledge graph
await invoke('plugin:velesdb|add_edge', {
  request: {
    collection: 'documents',
    id: 1,
    source: 100,  // source node ID
    target: 200,  // target node ID
    label: 'REFERENCES',
    properties: { weight: 0.8, created: '2026-01-27' }
  }
});

// Get edges (by label, source, or target)
const edges = await invoke('plugin:velesdb|get_edges', {
  request: {
    collection: 'documents',
    label: 'REFERENCES'  // or source: 100, or target: 200
  }
});

// Traverse the graph (BFS or DFS)
const traversal = await invoke('plugin:velesdb|traverse_graph', {
  request: {
    collection: 'documents',
    source: 100,
    maxDepth: 3,
    relTypes: ['REFERENCES', 'CITES'],  // optional filter
    limit: 50,
    algorithm: 'bfs'  // or 'dfs'
  }
});

// Get node degree (in/out connections)
const degree = await invoke('plugin:velesdb|get_node_degree', {
  request: {
    collection: 'documents',
    nodeId: 100
  }
});
console.log(degree);
// { nodeId: 100, inDegree: 5, outDegree: 3 }

Event System ⭐ NEW

Listen to real-time database changes:

import { listen } from '@tauri-apps/api/event';

// Collection created
await listen('velesdb://collection-created', (event) => {
  console.log('New collection:', event.payload.collection);
});

// Collection updated (upsert/delete)
await listen('velesdb://collection-updated', (event) => {
  console.log(`${event.payload.operation}: ${event.payload.count} items`);
});

// Collection deleted
await listen('velesdb://collection-deleted', (event) => {
  console.log('Deleted:', event.payload.collection);
});

// Operation progress (for long operations)
await listen('velesdb://operation-progress', (event) => {
  console.log(`Progress: ${event.payload.progress}%`);
});

API Reference

Commands

Events

Storage Modes

Distance Metrics

Permissions

Add to your capabilities/default.json:

{
  "permissions": [
    "velesdb:default"
  ]
}

Or for granular control:

{
  "permissions": [
    "velesdb:allow-create-collection",
    "velesdb:allow-search",
    "velesdb:allow-upsert"
  ]
}

Example App

See the examples/basic-app directory for a complete Tauri app using this plugin.

Performance

License

Elastic License 2.0 (ELv2)

See LICENSE for details.