@lancedb/lancedb 0.11.0-beta.0 → 0.11.0

package/dist/index.d.ts

@@ -1,7 +1,6 @@
 import { Connection } from "./connection";
 import { ConnectionOptions } from "./native.js";
-import { RemoteConnectionOptions } from "./remote";
-export { WriteOptions, WriteMode, AddColumnsSql, ColumnAlteration, ConnectionOptions, IndexStatistics, IndexMetadata, IndexConfig, } from "./native.js";
+export { WriteOptions, WriteMode, AddColumnsSql, ColumnAlteration, ConnectionOptions, IndexStatistics, IndexConfig, ClientConfig, TimeoutConfig, RetryConfig, } from "./native.js";
 export { makeArrowTable, MakeArrowTableOptions, Data, VectorColumnOptions, } from "./arrow";
 export { Connection, CreateTableOptions, TableNamesOptions, } from "./connection";
 export { ExecutableQuery, Query, QueryBase, VectorQuery, RecordBatchIterator, } from "./query";
@@ -31,7 +30,7 @@ export * as embedding from "./embedding";
  * });
  * ```
  */
-export declare function connect(uri: string, opts?: Partial<ConnectionOptions | RemoteConnectionOptions>): Promise<Connection>;
+export declare function connect(uri: string, opts?: Partial<ConnectionOptions>): Promise<Connection>;
 /**
  * Connect to a LanceDB instance at the given URI.
  *
@@ -50,6 +49,6 @@ export declare function connect(uri: string, opts?: Partial<ConnectionOptions |
  * });
  * ```
  */
