@dengxifeng/lancedb 0.26.2

package/dist/native.js

@@ -0,0 +1,339 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/* prettier-ignore */
+/* auto-generated by NAPI-RS */
+const { existsSync, readFileSync } = require('fs');
+const { join } = require('path');
+const { platform, arch } = process;
+let nativeBinding = null;
+let localFileExisted = false;
+let loadError = null;
+function isMusl() {
+    // For Node 10
+    if (!process.report || typeof process.report.getReport !== 'function') {
+        try {
+            const lddPath = require('child_process').execSync('which ldd').toString().trim();
+            return readFileSync(lddPath, 'utf8').includes('musl');
+        }
+        catch (e) {
+            return true;
+        }
+    }
+    else {
+        const { glibcVersionRuntime } = process.report.getReport().header;
+        return !glibcVersionRuntime;
+    }
+}
+switch (platform) {
+    case 'android':
+        switch (arch) {
+            case 'arm64':
+                localFileExisted = existsSync(join(__dirname, 'lancedb.android-arm64.node'));
+                try {
+                    if (localFileExisted) {
+                        nativeBinding = require('./lancedb.android-arm64.node');
+                    }
+                    else {
+                        nativeBinding = require('@lancedb/lancedb-android-arm64');
+                    }
+                }
+                catch (e) {
+                    loadError = e;
+                }
+                break;
+            case 'arm':
+                localFileExisted = existsSync(join(__dirname, 'lancedb.android-arm-eabi.node'));
+                try {
+                    if (localFileExisted) {
+                        nativeBinding = require('./lancedb.android-arm-eabi.node');
+                    }
+                    else {
+                        nativeBinding = require('@lancedb/lancedb-android-arm-eabi');
+                    }
+                }
+                catch (e) {
+                    loadError = e;
+                }
+                break;
+            default:
+                throw new Error(`Unsupported architecture on Android ${arch}`);
+        }
+        break;
+    case 'win32':
+        switch (arch) {
+            case 'x64':
+                localFileExisted = existsSync(join(__dirname, 'lancedb.win32-x64-msvc.node'));
+                try {
+                    if (localFileExisted) {
+                        nativeBinding = require('./lancedb.win32-x64-msvc.node');
+                    }
+                    else {
+                        nativeBinding = require('@lancedb/lancedb-win32-x64-msvc');
+                    }
+                }
+                catch (e) {
+                    loadError = e;
+                }
+                break;
+            case 'ia32':
+                localFileExisted = existsSync(join(__dirname, 'lancedb.win32-ia32-msvc.node'));
+                try {
+                    if (localFileExisted) {
+                        nativeBinding = require('./lancedb.win32-ia32-msvc.node');
+                    }
+                    else {
+                        nativeBinding = require('@lancedb/lancedb-win32-ia32-msvc');
+                    }
+                }
+                catch (e) {
+                    loadError = e;
+                }
+                break;
+            case 'arm64':
+                localFileExisted = existsSync(join(__dirname, 'lancedb.win32-arm64-msvc.node'));
+                try {
+                    if (localFileExisted) {
+                        nativeBinding = require('./lancedb.win32-arm64-msvc.node');
+                    }
+                    else {
+                        nativeBinding = require('@lancedb/lancedb-win32-arm64-msvc');
+                    }
+                }
+                catch (e) {
+                    loadError = e;
+                }
+                break;
+            default:
+                throw new Error(`Unsupported architecture on Windows: ${arch}`);
+        }
+        break;
+    case 'darwin':
+        localFileExisted = existsSync(join(__dirname, 'lancedb.darwin-universal.node'));
+        try {
+            if (localFileExisted) {
+                nativeBinding = require('./lancedb.darwin-universal.node');
+            }
+            else {
+                nativeBinding = require('@lancedb/lancedb-darwin-universal');
+            }
+            break;
+        }
+        catch { }
+        switch (arch) {
+            case 'x64':
+                localFileExisted = existsSync(join(__dirname, 'lancedb.darwin-x64.node'));
+                try {
+                    if (localFileExisted) {
+                        nativeBinding = require('./lancedb.darwin-x64.node');
+                    }
+                    else {
+                        nativeBinding = require('@lancedb/lancedb-darwin-x64');
+                    }
+                }
+                catch (e) {
+                    loadError = e;
+                }
+                break;
+            case 'arm64':
+                localFileExisted = existsSync(join(__dirname, 'lancedb.darwin-arm64.node'));
+                try {
+                    if (localFileExisted) {
+                        nativeBinding = require('./lancedb.darwin-arm64.node');
+                    }
+                    else {
+                        nativeBinding = require('@lancedb/lancedb-darwin-arm64');
+                    }
+                }
+                catch (e) {
+                    loadError = e;
+                }
+                break;
+            default:
+                throw new Error(`Unsupported architecture on macOS: ${arch}`);
+        }
+        break;
+    case 'freebsd':
+        if (arch !== 'x64') {
+            throw new Error(`Unsupported architecture on FreeBSD: ${arch}`);
+        }
+        localFileExisted = existsSync(join(__dirname, 'lancedb.freebsd-x64.node'));
+        try {
+            if (localFileExisted) {
+                nativeBinding = require('./lancedb.freebsd-x64.node');
+            }
+            else {
+                nativeBinding = require('@lancedb/lancedb-freebsd-x64');
+            }
+        }
+        catch (e) {
+            loadError = e;
+        }
+        break;
+    case 'linux':
+        switch (arch) {
+            case 'x64':
+                if (isMusl()) {
+                    localFileExisted = existsSync(join(__dirname, 'lancedb.linux-x64-musl.node'));
+                    try {
+                        if (localFileExisted) {
+                            nativeBinding = require('./lancedb.linux-x64-musl.node');
+                        }
+                        else {
+                            nativeBinding = require('@lancedb/lancedb-linux-x64-musl');
+                        }
+                    }
+                    catch (e) {
+                        loadError = e;
+                    }
+                }
+                else {
+                    localFileExisted = existsSync(join(__dirname, 'lancedb.linux-x64-gnu.node'));
+                    try {
+                        if (localFileExisted) {
+                            nativeBinding = require('./lancedb.linux-x64-gnu.node');
+                        }
+                        else {
+                            nativeBinding = require('@lancedb/lancedb-linux-x64-gnu');
+                        }
+                    }
+                    catch (e) {
+                        loadError = e;
+                    }
+                }
+                break;
+            case 'arm64':
+                if (isMusl()) {
+                    localFileExisted = existsSync(join(__dirname, 'lancedb.linux-arm64-musl.node'));
+                    try {
+                        if (localFileExisted) {
+                            nativeBinding = require('./lancedb.linux-arm64-musl.node');
+                        }
+                        else {
+                            nativeBinding = require('@lancedb/lancedb-linux-arm64-musl');
+                        }
+                    }
+                    catch (e) {
+                        loadError = e;
+                    }
+                }
+                else {
+                    localFileExisted = existsSync(join(__dirname, 'lancedb.linux-arm64-gnu.node'));
+                    try {
+                        if (localFileExisted) {
+                            nativeBinding = require('./lancedb.linux-arm64-gnu.node');
+                        }
+                        else {
+                            nativeBinding = require('@lancedb/lancedb-linux-arm64-gnu');
+                        }
+                    }
+                    catch (e) {
+                        loadError = e;
+                    }
+                }
+                break;
+            case 'arm':
+                if (isMusl()) {
+                    localFileExisted = existsSync(join(__dirname, 'lancedb.linux-arm-musleabihf.node'));
+                    try {
+                        if (localFileExisted) {
+                            nativeBinding = require('./lancedb.linux-arm-musleabihf.node');
+                        }
+                        else {
+                            nativeBinding = require('@lancedb/lancedb-linux-arm-musleabihf');
+                        }
+                    }
+                    catch (e) {
+                        loadError = e;
+                    }
+                }
+                else {
+                    localFileExisted = existsSync(join(__dirname, 'lancedb.linux-arm-gnueabihf.node'));
+                    try {
+                        if (localFileExisted) {
+                            nativeBinding = require('./lancedb.linux-arm-gnueabihf.node');
+                        }
+                        else {
+                            nativeBinding = require('@lancedb/lancedb-linux-arm-gnueabihf');
+                        }
+                    }
+                    catch (e) {
+                        loadError = e;
+                    }
+                }
+                break;
+            case 'riscv64':
+                if (isMusl()) {
+                    localFileExisted = existsSync(join(__dirname, 'lancedb.linux-riscv64-musl.node'));
+                    try {
+                        if (localFileExisted) {
+                            nativeBinding = require('./lancedb.linux-riscv64-musl.node');
+                        }
+                        else {
+                            nativeBinding = require('@lancedb/lancedb-linux-riscv64-musl');
+                        }
+                    }
+                    catch (e) {
+                        loadError = e;
+                    }
+                }
+                else {
+                    localFileExisted = existsSync(join(__dirname, 'lancedb.linux-riscv64-gnu.node'));
+                    try {
+                        if (localFileExisted) {
+                            nativeBinding = require('./lancedb.linux-riscv64-gnu.node');
+                        }
+                        else {
+                            nativeBinding = require('@lancedb/lancedb-linux-riscv64-gnu');
+                        }
+                    }
+                    catch (e) {
+                        loadError = e;
+                    }
+                }
+                break;
+            case 's390x':
+                localFileExisted = existsSync(join(__dirname, 'lancedb.linux-s390x-gnu.node'));
+                try {
+                    if (localFileExisted) {
+                        nativeBinding = require('./lancedb.linux-s390x-gnu.node');
+                    }
+                    else {
+                        nativeBinding = require('@lancedb/lancedb-linux-s390x-gnu');
+                    }
+                }
+                catch (e) {
+                    loadError = e;
+                }
+                break;
+            default:
+                throw new Error(`Unsupported architecture on Linux: ${arch}`);
+        }
+        break;
+    default:
+        throw new Error(`Unsupported OS: ${platform}, architecture: ${arch}`);
+}
+if (!nativeBinding) {
+    if (loadError) {
+        throw loadError;
+    }
+    throw new Error(`Failed to load native binding`);
+}
+const { Connection, JsHeaderProvider, Index, RecordBatchIterator, NativeMergeInsertBuilder, PermutationBuilder, permutationBuilder, Query, VectorQuery, TakeQuery, JsFullTextQuery, Reranker, RrfReranker, Session, Table, TagContents, Tags } = nativeBinding;
+module.exports.Connection = Connection;
+module.exports.JsHeaderProvider = JsHeaderProvider;
+module.exports.Index = Index;
+module.exports.RecordBatchIterator = RecordBatchIterator;
+module.exports.NativeMergeInsertBuilder = NativeMergeInsertBuilder;
+module.exports.PermutationBuilder = PermutationBuilder;
+module.exports.permutationBuilder = permutationBuilder;
+module.exports.Query = Query;
+module.exports.VectorQuery = VectorQuery;
+module.exports.TakeQuery = TakeQuery;
+module.exports.JsFullTextQuery = JsFullTextQuery;
+module.exports.Reranker = Reranker;
+module.exports.RrfReranker = RrfReranker;
+module.exports.Session = Session;
+module.exports.Table = Table;
+module.exports.TagContents = TagContents;
+module.exports.Tags = Tags;

