@aalis/plugin-vectorstore-lancedb 0.1.0

package/README.md

@@ -0,0 +1,21 @@
+# @aalis/plugin-vectorstore-lancedb
+
+运行时插件
+
+## 角色
+
+运行时插件
+
+## 安装
+
+```bash
+pnpm add @aalis/plugin-vectorstore-lancedb
+```
+
+## 文档
+
+详见 [docs/plugins/plugin-vectorstore-lancedb.md](../../docs/plugins/plugin-vectorstore-lancedb.md)。
+
+## 许可
+
+见仓库根目录 LICENSE。

package/dist/index.d.ts

@@ -0,0 +1,12 @@
+import type { ConfigSchema, Context } from '@aalis/core';
+export declare const name = "@aalis/plugin-vectorstore-lancedb";
+export declare const displayName = "LanceDB \u5411\u91CF\u5E93";
+export declare const subsystem = "embedding";
+export declare const provides: string[];
+export declare const configSchema: ConfigSchema;
+export declare const defaultConfig: {
+    path: string;
+    tableName: string;
+};
+export declare function apply(ctx: Context, config: Record<string, unknown>): Promise<void>;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAgBzD,eAAO,MAAM,IAAI,sCAAsC,CAAC;AACxD,eAAO,MAAM,WAAW,+BAAgB,CAAC;AACzC,eAAO,MAAM,SAAS,cAAc,CAAC;AACrC,eAAO,MAAM,QAAQ,UAAkB,CAAC;AAExC,eAAO,MAAM,YAAY,EAAE,YAQ1B,CAAC;AAEF,eAAO,MAAM,aAAa;;;CAGzB,CAAC;AA8HF,wBAAsB,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAyBxF"}

package/dist/index.js

