@lancedb/lancedb 0.7.0 → 0.8.0

package/nodejs-artifacts/remote/connection.js

@@ -1,110 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RemoteConnection = void 0;
-const arrow_1 = require("../arrow");
-const connection_1 = require("../connection");
-const table_1 = require("../table");
-const util_1 = require("../util");
-const client_1 = require("./client");
-const table_2 = require("./table");
-class RemoteConnection extends connection_1.Connection {
-    #dbName;
-    #apiKey;
-    #region;
-    #client;
-    #tableCache = new util_1.TTLCache(300000);
-    constructor(url, { apiKey, region, hostOverride, connectionTimeout, readTimeout, }) {
-        super();
-        apiKey = apiKey ?? process.env.LANCEDB_API_KEY;
-        region = region ?? process.env.LANCEDB_REGION;
-        if (!apiKey) {
-            throw new Error("apiKey is required when connecting to LanceDB Cloud");
-        }
-        if (!region) {
-            throw new Error("region is required when connecting to LanceDB Cloud");
-        }
-        const parsed = new URL(url);
-        if (parsed.protocol !== "db:") {
-            throw new Error(`invalid protocol: ${parsed.protocol}, only accepts db://`);
-        }
-        this.#dbName = parsed.hostname;
-        this.#apiKey = apiKey;
-        this.#region = region;
-        this.#client = new client_1.RestfulLanceDBClient(this.#dbName, this.#apiKey, this.#region, hostOverride, connectionTimeout, readTimeout);
-    }
-    isOpen() {
-        return this.#client.isOpen();
-    }
-    close() {
-        return this.#client.close();
-    }
-    display() {
-        return `RemoteConnection(${this.#dbName})`;
-    }
-    async tableNames(options) {
-        const response = await this.#client.get("/v1/table/", {
-            limit: options?.limit ?? 10,
-            // biome-ignore lint/style/useNamingConvention: <explanation>
-            page_token: options?.startAfter ?? "",
-        });
-        const body = await response.body();
-        for (const table of body.tables) {
-            this.#tableCache.set(table, true);
-        }
-        return body.tables;
-    }
-    async openTable(name, _options) {
-        if (this.#tableCache.get(name) === undefined) {
-            await this.#client.post(`/v1/table/${encodeURIComponent(name)}/describe/`);
-            this.#tableCache.set(name, true);
-        }
-        return new table_2.RemoteTable(this.#client, name, this.#dbName);
-    }
-    async createTable(nameOrOptions, data, options) {
-        if (typeof nameOrOptions !== "string" && "name" in nameOrOptions) {
-            const { name, data, ...options } = nameOrOptions;
-            return this.createTable(name, data, options);
-        }
-        if (data === undefined) {
-            throw new Error("data is required");
-        }
-        if (options?.mode) {
-            console.warn("option 'mode' is not supported in LanceDB Cloud", "LanceDB Cloud only supports the default 'create' mode.", "If the table already exists, an error will be thrown.");
-        }
-        if (options?.embeddingFunction) {
-            console.warn("embedding_functions is not yet supported on LanceDB Cloud.", "Please vote https://github.com/lancedb/lancedb/issues/626 ", "for this feature.");
-        }
-        const { buf } = await table_1.Table.parseTableData(data, options, true /** streaming */);
-        await this.#client.post(`/v1/table/${encodeURIComponent(nameOrOptions)}/create/`, buf, {
-            config: {
-                responseType: "arraybuffer",
-            },
-            headers: { "Content-Type": "application/vnd.apache.arrow.stream" },
-        });
-        this.#tableCache.set(nameOrOptions, true);
-        return new table_2.RemoteTable(this.#client, nameOrOptions, this.#dbName);
-    }
-    async createEmptyTable(name, schema, options) {
-        if (options?.mode) {
-            console.warn(`mode is not supported on LanceDB Cloud`);
-        }
-        if (options?.embeddingFunction) {
-            console.warn("embeddingFunction is not yet supported on LanceDB Cloud.", "Please vote https://github.com/lancedb/lancedb/issues/626 ", "for this feature.");
-        }
-        const emptyTable = (0, arrow_1.makeEmptyTable)(schema);
-        const buf = await (0, arrow_1.fromTableToStreamBuffer)(emptyTable);
-        await this.#client.post(`/v1/table/${encodeURIComponent(name)}/create/`, buf, {
-            config: {
-                responseType: "arraybuffer",
-            },
-            headers: { "Content-Type": "application/vnd.apache.arrow.stream" },
-        });
-        this.#tableCache.set(name, true);
-        return new table_2.RemoteTable(this.#client, name, this.#dbName);
-    }
-    async dropTable(name) {
-        await this.#client.post(`/v1/table/${encodeURIComponent(name)}/drop/`);
-        this.#tableCache.delete(name);
-    }
-}
-exports.RemoteConnection = RemoteConnection;