-export declare function connect(opts: Partial<RemoteConnectionOptions | ConnectionOptions> & {
+export declare function connect(opts: Partial<ConnectionOptions> & {
     uri: string;
 }): Promise<Connection>;

package/dist/index.js

@@ -13,11 +13,12 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.embedding = exports.Table = exports.Index = exports.RecordBatchIterator = exports.VectorQuery = exports.QueryBase = exports.Query = exports.Connection = exports.VectorColumnOptions = exports.MakeArrowTableOptions = exports.makeArrowTable = void 0;
+exports.embedding = exports.Table = exports.Index = exports.RecordBatchIterator = exports.VectorQuery = exports.QueryBase = exports.Query = exports.Connection = exports.VectorColumnOptions = exports.MakeArrowTableOptions = exports.makeArrowTable = exports.WriteMode = void 0;
 exports.connect = connect;
 const connection_1 = require("./connection");
 const native_js_1 = require("./native.js");
-const remote_1 = require("./remote");
+var native_js_2 = require("./native.js");
+Object.defineProperty(exports, "WriteMode", { enumerable: true, get: function () { return native_js_2.WriteMode; } });
 var arrow_1 = require("./arrow");
 Object.defineProperty(exports, "makeArrowTable", { enumerable: true, get: function () { return arrow_1.makeArrowTable; } });
 Object.defineProperty(exports, "MakeArrowTableOptions", { enumerable: true, get: function () { return arrow_1.MakeArrowTableOptions; } });
@@ -47,9 +48,6 @@ async function connect(uriOrOptions, opts = {}) {
     if (!uri) {
         throw new Error("uri is required");
     }
-    if (uri?.startsWith("db://")) {
-        return new remote_1.RemoteConnection(uri, opts);
-    }
     opts = opts ?? {};
     opts.storageOptions = (0, connection_1.cleanseStorageOptions)(opts.storageOptions);
     const nativeConn = await native_js_1.Connection.new(uri, opts);

package/dist/native.d.ts

@@ -3,6 +3,81 @@
 
 /* auto-generated by NAPI-RS */
 
+/** Timeout configuration for remote HTTP client. */
+export interface TimeoutConfig {
+  /**
+   * The timeout for establishing a connection in seconds. Default is 120
+   * seconds (2 minutes). This can also be set via the environment variable
+   * `LANCE_CLIENT_CONNECT_TIMEOUT`, as an integer number of seconds.
+   */
+  connectTimeout?: number
+  /**
+   * The timeout for reading data from the server in seconds. Default is 300
+   * seconds (5 minutes). This can also be set via the environment variable
+   * `LANCE_CLIENT_READ_TIMEOUT`, as an integer number of seconds.
+   */
+  readTimeout?: number
+  /**
+   * The timeout for keeping idle connections in the connection pool in seconds.
+   * Default is 300 seconds (5 minutes). This can also be set via the
+   * environment variable `LANCE_CLIENT_CONNECTION_TIMEOUT`, as an integer
+   * number of seconds.
+   */
+  poolIdleTimeout?: number
+}
+/** Retry configuration for the remote HTTP client. */
+export interface RetryConfig {
+  /**
+   * The maximum number of retries for a request. Default is 3. You can also
+   * set this via the environment variable `LANCE_CLIENT_MAX_RETRIES`.
+   */
+  retries?: number
+  /**
+   * The maximum number of retries for connection errors. Default is 3. You
+   * can also set this via the environment variable `LANCE_CLIENT_CONNECT_RETRIES`.
+   */
+  connectRetries?: number
+  /**
+   * The maximum number of retries for read errors. Default is 3. You can also
+   * set this via the environment variable `LANCE_CLIENT_READ_RETRIES`.
+   */
+  readRetries?: number
+  /**
+   * The backoff factor to apply between retries. Default is 0.25. Between each retry
+   * the client will wait for the amount of seconds:
+   * `{backoff factor} * (2 ** ({number of previous retries}))`. So for the default
+   * of 0.25, the first retry will wait 0.25 seconds, the second retry will wait 0.5
+   * seconds, the third retry will wait 1 second, etc.
+   *
+   * You can also set this via the environment variable
+   * `LANCE_CLIENT_RETRY_BACKOFF_FACTOR`.
+   */
+  backoffFactor?: number
+  /**
+   * The jitter to apply to the backoff factor, in seconds. Default is 0.25.
+   *
+   * A random value between 0 and `backoff_jitter` will be added to the backoff
+   * factor in seconds. So for the default of 0.25 seconds, between 0 and 250
+   * milliseconds will be added to the sleep between each retry.
+   *
+   * You can also set this via the environment variable
+   * `LANCE_CLIENT_RETRY_BACKOFF_JITTER`.
+   */
+  backoffJitter?: number
+  /**
+   * The HTTP status codes for which to retry the request. Default is
+   * [429, 500, 502, 503].
+   *
+   * You can also set this via the environment variable
+   * `LANCE_CLIENT_RETRY_STATUSES`. Use a comma-separated list of integers.
+   */
+  statuses?: Array<number>
+}
+export interface ClientConfig {
+  userAgent?: string
+  retryConfig?: RetryConfig
+  timeoutConfig?: TimeoutConfig
+}
 /** A description of an index currently configured on a column */
 export interface IndexConfig {
   /** The name of the index */
@@ -80,13 +155,15 @@ export interface IndexStatistics {
   /** The number of rows not indexed */
   numUnindexedRows: number
   /** The type of the index */
-  indexType?: string
-  /** The metadata for each index */
-  indices: Array<IndexMetadata>
-}
-export interface IndexMetadata {
-  metricType?: string
-  indexType?: string
+  indexType: string
+  /**
+   * The type of the distance function used by the index. This is only
+   * present for vector indices. Scalar and full text search indices do
+   * not have a distance function.
+   */
+  distanceType?: string
+  /** The number of parts this index is split into. */
+  numIndices?: number
 }
 export interface ConnectionOptions {
   /**
@@ -107,9 +184,27 @@ export interface ConnectionOptions {
    * The available options are described at https://lancedb.github.io/lancedb/guides/storage/
    */
   storageOptions?: Record<string, string>
+  /** (For LanceDB cloud only): configuration for the remote HTTP client. */
+  clientConfig?: ClientConfig
+  /**
+   * (For LanceDB cloud only): the API key to use with LanceDB Cloud.
+   *
+   * Can also be set via the environment variable `LANCEDB_API_KEY`.
+   */
+  apiKey?: string
+  /**
+   * (For LanceDB cloud only): the region to use for LanceDB cloud.
+   * Defaults to 'us-east-1'.
+   */
+  region?: string
+  /**
+   * (For LanceDB cloud only): the host to use for LanceDB cloud. Used
+   * for testing purposes.
+   */
+  hostOverride?: string
 }
 /** Write mode for writing a table. */
-export const enum WriteMode {
+export enum WriteMode {
   Create = 'Create',
   Append = 'Append',
   Overwrite = 'Overwrite'

package/package.json

@@ -10,7 +10,7 @@
     "vector database",
     "ann"
   ],
-  "version": "0.11.0-beta.0",
+  "version": "0.11.0",
   "main": "dist/index.js",
   "exports": {
     ".": "./dist/index.js",
@@ -40,6 +40,7 @@
     "@napi-rs/cli": "^2.18.3",
     "@types/axios": "^0.14.0",
     "@types/jest": "^29.1.2",
+    "@types/node": "^22.7.4",
     "@types/tmp": "^0.2.6",
     "apache-arrow-13": "npm:apache-arrow@13.0.0",
     "apache-arrow-14": "npm:apache-arrow@14.0.0",
@@ -73,8 +74,8 @@
   ],
   "scripts": {
     "artifacts": "napi artifacts",
-    "build:debug": "napi build --platform --dts ../lancedb/native.d.ts --js ../lancedb/native.js lancedb",
-    "build:release": "napi build --platform --release --dts ../lancedb/native.d.ts --js ../lancedb/native.js dist/",
+    "build:debug": "napi build --platform --no-const-enum --dts ../lancedb/native.d.ts --js ../lancedb/native.js lancedb",
+    "build:release": "napi build --platform --no-const-enum --release --dts ../lancedb/native.d.ts --js ../lancedb/native.js dist/",
     "build": "npm run build:debug && tsc -b && shx cp lancedb/native.d.ts dist/native.d.ts && shx cp lancedb/*.node dist/",
     "build-release": "npm run build:release && tsc -b && shx cp lancedb/native.d.ts dist/native.d.ts",
     "lint-ci": "biome ci .",
@@ -88,15 +89,14 @@
     "version": "napi version"
   },
   "dependencies": {
-    "axios": "^1.7.2",
     "reflect-metadata": "^0.2.2"
   },
   "optionalDependencies": {
-    "@lancedb/lancedb-darwin-arm64": "0.11.0-beta.0",
-    "@lancedb/lancedb-linux-arm64-gnu": "0.11.0-beta.0",
-    "@lancedb/lancedb-darwin-x64": "0.11.0-beta.0",
-    "@lancedb/lancedb-linux-x64-gnu": "0.11.0-beta.0",
-    "@lancedb/lancedb-win32-x64-msvc": "0.11.0-beta.0"
+    "@lancedb/lancedb-darwin-arm64": "0.11.0",
+    "@lancedb/lancedb-linux-arm64-gnu": "0.11.0",
+    "@lancedb/lancedb-darwin-x64": "0.11.0",
+    "@lancedb/lancedb-linux-x64-gnu": "0.11.0",
+    "@lancedb/lancedb-win32-x64-msvc": "0.11.0"
   },
   "peerDependencies": {
     "apache-arrow": ">=13.0.0 <=17.0.0"

package/dist/remote/client.d.ts

@@ -1,27 +0,0 @@
-import { type AxiosResponse } from "axios";
-import { Table as ArrowTable } from "../arrow";
-import { VectorQuery } from "../query";
-export declare class RestfulLanceDBClient {
-    #private;
-    constructor(dbName: string, apiKey: string, region: string, hostOverride?: string, timeout?: number);
-    get session(): import("axios").AxiosInstance;
-    get url(): string;
-    get headers(): {
-        [key: string]: string;
-    };
-    isOpen(): boolean;
-    private checkNotClosed;
-    close(): void;
-    get(uri: string, params?: Record<string, any>): Promise<any>;
-    post(uri: string, body?: any): Promise<any>;
-    post(uri: string, body: any, additional: {
-        config?: {
-            responseType: "arraybuffer";
-        };
-        headers?: Record<string, string>;
-        params?: Record<string, string>;
-    }): Promise<Buffer>;
-    listTables(limit?: number, pageToken?: string): Promise<string[]>;
-    query(tableName: string, query: VectorQuery): Promise<ArrowTable>;
-    static checkStatus(response: AxiosResponse): void;
-}

package/dist/remote/client.js

@@ -1,170 +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.RestfulLanceDBClient = void 0;
-const axios_1 = require("axios");
-const arrow_1 = require("../arrow");
-class RestfulLanceDBClient {
-    #dbName;
-    #region;
-    #apiKey;
-    #hostOverride;
-    #closed = false;
-    #timeout = 12 * 1000; // 12 seconds;
-    #session;
-    constructor(dbName, apiKey, region, hostOverride, timeout) {
-        this.#dbName = dbName;
-        this.#apiKey = apiKey;
-        this.#region = region;
-        this.#hostOverride = hostOverride ?? this.#hostOverride;
-        this.#timeout = timeout ?? this.#timeout;
-    }
-    // todo: cache the session.
-    get session() {
-        if (this.#session !== undefined) {
-            return this.#session;
-        }
-        else {
-            return axios_1.default.create({
-                baseURL: this.url,
-                headers: {
-                    // biome-ignore lint: external API
-                    Authorization: `Bearer ${this.#apiKey}`,
-                },
-                transformResponse: decodeErrorData,
-                timeout: this.#timeout,
-            });
-        }
-    }
-    get url() {
-        return (this.#hostOverride ??
-            `https://${this.#dbName}.${this.#region}.api.lancedb.com`);
-    }
-    get headers() {
-        const headers = {
-            "x-api-key": this.#apiKey,
-            "x-request-id": "na",
-        };
-        if (this.#region == "local") {
-            headers["Host"] = `${this.#dbName}.${this.#region}.api.lancedb.com`;
-        }
-        if (this.#hostOverride) {
-            headers["x-lancedb-database"] = this.#dbName;
-        }
-        return headers;
-    }
-    isOpen() {
-        return !this.#closed;
-    }
-    checkNotClosed() {
-        if (this.#closed) {
-            throw new Error("Connection is closed");
-        }
-    }
-    close() {
-        this.#session = undefined;
-        this.#closed = true;
-    }
-    // biome-ignore lint/suspicious/noExplicitAny: <explanation>
-    async get(uri, params) {
-        this.checkNotClosed();
-        uri = new URL(uri, this.url).toString();
-        let response;
-        try {
-            response = await this.session.get(uri, {
-                headers: this.headers,
-                params,
-            });
-        }
-        catch (e) {
-            if (e instanceof axios_1.AxiosError && e.response) {
-                response = e.response;
-            }
-            else {
-                throw e;
-            }
-        }
-        RestfulLanceDBClient.checkStatus(response);
-        return response.data;
-    }
-    async post(uri, 
-    // biome-ignore lint/suspicious/noExplicitAny: api request
-    body, additional) {
-        this.checkNotClosed();
-        uri = new URL(uri, this.url).toString();
-        additional = Object.assign({ config: { responseType: "json" } }, additional);
-        const headers = { ...this.headers, ...additional.headers };
-        if (!headers["Content-Type"]) {
-            headers["Content-Type"] = "application/json";
-        }
-        let response;
-        try {
-            response = await this.session.post(uri, body, {
-                headers,
-                responseType: additional.config.responseType,
-                params: new Map(Object.entries(additional.params ?? {})),
-            });
-        }
-        catch (e) {
-            if (e instanceof axios_1.AxiosError && e.response) {
-                response = e.response;
-            }
-            else {
-                throw e;
-            }
-        }
-        RestfulLanceDBClient.checkStatus(response);
-        if (additional.config.responseType === "arraybuffer") {
-            return response.data;
-        }
-        else {
-            return JSON.parse(response.data);
-        }
-    }
-    async listTables(limit = 10, pageToken = "") {
-        const json = await this.get("/v1/table", { limit, pageToken });
-        return json.tables;
-    }
-    async query(tableName, query) {
-        const tbl = await this.post(`/v1/table/${tableName}/query`, query, {
-            config: {
-                responseType: "arraybuffer",
-            },
-        });
-        return (0, arrow_1.tableFromIPC)(tbl);
-    }
-    static checkStatus(response) {
-        if (response.status === 404) {
-            throw new Error(`Not found: ${response.data}`);
-        }
-        else if (response.status >= 400 && response.status < 500) {
-            throw new Error(`Bad Request: ${response.status}, error: ${response.data}`);
-        }
-        else if (response.status >= 500 && response.status < 600) {
-            throw new Error(`Internal Server Error: ${response.status}, error: ${response.data}`);
-        }
-        else if (response.status !== 200) {
-            throw new Error(`Unknown Error: ${response.status}, error: ${response.data}`);
-        }
-    }
-}
-exports.RestfulLanceDBClient = RestfulLanceDBClient;
-function decodeErrorData(data) {
-    if (Buffer.isBuffer(data)) {
-        const decoded = data.toString("utf-8");
-        return decoded;
-    }
-    return data;
-}

package/dist/remote/connection.d.ts

@@ -1,24 +0,0 @@
-import { Data, SchemaLike } from "../arrow";
-import { Connection, CreateTableOptions, OpenTableOptions, TableNamesOptions } from "../connection";
-import { Table } from "../table";
-export interface RemoteConnectionOptions {
-    apiKey?: string;
-    region?: string;
-    hostOverride?: string;
-    timeout?: number;
-}
-export declare class RemoteConnection extends Connection {
-    #private;
-    constructor(url: string, { apiKey, region, hostOverride, timeout }: RemoteConnectionOptions);
-    isOpen(): boolean;
-    close(): void;
-    display(): string;
-    tableNames(options?: Partial<TableNamesOptions>): Promise<string[]>;
-    openTable(name: string, _options?: Partial<OpenTableOptions> | undefined): Promise<Table>;
-    createTable(nameOrOptions: string | ({
-        name: string;
-        data: Data;
-    } & Partial<CreateTableOptions>), data?: Data, options?: Partial<CreateTableOptions> | undefined): Promise<Table>;
-    createEmptyTable(name: string, schema: SchemaLike, options?: Partial<CreateTableOptions> | undefined): Promise<Table>;
-    dropTable(name: string): Promise<void>;
-}

package/dist/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(300_000);
-    constructor(url, { apiKey, region, hostOverride, timeout }) {
-        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, timeout);
-    }
-    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/dist/remote/index.d.ts

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

package/dist/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/dist/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/dist/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/native.d.ts

@@ -1,208 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-
-/* auto-generated by NAPI-RS */
-
-/** A description of an index currently configured on a column */
-export interface IndexConfig {
-  /** The name of the index */
-  name: string
-  /** The type of the index */
-  indexType: string
-  /**
-   * The columns in the index
-   *
-   * Currently this is always an array of size 1. In the future there may
-   * be more columns to represent composite indices.
-   */
-  columns: Array<string>
-}
-/** Statistics about a compaction operation. */
-export interface CompactionStats {
-  /** The number of fragments removed */
-  fragmentsRemoved: number
-  /** The number of new, compacted fragments added */
-  fragmentsAdded: number
-  /** The number of data files removed */
-  filesRemoved: number
-  /** The number of new, compacted data files added */
-  filesAdded: number
-}
-/** Statistics about a cleanup operation */
-export interface RemovalStats {
-  /** The number of bytes removed */
-  bytesRemoved: number
-  /** The number of old versions removed */
-  oldVersionsRemoved: number
-}
-/** Statistics about an optimize operation */
-export interface OptimizeStats {
-  /** Statistics about the compaction operation */
-  compaction: CompactionStats
-  /** Statistics about the removal operation */
-  prune: RemovalStats
-}
-/**
- *  A definition of a column alteration. The alteration changes the column at
- * `path` to have the new name `name`, to be nullable if `nullable` is true,
- * and to have the data type `data_type`. At least one of `rename` or `nullable`
- * must be provided.
- */
-export interface ColumnAlteration {
-  /**
-   * The path to the column to alter. This is a dot-separated path to the column.
-   * If it is a top-level column then it is just the name of the column. If it is
-   * a nested column then it is the path to the column, e.g. "a.b.c" for a column
-   * `c` nested inside a column `b` nested inside a column `a`.
-   */
-  path: string
-  /**
-   * The new name of the column. If not provided then the name will not be changed.
-   * This must be distinct from the names of all other columns in the table.
-   */
-  rename?: string
-  /** Set the new nullability. Note that a nullable column cannot be made non-nullable. */
-  nullable?: boolean
-}
-/** A definition of a new column to add to a table. */
-export interface AddColumnsSql {
-  /** The name of the new column. */
-  name: string
-  /**
-   * The values to populate the new column with, as a SQL expression.
-   * The expression can reference other columns in the table.
-   */
-  valueSql: string
-}
-export interface IndexStatistics {
-  /** The number of rows indexed by the index */
-  numIndexedRows: number
-  /** The number of rows not indexed */
-  numUnindexedRows: number
-  /** The type of the index */
-  indexType?: string
-  /** The metadata for each index */
-  indices: Array<IndexMetadata>
-}
-export interface IndexMetadata {
-  metricType?: string
-  indexType?: string
-}
-export interface ConnectionOptions {
-  /**
-   * (For LanceDB OSS only): The interval, in seconds, at which to check for
-   * updates to the table from other processes. If None, then consistency is not
-   * checked. For performance reasons, this is the default. For strong
-   * consistency, set this to zero seconds. Then every read will check for
-   * updates from other processes. As a compromise, you can set this to a
-   * non-zero value for eventual consistency. If more than that interval
-   * has passed since the last check, then the table will be checked for updates.
-   * Note: this consistency only applies to read operations. Write operations are
-   * always consistent.
-   */
-  readConsistencyInterval?: number
-  /**
-   * (For LanceDB OSS only): configuration for object storage.
-   *
-   * The available options are described at https://lancedb.github.io/lancedb/guides/storage/
-   */
-  storageOptions?: Record<string, string>
-}
-/** Write mode for writing a table. */
-export const enum WriteMode {
-  Create = 'Create',
-  Append = 'Append',
-  Overwrite = 'Overwrite'
-}
-/** Write options when creating a Table. */
-export interface WriteOptions {
-  /** Write mode for writing to a table. */
-  mode?: WriteMode
-}
-export interface OpenTableOptions {
-  storageOptions?: Record<string, string>
-}
-export class Connection {
-  /** Create a new Connection instance from the given URI. */
-  static new(uri: string, options: ConnectionOptions): Promise<Connection>
-  display(): string
-  isOpen(): boolean
-  close(): void
-  /** List all tables in the dataset. */
-  tableNames(startAfter?: string | undefined | null, limit?: number | undefined | null): Promise<Array<string>>
-  /**
-   * Create table from a Apache Arrow IPC (file) buffer.
-   *
-   * Parameters:
-   * - name: The name of the table.
-   * - buf: The buffer containing the IPC file.
-   *
-   */
-  createTable(name: string, buf: Buffer, mode: string, storageOptions?: Record<string, string> | undefined | null, useLegacyFormat?: boolean | undefined | null): Promise<Table>
-  createEmptyTable(name: string, schemaBuf: Buffer, mode: string, storageOptions?: Record<string, string> | undefined | null, useLegacyFormat?: boolean | undefined | null): Promise<Table>
-  openTable(name: string, storageOptions?: Record<string, string> | undefined | null, indexCacheSize?: number | undefined | null): Promise<Table>
-  /** Drop table with the name. Or raise an error if the table does not exist. */
-  dropTable(name: string): Promise<void>
-}
-export class Index {
-  static ivfPq(distanceType?: string | undefined | null, numPartitions?: number | undefined | null, numSubVectors?: number | undefined | null, maxIterations?: number | undefined | null, sampleRate?: number | undefined | null): Index
-  static btree(): Index
-}
-/** Typescript-style Async Iterator over RecordBatches  */
-export class RecordBatchIterator {
-  next(): Promise<Buffer | null>
-}
-/** A builder used to create and run a merge insert operation */
-export class NativeMergeInsertBuilder {
-  whenMatchedUpdateAll(condition?: string | undefined | null): NativeMergeInsertBuilder
-  whenNotMatchedInsertAll(): NativeMergeInsertBuilder
-  whenNotMatchedBySourceDelete(filter?: string | undefined | null): NativeMergeInsertBuilder
-  execute(buf: Buffer): Promise<void>
-}
-export class Query {
-  onlyIf(predicate: string): void
-  select(columns: Array<[string, string]>): void
-  limit(limit: number): void
-  nearestTo(vector: Float32Array): VectorQuery
-  execute(maxBatchLength?: number | undefined | null): Promise<RecordBatchIterator>
-  explainPlan(verbose: boolean): Promise<string>
-}
-export class VectorQuery {
-  column(column: string): void
-  distanceType(distanceType: string): void
-  postfilter(): void
-  refineFactor(refineFactor: number): void
-  nprobes(nprobe: number): void
-  bypassVectorIndex(): void
-  onlyIf(predicate: string): void
-  select(columns: Array<[string, string]>): void
-  limit(limit: number): void
-  execute(maxBatchLength?: number | undefined | null): Promise<RecordBatchIterator>
-  explainPlan(verbose: boolean): Promise<string>
-}
-export class Table {
-  name: string
-  display(): string
-  isOpen(): boolean
-  close(): void
-  /** Return Schema as empty Arrow IPC file. */
-  schema(): Promise<Buffer>
-  add(buf: Buffer, mode: string): Promise<void>
-  countRows(filter?: string | undefined | null): Promise<number>
-  delete(predicate: string): Promise<void>
-  createIndex(index: Index | undefined | null, column: string, replace?: boolean | undefined | null): Promise<void>
-  update(onlyIf: string | undefined | null, columns: Array<[string, string]>): Promise<void>
-  query(): Query
-  vectorSearch(vector: Float32Array): VectorQuery
-  addColumns(transforms: Array<AddColumnsSql>): Promise<void>
-  alterColumns(alterations: Array<ColumnAlteration>): Promise<void>
-  dropColumns(columns: Array<string>): Promise<void>
-  version(): Promise<number>
-  checkout(version: number): Promise<void>
-  checkoutLatest(): Promise<void>
-  restore(): Promise<void>
-  optimize(olderThanMs?: number | undefined | null): Promise<OptimizeStats>
-  listIndices(): Promise<Array<IndexConfig>>
-  indexStats(indexName: string): Promise<IndexStatistics | null>
-  mergeInsert(on: Array<string>): NativeMergeInsertBuilder
-}