@@ -0,0 +1,157 @@
+import { createStorageGateway } from '@aalis/plugin-storage-api';
+import { connect } from '@lancedb/lancedb';
+function toUri(input) {
+    const s = String(input ?? '').trim();
+    if (!s)
+        return 'data:/lancedb';
+    if (s.includes(':/'))
+        return s;
+    const cleaned = s.replace(/^\.?\/+/, '');
+    const idx = cleaned.indexOf('/');
+    return idx > 0 ? `${cleaned.slice(0, idx)}:/${cleaned.slice(idx + 1)}` : `data:/${cleaned}`;
+}
+// ===== 插件元数据 =====
+export const name = '@aalis/plugin-vectorstore-lancedb';
+export const displayName = 'LanceDB 向量库';
+export const subsystem = 'embedding';
+export const provides = ['vectorstore'];
+export const configSchema = {
+    path: {
+        type: 'string',
+        label: '数据库目录',
+        default: 'data:/lancedb',
+        description: 'LanceDB 数据存储 storage URI（也兼容裸名/相对路径）',
+    },
+    tableName: { type: 'string', label: '表名', default: 'vectors', description: '向量表名称' },
+};
+export const defaultConfig = {
+    path: 'data:/lancedb',
+    tableName: 'vectors',
+};
+// ===== LanceDB 向量存储实现 =====
+class LanceDBVectorStore {
+    db;
+    table = null;
+    dbPath;
+    tableName;
+    logger;
+    constructor(dbPath, tableName, logger) {
+        this.dbPath = dbPath;
+        this.tableName = tableName;
+        this.logger = logger;
+    }
+    /** 初始化连接（必须在使用前调用） */
+    async init() {
+        this.db = await connect(this.dbPath);
+        // 尝试打开已有表
+        const tableNames = await this.db.tableNames();
+        if (tableNames.includes(this.tableName)) {
+            this.table = await this.db.openTable(this.tableName);
+        }
+    }
+    async add(vector, metadata) {
+        const record = {
+            vector,
+            metadata_json: JSON.stringify(metadata),
+        };
+        if (!this.table) {
+            // 首次写入时创建表
+            this.table = await this.db.createTable(this.tableName, [record]);
+            this.logger?.info(`LanceDB 表 "${this.tableName}" 已创建`);
+        }
+        else {
+            await this.table.add([record]);
+        }
+    }
+    async search(queryVector, topK) {
+        if (!this.table)
+            return [];
+        const count = await this.table.countRows();
+        if (count === 0)
+            return [];
+        const results = await this.table.search(queryVector).limit(topK).toArray();
+        return results.map(row => ({
+            score: 1 - (row._distance ?? 0), // LanceDB 返回 L2 距离，转换为相似度
+            metadata: JSON.parse(row.metadata_json),
+        }));
+    }
+    async size() {
+        if (!this.table)
+            return 0;
+        return this.table.countRows();
+    }
+    async clear() {
+        if (this.table) {
+            this.table.close();
+            this.table = null;
+        }
+        // 删除旧表并重置
+        const tableNames = await this.db.tableNames();
+        if (tableNames.includes(this.tableName)) {
+            await this.db.dropTable(this.tableName);
+        }
+    }
+    async deleteByFilter(filter) {
+        if (!this.table)
+            return 0;
+        const before = await this.table.countRows();
+        if (before === 0)
+            return 0;
+        // LanceDB 的 metadata 存储在 metadata_json 字段中，需要通过全表扫描过滤
+        // 读取全部记录，过滤后重建表
+        const allRows = await this.table.query().toArray();
+        const keep = allRows.filter(row => {
+            const meta = JSON.parse(row.metadata_json);
+            // 保留条件：filter 中任一 key 不匹配则保留（即全部匹配才删除）
+            return Object.entries(filter).some(([key, value]) => meta[key] !== value);
+        });
+        const deleted = before - keep.length;
+        if (deleted > 0 && keep.length > 0) {
+            // 将 Arrow 格式行转换为纯 JS 对象，避免 schema 推断失败
+            const plainRows = keep.map(row => ({
+                vector: Array.from(row.vector),
+                metadata_json: row.metadata_json,
+            }));
+            // 重建表
+            this.table.close();
+            await this.db.dropTable(this.tableName);
+            this.table = await this.db.createTable(this.tableName, plainRows);
+        }
+        else if (deleted > 0 && keep.length === 0) {
+            await this.clear();
+        }
+        return deleted;
+    }
+    async save() {
+        // LanceDB 自动持久化，无需手动 save
+    }
+    async close() {
+        if (this.table) {
+            this.table.close();
+            this.table = null;
+        }
+    }
+}
+// ===== 插件入口 =====
+export async function apply(ctx, config) {
+    const cfg = {
+        path: config.path ?? 'data:/lancedb',
+        tableName: config.tableName ?? 'vectors',
+    };
+    const storage = createStorageGateway(ctx);
+    const dbUri = toUri(cfg.path);
+    if (!storage.resolveLocalPath) {
+        ctx.logger.error('存储实现未提供 resolveLocalPath 能力，无法初始化 LanceDB');
+        return;
+    }
+    const dbPath = await storage.resolveLocalPath(dbUri, 'write');
+    const store = new LanceDBVectorStore(dbPath, cfg.tableName, ctx.logger);
+    await store.init();
+    const count = await store.size();
+    ctx.logger.info(`LanceDB 向量数据库已加载: ${count} 条记录, URI=${dbUri}, 表=${cfg.tableName}`);
+    ctx.provide('vectorstore', store, { priority: 10 });
+    ctx.onDispose(async () => {
+        await store.close();
+    });
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AAEjE,OAAO,EAAmB,OAAO,EAA4B,MAAM,kBAAkB,CAAC;AAEtF,SAAS,KAAK,CAAC,KAAa;IAC1B,MAAM,CAAC,GAAG,MAAM,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;IACrC,IAAI,CAAC,CAAC;QAAE,OAAO,eAAe,CAAC;IAC/B,IAAI,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC;QAAE,OAAO,CAAC,CAAC;IAC/B,MAAM,OAAO,GAAG,CAAC,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;IACzC,MAAM,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACjC,OAAO,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,KAAK,OAAO,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,OAAO,EAAE,CAAC;AAC9F,CAAC;AAED,oBAAoB;AAEpB,MAAM,CAAC,MAAM,IAAI,GAAG,mCAAmC,CAAC;AACxD,MAAM,CAAC,MAAM,WAAW,GAAG,aAAa,CAAC;AACzC,MAAM,CAAC,MAAM,SAAS,GAAG,WAAW,CAAC;AACrC,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,aAAa,CAAC,CAAC;AAExC,MAAM,CAAC,MAAM,YAAY,GAAiB;IACxC,IAAI,EAAE;QACJ,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,OAAO;QACd,OAAO,EAAE,eAAe;QACxB,WAAW,EAAE,sCAAsC;KACpD;IACD,SAAS,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,OAAO,EAAE;CACrF,CAAC;AAEF,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,IAAI,EAAE,eAAe;IACrB,SAAS,EAAE,SAAS;CACrB,CAAC;AAWF,6BAA6B;AAE7B,MAAM,kBAAkB;IACd,EAAE,CAAc;IAChB,KAAK,GAAsB,IAAI,CAAC;IACvB,MAAM,CAAS;IACf,SAAS,CAAS;IAC3B,MAAM,CAAkG;IAEhH,YAAY,MAAc,EAAE,SAAiB,EAAE,MAAqC;QAClF,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED,sBAAsB;IACtB,KAAK,CAAC,IAAI;QACR,IAAI,CAAC,EAAE,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAErC,UAAU;QACV,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,EAAE,CAAC,UAAU,EAAE,CAAC;QAC9C,IAAI,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;YACxC,IAAI,CAAC,KAAK,GAAG,MAAM,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACvD,CAAC;IACH,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,MAAgB,EAAE,QAAiC;QAC3D,MAAM,MAAM,GAAG;YACb,MAAM;YACN,aAAa,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC;SACxC,CAAC;QAEF,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;YAChB,WAAW;YACX,IAAI,CAAC,KAAK,GAAG,MAAM,IAAI,CAAC,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;YACjE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,cAAc,IAAI,CAAC,SAAS,OAAO,CAAC,CAAC;QACzD,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;QACjC,CAAC;IACH,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,WAAqB,EAAE,IAAY;QAC9C,IAAI,CAAC,IAAI,CAAC,KAAK;YAAE,OAAO,EAAE,CAAC;QAE3B,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC;QAC3C,IAAI,KAAK,KAAK,CAAC;YAAE,OAAO,EAAE,CAAC;QAE3B,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,CAAC;QAE3E,OAAO,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YACzB,KAAK,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,SAAS,IAAI,CAAC,CAAC,EAAE,0BAA0B;YAC3D,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,aAAuB,CAA4B;SAC7E,CAAC,CAAC,CAAC;IACN,CAAC;IAED,KAAK,CAAC,IAAI;QACR,IAAI,CAAC,IAAI,CAAC,KAAK;YAAE,OAAO,CAAC,CAAC;QAC1B,OAAO,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC;IAChC,CAAC;IAED,KAAK,CAAC,KAAK;QACT,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;YACnB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QACpB,CAAC;QACD,UAAU;QACV,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,EAAE,CAAC,UAAU,EAAE,CAAC;QAC9C,IAAI,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;YACxC,MAAM,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC1C,CAAC;IACH,CAAC;IAED,KAAK,CAAC,cAAc,CAAC,MAA+B;QAClD,IAAI,CAAC,IAAI,CAAC,KAAK;YAAE,OAAO,CAAC,CAAC;QAC1B,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC;QAC5C,IAAI,MAAM,KAAK,CAAC;YAAE,OAAO,CAAC,CAAC;QAC3B,sDAAsD;QACtD,gBAAgB;QAChB,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE,CAAC;QACnD,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE;YAChC,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,aAAuB,CAA4B,CAAC;YAChF,uCAAuC;YACvC,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,KAAK,CAAC,CAAC;QAC5E,CAAC,CAAC,CAAC;QACH,MAAM,OAAO,GAAG,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QACrC,IAAI,OAAO,GAAG,CAAC,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACnC,uCAAuC;YACvC,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;gBACjC,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,MAA0B,CAAC;gBAClD,aAAa,EAAE,GAAG,CAAC,aAAuB;aAC3C,CAAC,CAAC,CAAC;YACJ,MAAM;YACN,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;YACnB,MAAM,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YACxC,IAAI,CAAC,KAAK,GAAG,MAAM,IAAI,CAAC,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;QACpE,CAAC;aAAM,IAAI,OAAO,GAAG,CAAC,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC5C,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC;QACrB,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,KAAK,CAAC,IAAI;QACR,0BAA0B;IAC5B,CAAC;IAED,KAAK,CAAC,KAAK;QACT,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;YACnB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QACpB,CAAC;IACH,CAAC;CACF;AAED,mBAAmB;AAEnB,MAAM,CAAC,KAAK,UAAU,KAAK,CAAC,GAAY,EAAE,MAA+B;IACvE,MAAM,GAAG,GAAkB;QACzB,IAAI,EAAG,MAAM,CAAC,IAAe,IAAI,eAAe;QAChD,SAAS,EAAG,MAAM,CAAC,SAAoB,IAAI,SAAS;KACrD,CAAC;IAEF,MAAM,OAAO,GAAG,oBAAoB,CAAC,GAAG,CAAC,CAAC;IAC1C,MAAM,KAAK,GAAG,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAC9B,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,CAAC;QAC9B,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,2CAA2C,CAAC,CAAC;QAC9D,OAAO;IACT,CAAC;IACD,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,gBAAgB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IAC9D,MAAM,KAAK,GAAG,IAAI,kBAAkB,CAAC,MAAM,EAAE,GAAG,CAAC,SAAS,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAExE,MAAM,KAAK,CAAC,IAAI,EAAE,CAAC;IAEnB,MAAM,KAAK,GAAG,MAAM,KAAK,CAAC,IAAI,EAAE,CAAC;IACjC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,qBAAqB,KAAK,aAAa,KAAK,OAAO,GAAG,CAAC,SAAS,EAAE,CAAC,CAAC;IAEpF,GAAG,CAAC,OAAO,CAAC,aAAa,EAAE,KAAK,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,CAAC;IAEpD,GAAG,CAAC,SAAS,CAAC,KAAK,IAAI,EAAE;QACvB,MAAM,KAAK,CAAC,KAAK,EAAE,CAAC;IACtB,CAAC,CAAC,CAAC;AACL,CAAC"}

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@aalis/plugin-vectorstore-lancedb",
+  "version": "0.1.0",
+  "type": "module",
+  "keywords": [
+    "aalis-plugin"
+  ],
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@lancedb/lancedb": "^0.27.1",
+    "apache-arrow": "^18.0.0",
+    "@aalis/plugin-storage-api": "^0.1.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.0.0",
+    "typescript": "^5.7.0",
+    "@aalis/core": "0.1.0",
+    "@aalis/plugin-vectorstore-api": "0.1.0"
+  },
+  "peerDependencies": {
+    "@aalis/core": "^0.1.0"
+  },
+  "aalis": {
+    "service": {
+      "provides": [
+        "vectorstore"
+      ]
+    }
+  },
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch"
+  }
+}