package/nodejs-artifacts/remote/index.d.ts

@@ -1,3 +0,0 @@
-export { RestfulLanceDBClient } from "./client";
-export { type RemoteConnectionOptions, RemoteConnection } from "./connection";
-export { RemoteTable } from "./table";

package/nodejs-artifacts/remote/index.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RemoteTable = exports.RemoteConnection = exports.RestfulLanceDBClient = void 0;
-var client_1 = require("./client");
-Object.defineProperty(exports, "RestfulLanceDBClient", { enumerable: true, get: function () { return client_1.RestfulLanceDBClient; } });
-var connection_1 = require("./connection");
-Object.defineProperty(exports, "RemoteConnection", { enumerable: true, get: function () { return connection_1.RemoteConnection; } });
-var table_1 = require("./table");
-Object.defineProperty(exports, "RemoteTable", { enumerable: true, get: function () { return table_1.RemoteTable; } });

package/nodejs-artifacts/remote/table.d.ts

@@ -1,42 +0,0 @@
-import { Table as ArrowTable } from "apache-arrow";
-import { Data, IntoVector } from "../arrow";
-import { IndexStatistics } from "..";
-import { IndexOptions } from "../indices";
-import { MergeInsertBuilder } from "../merge";
-import { VectorQuery } from "../query";
-import { AddDataOptions, Table, UpdateOptions } from "../table";
-import { IntoSql } from "../util";
-import { RestfulLanceDBClient } from "./client";
-export declare class RemoteTable extends Table {
-    #private;
-    get name(): string;
-    constructor(client: RestfulLanceDBClient, tableName: string, dbName: string);
-    isOpen(): boolean;
-    close(): void;
-    display(): string;
-    schema(): Promise<import("apache-arrow").Schema>;
-    add(data: Data, options?: Partial<AddDataOptions>): Promise<void>;
-    update(optsOrUpdates: (Map<string, string> | Record<string, string>) | ({
-        values: Map<string, IntoSql> | Record<string, IntoSql>;
-    } & Partial<UpdateOptions>) | ({
-        valuesSql: Map<string, string> | Record<string, string>;
-    } & Partial<UpdateOptions>), options?: Partial<UpdateOptions>): Promise<void>;
-    countRows(filter?: unknown): Promise<number>;
-    delete(predicate: unknown): Promise<void>;
-    createIndex(column: string, options?: Partial<IndexOptions>): Promise<void>;
-    query(): import("..").Query;
-    search(_query: string | IntoVector): VectorQuery;
-    vectorSearch(_vector: unknown): import("..").VectorQuery;
-    addColumns(_newColumnTransforms: unknown): Promise<void>;
-    alterColumns(_columnAlterations: unknown): Promise<void>;
-    dropColumns(_columnNames: unknown): Promise<void>;
-    version(): Promise<number>;
-    checkout(_version: unknown): Promise<void>;
-    checkoutLatest(): Promise<void>;
-    restore(): Promise<void>;
-    optimize(_options?: unknown): Promise<import("../native").OptimizeStats>;
-    listIndices(): Promise<import("../native").IndexConfig[]>;
-    toArrow(): Promise<ArrowTable>;
-    mergeInsert(_on: string | string[]): MergeInsertBuilder;
-    indexStats(_name: string): Promise<IndexStatistics | undefined>;
-}

package/nodejs-artifacts/remote/table.js