package/dist/permutation.d.ts

@@ -0,0 +1,143 @@
+import { Connection } from "./connection.js";
+import { PermutationBuilder as NativePermutationBuilder, ShuffleOptions, SplitCalculatedOptions, SplitHashOptions, SplitRandomOptions, SplitSequentialOptions } from "./native.js";
+import { Table } from "./table";
+/**
+ * A PermutationBuilder for creating data permutations with splits, shuffling, and filtering.
+ *
+ * This class provides a TypeScript wrapper around the native Rust PermutationBuilder,
+ * offering methods to configure data splits, shuffling, and filtering before executing
+ * the permutation to create a new table.
+ */
+export declare class PermutationBuilder {
+    private inner;
+    /**
+     * @hidden
+     */
+    constructor(inner: NativePermutationBuilder);
+    /**
+     * Configure the permutation to be persisted.
+     *
+     * @param connection - The connection to persist the permutation to
+     * @param tableName - The name of the table to create
+     * @returns A new PermutationBuilder instance
+     * @example
+     * ```ts
+     * builder.persist(connection, "permutation_table");
+     * ```
+     */
+    persist(connection: Connection, tableName: string): PermutationBuilder;
+    /**
+     * Configure random splits for the permutation.
+     *
+     * @param options - Configuration for random splitting
+     * @returns A new PermutationBuilder instance
+     * @example
+     * ```ts
+     * // Split by ratios
+     * builder.splitRandom({ ratios: [0.7, 0.3], seed: 42 });
+     *
+     * // Split by counts
+     * builder.splitRandom({ counts: [1000, 500], seed: 42 });
+     *
+     * // Split with fixed size
+     * builder.splitRandom({ fixed: 100, seed: 42 });
+     * ```
+     */
+    splitRandom(options: SplitRandomOptions): PermutationBuilder;
+    /**
+     * Configure hash-based splits for the permutation.
+     *
+     * @param options - Configuration for hash-based splitting
+     * @returns A new PermutationBuilder instance
+     * @example
+     * ```ts
+     * builder.splitHash({
+     *   columns: ["user_id"],
+     *   splitWeights: [70, 30],
+     *   discardWeight: 0
+     * });
+     * ```
+     */
+    splitHash(options: SplitHashOptions): PermutationBuilder;
+    /**
+     * Configure sequential splits for the permutation.
+     *
+     * @param options - Configuration for sequential splitting
+     * @returns A new PermutationBuilder instance
+     * @example
+     * ```ts
+     * // Split by ratios
+     * builder.splitSequential({ ratios: [0.8, 0.2] });
+     *
+     * // Split by counts
+     * builder.splitSequential({ counts: [800, 200] });
+     *
+     * // Split with fixed size
+     * builder.splitSequential({ fixed: 1000 });
+     * ```
+     */
+    splitSequential(options: SplitSequentialOptions): PermutationBuilder;
+    /**
+     * Configure calculated splits for the permutation.
+     *
+     * @param options - Configuration for calculated splitting
+     * @returns A new PermutationBuilder instance
+     * @example
+     * ```ts
+     * builder.splitCalculated({ calculation: "user_id % 3" });
+     * ```
+     */
+    splitCalculated(options: SplitCalculatedOptions): PermutationBuilder;
+    /**
+     * Configure shuffling for the permutation.
+     *
+     * @param options - Configuration for shuffling
+     * @returns A new PermutationBuilder instance
+     * @example
+     * ```ts
+     * // Basic shuffle
+     * builder.shuffle({ seed: 42 });
+     *
+     * // Shuffle with clump size
+     * builder.shuffle({ seed: 42, clumpSize: 10 });
+     * ```
+     */
+    shuffle(options: ShuffleOptions): PermutationBuilder;
+    /**
+     * Configure filtering for the permutation.
+     *
+     * @param filter - SQL filter expression
+     * @returns A new PermutationBuilder instance
+     * @example
+     * ```ts
+     * builder.filter("age > 18 AND status = 'active'");
+     * ```
+     */
+    filter(filter: string): PermutationBuilder;
+    /**
+     * Execute the permutation and create the destination table.
+     *
+     * @returns A Promise that resolves to the new Table instance
+     * @example
+     * ```ts
+     * const permutationTable = await builder.execute();
+     * console.log(`Created table: ${permutationTable.name}`);
+     * ```
+     */
+    execute(): Promise<Table>;
+}
+/**
+ * Create a permutation builder for the given table.
+ *
+ * @param table - The source table to create a permutation from
+ * @returns A PermutationBuilder instance
+ * @example
+ * ```ts
+ * const builder = permutationBuilder(sourceTable, "training_data")
+ *   .splitRandom({ ratios: [0.8, 0.2], seed: 42 })
+ *   .shuffle({ seed: 123 });
+ *
+ * const trainingTable = await builder.execute();
+ * ```
+ */
+export declare function permutationBuilder(table: Table): PermutationBuilder;