@@ -1,179 +0,0 @@
-"use strict";
-// Copyright 2023 LanceDB Developers.
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//     http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RemoteTable = void 0;
-const table_1 = require("../table");
-const util_1 = require("../util");
-class RemoteTable extends table_1.Table {
-    #client;
-    #name;
-    // Used in the display() method
-    #dbName;
-    get #tablePrefix() {
-        return `/v1/table/${encodeURIComponent(this.#name)}/`;
-    }
-    get name() {
-        return this.#name;
-    }
-    constructor(client, tableName, dbName) {
-        super();
-        this.#client = client;
-        this.#name = tableName;
-        this.#dbName = dbName;
-    }
-    isOpen() {
-        return !this.#client.isOpen();
-    }
-    close() {
-        this.#client.close();
-    }
-    display() {
-        return `RemoteTable(${this.#dbName}; ${this.#name})`;
-    }
-    async schema() {
-        const resp = await this.#client.post(`${this.#tablePrefix}/describe/`);
-        // TODO: parse this into a valid arrow schema
-        return resp.schema;
-    }
-    async add(data, options) {
-        const { buf, mode } = await table_1.Table.parseTableData(data, options, true);
-        await this.#client.post(`${this.#tablePrefix}/insert/`, buf, {
-            params: {
-                mode,
-            },
-            headers: {
-                "Content-Type": "application/vnd.apache.arrow.stream",
-            },
-        });
-    }
-    async update(optsOrUpdates, options) {
-        const isValues = "values" in optsOrUpdates && typeof optsOrUpdates.values !== "string";
-        const isValuesSql = "valuesSql" in optsOrUpdates &&
-            typeof optsOrUpdates.valuesSql !== "string";
-        const isMap = (obj) => {
-            return obj instanceof Map;
-        };
-        let predicate;
-        let columns;
-        switch (true) {
-            case isMap(optsOrUpdates):
-                columns = Array.from(optsOrUpdates.entries());
-                predicate = options?.where;
-                break;
-            case isValues && isMap(optsOrUpdates.values):
-                columns = Array.from(optsOrUpdates.values.entries()).map(([k, v]) => [
-                    k,
-                    (0, util_1.toSQL)(v),
-                ]);
-                predicate = optsOrUpdates.where;
-                break;
-            case isValues && !isMap(optsOrUpdates.values):
-                columns = Object.entries(optsOrUpdates.values).map(([k, v]) => [
-                    k,
-                    (0, util_1.toSQL)(v),
-                ]);
-                predicate = optsOrUpdates.where;
-                break;
-            case isValuesSql && isMap(optsOrUpdates.valuesSql):
-                columns = Array.from(optsOrUpdates.valuesSql.entries());
-                predicate = optsOrUpdates.where;
-                break;
-            case isValuesSql && !isMap(optsOrUpdates.valuesSql):
-                columns = Object.entries(optsOrUpdates.valuesSql).map(([k, v]) => [
-                    k,
-                    v,
-                ]);
-                predicate = optsOrUpdates.where;
-                break;
-            default:
-                columns = Object.entries(optsOrUpdates);
-                predicate = options?.where;
-        }
-        await this.#client.post(`${this.#tablePrefix}/update/`, {
-            predicate: predicate ?? null,
-            updates: columns,
-        });
-    }
-    async countRows(filter) {
-        const payload = { predicate: filter };
-        return await this.#client.post(`${this.#tablePrefix}/count_rows/`, payload);
-    }
-    async delete(predicate) {
-        const payload = { predicate };
-        await this.#client.post(`${this.#tablePrefix}/delete/`, payload);
-    }
-    async createIndex(column, options) {
-        if (options !== undefined) {
-            console.warn("options are not yet supported on the LanceDB cloud");
-        }
-        const indexType = "vector";
-        const metric = "L2";
-        const data = {
-            column,
-            // biome-ignore lint/style/useNamingConvention: external API
-            index_type: indexType,
-            // biome-ignore lint/style/useNamingConvention: external API
-            metric_type: metric,
-        };
-        await this.#client.post(`${this.#tablePrefix}/create_index`, data);
-    }
-    query() {
-        throw new Error("query() is not yet supported on the LanceDB cloud");
-    }
-    search(_query) {
-        throw new Error("search() is not yet supported on the LanceDB cloud");
-    }
-    vectorSearch(_vector) {
-        throw new Error("vectorSearch() is not yet supported on the LanceDB cloud");
-    }
-    addColumns(_newColumnTransforms) {
-        throw new Error("addColumns() is not yet supported on the LanceDB cloud");
-    }
-    alterColumns(_columnAlterations) {
-        throw new Error("alterColumns() is not yet supported on the LanceDB cloud");
-    }
-    dropColumns(_columnNames) {
-        throw new Error("dropColumns() is not yet supported on the LanceDB cloud");
-    }
-    async version() {
-        const resp = await this.#client.post(`${this.#tablePrefix}/describe/`);
-        return resp.version;
-    }
-    checkout(_version) {
-        throw new Error("checkout() is not yet supported on the LanceDB cloud");
-    }
-    checkoutLatest() {
-        throw new Error("checkoutLatest() is not yet supported on the LanceDB cloud");
-    }
-    restore() {
-        throw new Error("restore() is not yet supported on the LanceDB cloud");
-    }
-    optimize(_options) {
-        throw new Error("optimize() is not yet supported on the LanceDB cloud");
-    }
-    async listIndices() {
-        return await this.#client.post(`${this.#tablePrefix}/index/list/`);
-    }
-    toArrow() {
-        throw new Error("toArrow() is not yet supported on the LanceDB cloud");
-    }
-    mergeInsert(_on) {
-        throw new Error("mergeInsert() is not yet supported on the LanceDB cloud");
-    }
-    async indexStats(_name) {
-        throw new Error("indexStats() is not yet supported on the LanceDB cloud");
-    }
-}
-exports.RemoteTable = RemoteTable;

package/nodejs-artifacts/sanitize.d.ts

@@ -1,31 +0,0 @@
-import type { TKeys } from "apache-arrow/type";
-import { DataType, Date_, Decimal, DenseUnion, Dictionary, Duration, Field, FixedSizeBinary, FixedSizeList, Float, Int, Interval, List, Map_, Schema, SchemaLike, SparseUnion, Struct, Table, TableLike, Time, Timestamp, TimestampMicrosecond, TimestampMillisecond, TimestampNanosecond, TimestampSecond, Type, Union } from "./arrow";
-export declare function sanitizeMetadata(metadataLike?: unknown): Map<string, string> | undefined;
-export declare function sanitizeInt(typeLike: object): Int<Type.Int | Type.Int8 | Type.Int16 | Type.Int32 | Type.Int64 | Type.Uint8 | Type.Uint16 | Type.Uint32 | Type.Uint64>;
-export declare function sanitizeFloat(typeLike: object): Float<Type.Float | Type.Float16 | Type.Float32 | Type.Float64>;
-export declare function sanitizeDecimal(typeLike: object): Decimal;
-export declare function sanitizeDate(typeLike: object): Date_<import("apache-arrow/type").Dates>;
-export declare function sanitizeTime(typeLike: object): Time<Type.Time | Type.TimeSecond | Type.TimeMillisecond | Type.TimeMicrosecond | Type.TimeNanosecond>;
-export declare function sanitizeTimestamp(typeLike: object): Timestamp<Type.Timestamp | Type.TimestampSecond | Type.TimestampMillisecond | Type.TimestampMicrosecond | Type.TimestampNanosecond>;
-export declare function sanitizeTypedTimestamp(typeLike: object, Datatype: typeof TimestampNanosecond | typeof TimestampMicrosecond | typeof TimestampMillisecond | typeof TimestampSecond): TimestampSecond | TimestampMillisecond | TimestampMicrosecond | TimestampNanosecond;
-export declare function sanitizeInterval(typeLike: object): Interval<Type.Interval | Type.IntervalDayTime | Type.IntervalYearMonth>;
-export declare function sanitizeList(typeLike: object): List<any>;
-export declare function sanitizeStruct(typeLike: object): Struct<any>;
-export declare function sanitizeUnion(typeLike: object): Union<Type.Union | Type.DenseUnion | Type.SparseUnion>;
-export declare function sanitizeTypedUnion(typeLike: object, UnionType: typeof DenseUnion | typeof SparseUnion): SparseUnion | DenseUnion;
-export declare function sanitizeFixedSizeBinary(typeLike: object): FixedSizeBinary;
-export declare function sanitizeFixedSizeList(typeLike: object): FixedSizeList<any>;
-export declare function sanitizeMap(typeLike: object): Map_<any, any>;
-export declare function sanitizeDuration(typeLike: object): Duration<Type.Duration | Type.DurationSecond | Type.DurationMillisecond | Type.DurationMicrosecond | Type.DurationNanosecond>;
-export declare function sanitizeDictionary(typeLike: object): Dictionary<DataType<any, any>, TKeys>;
-export declare function sanitizeType(typeLike: unknown): DataType<any>;
-export declare function sanitizeField(fieldLike: unknown): Field;
-/**
- * Convert something schemaLike into a Schema instance
- *
- * This method is often needed even when the caller is using a Schema
- * instance because they might be using a different instance of apache-arrow
- * than lancedb is using.
- */
-export declare function sanitizeSchema(schemaLike: SchemaLike): Schema;
-export declare function sanitizeTable(tableLike: TableLike): Table;