package/dist/permutation.js

@@ -0,0 +1,184 @@
+"use strict";
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-FileCopyrightText: Copyright The LanceDB Authors
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PermutationBuilder = void 0;
+exports.permutationBuilder = permutationBuilder;
+const native_js_1 = require("./native.js");
+const table_1 = require("./table");
+/**
+ * A PermutationBuilder for creating data permutations with splits, shuffling, and filtering.
+ *
+ * This class provides a TypeScript wrapper around the native Rust PermutationBuilder,
+ * offering methods to configure data splits, shuffling, and filtering before executing
+ * the permutation to create a new table.
+ */
+class PermutationBuilder {
+    inner;
+    /**
+     * @hidden
+     */
+    constructor(inner) {
+        this.inner = inner;
+    }
+    /**
+     * Configure the permutation to be persisted.
+     *
+     * @param connection - The connection to persist the permutation to
+     * @param tableName - The name of the table to create
+     * @returns A new PermutationBuilder instance
+     * @example
+     * ```ts
+     * builder.persist(connection, "permutation_table");
+     * ```
+     */
+    persist(connection, tableName) {
+        const localConnection = connection;
+        const newInner = this.inner.persist(localConnection.inner, tableName);
+        return new PermutationBuilder(newInner);
+    }
+    /**
+     * Configure random splits for the permutation.
+     *
+     * @param options - Configuration for random splitting
+     * @returns A new PermutationBuilder instance
+     * @example
+     * ```ts
+     * // Split by ratios
+     * builder.splitRandom({ ratios: [0.7, 0.3], seed: 42 });
+     *
+     * // Split by counts
+     * builder.splitRandom({ counts: [1000, 500], seed: 42 });
+     *
+     * // Split with fixed size
+     * builder.splitRandom({ fixed: 100, seed: 42 });
+     * ```
+     */
+    splitRandom(options) {
+        const newInner = this.inner.splitRandom(options);
+        return new PermutationBuilder(newInner);
+    }
+    /**
+     * Configure hash-based splits for the permutation.
+     *
+     * @param options - Configuration for hash-based splitting
+     * @returns A new PermutationBuilder instance
+     * @example
+     * ```ts
+     * builder.splitHash({
+     *   columns: ["user_id"],
+     *   splitWeights: [70, 30],
+     *   discardWeight: 0
+     * });
+     * ```
+     */
+    splitHash(options) {
+        const newInner = this.inner.splitHash(options);
+        return new PermutationBuilder(newInner);
+    }
+    /**
+     * Configure sequential splits for the permutation.
+     *
+     * @param options - Configuration for sequential splitting
+     * @returns A new PermutationBuilder instance
+     * @example
+     * ```ts
+     * // Split by ratios
+     * builder.splitSequential({ ratios: [0.8, 0.2] });
+     *
+     * // Split by counts
+     * builder.splitSequential({ counts: [800, 200] });
+     *
+     * // Split with fixed size
+     * builder.splitSequential({ fixed: 1000 });
+     * ```
+     */
+    splitSequential(options) {
+        const newInner = this.inner.splitSequential(options);
+        return new PermutationBuilder(newInner);
+    }
+    /**
+     * Configure calculated splits for the permutation.
+     *
+     * @param options - Configuration for calculated splitting
+     * @returns A new PermutationBuilder instance
+     * @example
+     * ```ts
+     * builder.splitCalculated({ calculation: "user_id % 3" });
+     * ```
+     */
+    splitCalculated(options) {
+        const newInner = this.inner.splitCalculated(options);
+        return new PermutationBuilder(newInner);
+    }
+    /**
+     * Configure shuffling for the permutation.
+     *
+     * @param options - Configuration for shuffling
+     * @returns A new PermutationBuilder instance
+     * @example
+     * ```ts
+     * // Basic shuffle
+     * builder.shuffle({ seed: 42 });
+     *
+     * // Shuffle with clump size
+     * builder.shuffle({ seed: 42, clumpSize: 10 });
+     * ```
+     */
+    shuffle(options) {
+        const newInner = this.inner.shuffle(options);
+        return new PermutationBuilder(newInner);
+    }
+    /**
+     * Configure filtering for the permutation.
+     *
+     * @param filter - SQL filter expression
+     * @returns A new PermutationBuilder instance
+     * @example
+     * ```ts
+     * builder.filter("age > 18 AND status = 'active'");
+     * ```
+     */
+    filter(filter) {
+        const newInner = this.inner.filter(filter);
+        return new PermutationBuilder(newInner);
+    }
+    /**
+     * Execute the permutation and create the destination table.
+     *
+     * @returns A Promise that resolves to the new Table instance
+     * @example
+     * ```ts
+     * const permutationTable = await builder.execute();
+     * console.log(`Created table: ${permutationTable.name}`);
+     * ```
+     */
+    async execute() {
+        const nativeTable = await this.inner.execute();
+        return new table_1.LocalTable(nativeTable);
+    }
+}
+exports.PermutationBuilder = PermutationBuilder;
+/**
+ * Create a permutation builder for the given table.
+ *
+ * @param table - The source table to create a permutation from
+ * @returns A PermutationBuilder instance
+ * @example
+ * ```ts
+ * const builder = permutationBuilder(sourceTable, "training_data")
+ *   .splitRandom({ ratios: [0.8, 0.2], seed: 42 })
+ *   .shuffle({ seed: 123 });
+ *
+ * const trainingTable = await builder.execute();
+ * ```
+ */
+function permutationBuilder(table) {
+    // Extract the inner native table from the TypeScript wrapper
+    const localTable = table;
+    // Access inner through type assertion since it's private
+    const nativeBuilder = (0, native_js_1.permutationBuilder)(
+    // biome-ignore lint/suspicious/noExplicitAny: need access to private variable
+    localTable.inner);
+    return new PermutationBuilder(nativeBuilder);
+}