@lancedb/lancedb 0.15.1-beta.2 → 0.15.1-beta.3

package/README.md

@@ -32,7 +32,7 @@ const results = await table.vectorSearch([0.1, 0.3]).limit(20).toArray();
 console.log(results);
 ```
 
-The [quickstart](../basic.md) contains a more complete example.
+The [quickstart](https://lancedb.github.io/lancedb/basic/) contains a more complete example.
 
 ## Development
 

package/dist/arrow.d.ts

@@ -112,6 +112,7 @@ export declare class MakeArrowTableOptions {
  *  - Record<String, any> => Struct
  *  - Array<any> => List
  * @example
+ * ```ts
  * import { fromTableToBuffer, makeArrowTable } from "../arrow";
  * import { Field, FixedSizeList, Float16, Float32, Int32, Schema } from "apache-arrow";
  *
@@ -133,43 +134,41 @@ export declare class MakeArrowTableOptions {
  * names and data types.
  *
  * ```ts
- *
  * const schema = new Schema([
-    new Field("a", new Float64()),
-    new Field("b", new Float64()),
-    new Field(
-      "vector",
-      new FixedSizeList(3, new Field("item", new Float32()))
-    ),
-  ]);
-  const table = makeArrowTable([
-    { a: 1, b: 2, vector: [1, 2, 3] },
-    { a: 4, b: 5, vector: [4, 5, 6] },
-    { a: 7, b: 8, vector: [7, 8, 9] },
-  ]);
-  assert.deepEqual(table.schema, schema);
+ *   new Field("a", new Float64()),
+ *   new Field("b", new Float64()),
+ *   new Field(
+ *     "vector",
+ *     new FixedSizeList(3, new Field("item", new Float32()))
+ *   ),
+ * ]);
+ * const table = makeArrowTable([
+ *   { a: 1, b: 2, vector: [1, 2, 3] },
+ *   { a: 4, b: 5, vector: [4, 5, 6] },
+ *   { a: 7, b: 8, vector: [7, 8, 9] },
+ * ]);
+ * assert.deepEqual(table.schema, schema);
  * ```
  *
  * You can specify the vector column types and names using the options as well
  *
- * ```typescript
- *
+ * ```ts
  * const schema = new Schema([
-    new Field('a', new Float64()),
-    new Field('b', new Float64()),
-    new Field('vec1', new FixedSizeList(3, new Field('item', new Float16()))),
-    new Field('vec2', new FixedSizeList(3, new Field('item', new Float16())))
-  ]);
+ *   new Field('a', new Float64()),
+ *   new Field('b', new Float64()),
+ *   new Field('vec1', new FixedSizeList(3, new Field('item', new Float16()))),
+ *   new Field('vec2', new FixedSizeList(3, new Field('item', new Float16())))
+ * ]);
  * const table = makeArrowTable([
-    { a: 1, b: 2, vec1: [1, 2, 3], vec2: [2, 4, 6] },
-    { a: 4, b: 5, vec1: [4, 5, 6], vec2: [8, 10, 12] },
-    { a: 7, b: 8, vec1: [7, 8, 9], vec2: [14, 16, 18] }
-  ], {
-    vectorColumns: {
-      vec1: { type: new Float16() },
-      vec2: { type: new Float16() }
-    }
-  }
+ *   { a: 1, b: 2, vec1: [1, 2, 3], vec2: [2, 4, 6] },
+ *   { a: 4, b: 5, vec1: [4, 5, 6], vec2: [8, 10, 12] },
+ *   { a: 7, b: 8, vec1: [7, 8, 9], vec2: [14, 16, 18] }
+ * ], {
+ *   vectorColumns: {
+ *     vec1: { type: new Float16() },
+ *     vec2: { type: new Float16() }
+ *   }
+ * }
  * assert.deepEqual(table.schema, schema)
  * ```
  */

package/dist/arrow.js

@@ -207,6 +207,7 @@ exports.MakeArrowTableOptions = MakeArrowTableOptions;
  *  - Record<String, any> => Struct
  *  - Array<any> => List
  * @example
+ * ```ts
  * import { fromTableToBuffer, makeArrowTable } from "../arrow";
  * import { Field, FixedSizeList, Float16, Float32, Int32, Schema } from "apache-arrow";
  *
@@ -228,43 +229,41 @@ exports.MakeArrowTableOptions = MakeArrowTableOptions;
  * names and data types.
  *
  * ```ts
- *
  * const schema = new Schema([
-    new Field("a", new Float64()),
-    new Field("b", new Float64()),
-    new Field(
-      "vector",
-      new FixedSizeList(3, new Field("item", new Float32()))
-    ),
-  ]);
-  const table = makeArrowTable([
-    { a: 1, b: 2, vector: [1, 2, 3] },
-    { a: 4, b: 5, vector: [4, 5, 6] },
-    { a: 7, b: 8, vector: [7, 8, 9] },
-  ]);
-  assert.deepEqual(table.schema, schema);
+ *   new Field("a", new Float64()),
+ *   new Field("b", new Float64()),
+ *   new Field(
+ *     "vector",
+ *     new FixedSizeList(3, new Field("item", new Float32()))
+ *   ),
+ * ]);
+ * const table = makeArrowTable([
+ *   { a: 1, b: 2, vector: [1, 2, 3] },
+ *   { a: 4, b: 5, vector: [4, 5, 6] },
+ *   { a: 7, b: 8, vector: [7, 8, 9] },
+ * ]);
+ * assert.deepEqual(table.schema, schema);
  * ```
  *
  * You can specify the vector column types and names using the options as well
  *
- * ```typescript
- *
+ * ```ts
  * const schema = new Schema([
-    new Field('a', new Float64()),
-    new Field('b', new Float64()),
-    new Field('vec1', new FixedSizeList(3, new Field('item', new Float16()))),
-    new Field('vec2', new FixedSizeList(3, new Field('item', new Float16())))
-  ]);
+ *   new Field('a', new Float64()),
+ *   new Field('b', new Float64()),
+ *   new Field('vec1', new FixedSizeList(3, new Field('item', new Float16()))),
+ *   new Field('vec2', new FixedSizeList(3, new Field('item', new Float16())))
+ * ]);
  * const table = makeArrowTable([
-    { a: 1, b: 2, vec1: [1, 2, 3], vec2: [2, 4, 6] },
-    { a: 4, b: 5, vec1: [4, 5, 6], vec2: [8, 10, 12] },
-    { a: 7, b: 8, vec1: [7, 8, 9], vec2: [14, 16, 18] }
-  ], {
-    vectorColumns: {
-      vec1: { type: new Float16() },
-      vec2: { type: new Float16() }
-    }
-  }
+ *   { a: 1, b: 2, vec1: [1, 2, 3], vec2: [2, 4, 6] },
+ *   { a: 4, b: 5, vec1: [4, 5, 6], vec2: [8, 10, 12] },
+ *   { a: 7, b: 8, vec1: [7, 8, 9], vec2: [14, 16, 18] }
+ * ], {
+ *   vectorColumns: {
+ *     vec1: { type: new Float16() },
+ *     vec2: { type: new Float16() }
+ *   }
+ * }
  * assert.deepEqual(table.schema, schema)
  * ```
  */

package/dist/connection.d.ts

@@ -105,6 +105,7 @@ export interface TableNamesOptions {
  *
  * Any created tables are independent and will continue to work even if
  * the underlying connection has been closed.
+ * @hideconstructor
  */
 export declare abstract class Connection {
     /**
@@ -167,8 +168,10 @@ export declare abstract class Connection {
      */
     abstract dropTable(name: string): Promise<void>;
 }
+/** @hideconstructor */
 export declare class LocalConnection extends Connection {
     readonly inner: LanceDbConnection;
+    /** @hidden */
     constructor(inner: LanceDbConnection);
     isOpen(): boolean;
     close(): void;

package/dist/connection.js

@@ -5,7 +5,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.LocalConnection = exports.Connection = void 0;
 exports.cleanseStorageOptions = cleanseStorageOptions;
 const arrow_1 = require("./arrow");
+const arrow_2 = require("./arrow");
 const registry_1 = require("./embedding/registry");
+const sanitize_1 = require("./sanitize");
 const table_1 = require("./table");
 /**
  * A LanceDB Connection that allows you to open tables and create new ones.
@@ -24,6 +26,7 @@ const table_1 = require("./table");
  *
  * Any created tables are independent and will continue to work even if
  * the underlying connection has been closed.
+ * @hideconstructor
  */
 class Connection {
     [Symbol.for("nodejs.util.inspect.custom")]() {
@@ -31,8 +34,10 @@ class Connection {
     }
 }
 exports.Connection = Connection;
+/** @hideconstructor */
 class LocalConnection extends Connection {
     inner;
+    /** @hidden */
     constructor(inner) {
         super();
         this.inner = inner;
@@ -61,7 +66,7 @@ class LocalConnection extends Connection {
         if (data === undefined) {
             throw new Error("data is required");
         }
-        const { buf, mode } = await table_1.Table.parseTableData(data, options);
+        const { buf, mode } = await parseTableData(data, options);
         let dataStorageVersion = "stable";
         if (options?.dataStorageVersion !== undefined) {
             dataStorageVersion = options.dataStorageVersion;
@@ -91,8 +96,8 @@ class LocalConnection extends Connection {
         else if (options?.useLegacyFormat !== undefined) {
             dataStorageVersion = options.useLegacyFormat ? "legacy" : "stable";
         }
-        const table = (0, arrow_1.makeEmptyTable)(schema, metadata);
-        const buf = await (0, arrow_1.fromTableToBuffer)(table);
+        const table = (0, arrow_2.makeEmptyTable)(schema, metadata);
+        const buf = await (0, arrow_2.fromTableToBuffer)(table);
         const innerTable = await this.inner.createEmptyTable(name, buf, mode, cleanseStorageOptions(options?.storageOptions), dataStorageVersion, options?.enableV2ManifestPaths);
         return new table_1.LocalTable(innerTable);
     }
@@ -136,3 +141,25 @@ function camelToSnakeCase(camel) {
     }
     return result;
 }
+async function parseTableData(data, options, streaming = false) {
+    let mode = options?.mode ?? "create";
+    const existOk = options?.existOk ?? false;
+    if (mode === "create" && existOk) {
+        mode = "exist_ok";
+    }
+    let table;
+    if ((0, arrow_1.isArrowTable)(data)) {
+        table = (0, sanitize_1.sanitizeTable)(data);
+    }
+    else {
+        table = (0, arrow_1.makeArrowTable)(data, options);
+    }
+    if (streaming) {
+        const buf = await (0, arrow_1.fromTableToStreamBuffer)(table, options?.embeddingFunction, options?.schema);
+        return { buf, mode };
+    }
+    else {
+        const buf = await (0, arrow_2.fromTableToBuffer)(table, options?.embeddingFunction, options?.schema);
+        return { buf, mode };
+    }
+}

package/dist/embedding/embedding_function.d.ts

@@ -50,15 +50,15 @@ export declare abstract class EmbeddingFunction<T = any, M extends FunctionOptio
      *
      * @param optionsOrDatatype - The options for the field or the datatype
      *
-     * @see {@link lancedb.LanceSchema}
+     * @see {@link LanceSchema}
      */
     sourceField(optionsOrDatatype: Partial<FieldOptions> | DataType): [DataType, Map<string, EmbeddingFunction>];
     /**
      * vectorField is used in combination with `LanceSchema` to provide a declarative data model
      *
-     * @param options - The options for the field
+     * @param optionsOrDatatype - The options for the field
      *
-     * @see {@link lancedb.LanceSchema}
+     * @see {@link LanceSchema}
      */
     vectorField(optionsOrDatatype?: Partial<FieldOptions> | DataType): [DataType, Map<string, EmbeddingFunction>];
     /** The number of dimensions of the embeddings */

package/dist/embedding/embedding_function.js

@@ -21,7 +21,7 @@ class EmbeddingFunction {
      *
      * @param optionsOrDatatype - The options for the field or the datatype
      *
-     * @see {@link lancedb.LanceSchema}
+     * @see {@link LanceSchema}
      */
     sourceField(optionsOrDatatype) {
         let datatype = "datatype" in optionsOrDatatype
@@ -38,9 +38,9 @@ class EmbeddingFunction {
     /**
      * vectorField is used in combination with `LanceSchema` to provide a declarative data model
      *
-     * @param options - The options for the field
+     * @param optionsOrDatatype - The options for the field
      *
-     * @see {@link lancedb.LanceSchema}
+     * @see {@link LanceSchema}
      */
     vectorField(optionsOrDatatype) {
         let dtype;

package/dist/embedding/index.d.ts

@@ -1,6 +1,6 @@
 import { Schema } from "../arrow";
 import { EmbeddingFunction } from "./embedding_function";
-export { EmbeddingFunction, TextEmbeddingFunction } from "./embedding_function";
+export { FieldOptions, EmbeddingFunction, TextEmbeddingFunction, FunctionOptions, EmbeddingFunctionConstructor, } from "./embedding_function";
 export * from "./registry";
 /**
  * Create a schema with embedding functions.

package/dist/embedding/registry.d.ts

@@ -1,9 +1,9 @@
 import { type EmbeddingFunction, type EmbeddingFunctionConstructor } from "./embedding_function";
 import "reflect-metadata";
-type CreateReturnType<T> = T extends {
+export type CreateReturnType<T> = T extends {
     init: () => Promise<void>;
 } ? Promise<T> : T;
-interface EmbeddingFunctionCreate<T extends EmbeddingFunction> {
+export interface EmbeddingFunctionCreate<T extends EmbeddingFunction> {
     create(options?: T["TOptions"]): CreateReturnType<T>;
 }
 /**
@@ -20,8 +20,6 @@ export declare class EmbeddingFunctionRegistry {
     length(): number;
     /**
      * Register an embedding function
-     * @param name The name of the function
-     * @param func The function to register
      * @throws Error if the function is already registered
      */
     register<T extends EmbeddingFunctionConstructor = EmbeddingFunctionConstructor>(this: EmbeddingFunctionRegistry, alias?: string): (ctor: T) => any;
@@ -52,4 +50,3 @@ export interface EmbeddingFunctionConfig {
     vectorColumn?: string;
     function: EmbeddingFunction;
 }
-export {};

package/dist/embedding/registry.js

@@ -22,8 +22,6 @@ class EmbeddingFunctionRegistry {
     }
     /**
      * Register an embedding function
-     * @param name The name of the function
-     * @param func The function to register
      * @throws Error if the function is already registered
      */
     register(alias) {

package/dist/index.d.ts

@@ -1,13 +1,16 @@
 import { Connection } from "./connection";
 import { ConnectionOptions } from "./native.js";
-export { WriteOptions, WriteMode, AddColumnsSql, ColumnAlteration, ConnectionOptions, IndexStatistics, IndexConfig, ClientConfig, TimeoutConfig, RetryConfig, } from "./native.js";
+export { AddColumnsSql, ColumnAlteration, ConnectionOptions, IndexStatistics, IndexConfig, ClientConfig, TimeoutConfig, RetryConfig, OptimizeStats, CompactionStats, RemovalStats, } from "./native.js";
 export { makeArrowTable, MakeArrowTableOptions, Data, VectorColumnOptions, } from "./arrow";
-export { Connection, CreateTableOptions, TableNamesOptions, } from "./connection";
-export { ExecutableQuery, Query, QueryBase, VectorQuery, RecordBatchIterator, } from "./query";
-export { Index, IndexOptions, IvfPqOptions } from "./indices";
-export { Table, AddDataOptions, UpdateOptions, OptimizeOptions } from "./table";
+export { Connection, CreateTableOptions, TableNamesOptions, OpenTableOptions, } from "./connection";
+export { ExecutableQuery, Query, QueryBase, VectorQuery, QueryExecutionOptions, FullTextSearchOptions, RecordBatchIterator, } from "./query";
+export { Index, IndexOptions, IvfPqOptions, HnswPqOptions, HnswSqOptions, FtsOptions, } from "./indices";
+export { Table, AddDataOptions, UpdateOptions, OptimizeOptions, Version, } from "./table";
+export { MergeInsertBuilder } from "./merge";
 export * as embedding from "./embedding";
 export * as rerankers from "./rerankers";
+export { SchemaLike, TableLike, FieldLike, RecordBatchLike, DataLike, IntoVector, } from "./arrow";
+export { IntoSql } from "./util";
 /**
  * Connect to a LanceDB instance at the given URI.
  *
@@ -19,6 +22,7 @@ export * as rerankers from "./rerankers";
  * @param {string} uri - The uri of the database. If the database uri starts
  * with `db://` then it connects to a remote database.
  * @see {@link ConnectionOptions} for more details on the URI format.
+ * @param  options - The options to use when connecting to the database
  * @example
  * ```ts
  * const conn = await connect("/path/to/database");
@@ -31,7 +35,7 @@ export * as rerankers from "./rerankers";
  * });
  * ```
  */
-export declare function connect(uri: string, opts?: Partial<ConnectionOptions>): Promise<Connection>;
+export declare function connect(uri: string, options?: Partial<ConnectionOptions>): Promise<Connection>;
 /**
  * Connect to a LanceDB instance at the given URI.
  *
@@ -50,6 +54,6 @@ export declare function connect(uri: string, opts?: Partial<ConnectionOptions>):
  * });
  * ```
  */
-export declare function connect(opts: Partial<ConnectionOptions> & {
+export declare function connect(options: Partial<ConnectionOptions> & {
     uri: string;
 }): Promise<Connection>;

package/dist/index.js

@@ -2,12 +2,10 @@
 // SPDX-License-Identifier: Apache-2.0
 // SPDX-FileCopyrightText: Copyright The LanceDB Authors
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.rerankers = 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.rerankers = exports.embedding = exports.MergeInsertBuilder = exports.Table = exports.Index = exports.RecordBatchIterator = exports.VectorQuery = exports.QueryBase = exports.Query = exports.Connection = exports.VectorColumnOptions = exports.MakeArrowTableOptions = exports.makeArrowTable = void 0;
 exports.connect = connect;
 const connection_1 = require("./connection");
 const native_js_1 = require("./native.js");
-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; } });
@@ -23,14 +21,16 @@ var indices_1 = require("./indices");
 Object.defineProperty(exports, "Index", { enumerable: true, get: function () { return indices_1.Index; } });
 var table_1 = require("./table");
 Object.defineProperty(exports, "Table", { enumerable: true, get: function () { return table_1.Table; } });
+var merge_1 = require("./merge");
+Object.defineProperty(exports, "MergeInsertBuilder", { enumerable: true, get: function () { return merge_1.MergeInsertBuilder; } });
 exports.embedding = require("./embedding");
 exports.rerankers = require("./rerankers");
-async function connect(uriOrOptions, opts = {}) {
+async function connect(uriOrOptions, options = {}) {
     let uri;
     if (typeof uriOrOptions !== "string") {
-        const { uri: uri_, ...options } = uriOrOptions;
+        const { uri: uri_, ...opts } = uriOrOptions;
         uri = uri_;
-        opts = options;
+        options = opts;
     }
     else {
         uri = uriOrOptions;
@@ -38,8 +38,8 @@ async function connect(uriOrOptions, opts = {}) {
     if (!uri) {
         throw new Error("uri is required");
     }
-    opts = opts ?? {};
-    opts.storageOptions = (0, connection_1.cleanseStorageOptions)(opts.storageOptions);
-    const nativeConn = await native_js_1.Connection.new(uri, opts);
+    options = options ?? {};
+    options.storageOptions = (0, connection_1.cleanseStorageOptions)(options.storageOptions);
+    const nativeConn = await native_js_1.Connection.new(uri, options);
     return new connection_1.LocalConnection(nativeConn);
 }

package/dist/indices.d.ts

@@ -426,8 +426,6 @@ export declare class Index {
      * The results of a full text search are ordered by relevance measured by BM25.
      *
      * You can combine filters with full text search.
-     *
-     * For now, the full text search index only supports English, and doesn't support phrase search.
      */
     static fts(options?: Partial<FtsOptions>): Index;
     /**

package/dist/indices.js

@@ -86,8 +86,6 @@ class Index {
      * The results of a full text search are ordered by relevance measured by BM25.
      *
      * You can combine filters with full text search.
-     *
-     * For now, the full text search index only supports English, and doesn't support phrase search.
      */
     static fts(options) {
         return new Index(native_1.Index.fts(options?.withPosition, options?.baseTokenizer, options?.language, options?.maxTokenLength, options?.lowercase, options?.stem, options?.removeStopWords, options?.asciiFolding));

package/dist/native.d.ts

@@ -228,17 +228,6 @@ export interface ConnectionOptions {
    */
   hostOverride?: string
 }
-/** Write mode for writing a table. */
-export 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>
 }

package/dist/native.js

@@ -319,7 +319,7 @@ if (!nativeBinding) {
     }
     throw new Error(`Failed to load native binding`);
 }
-const { Connection, Index, RecordBatchIterator, NativeMergeInsertBuilder, Query, VectorQuery, Reranker, RrfReranker, Table, WriteMode } = nativeBinding;
+const { Connection, Index, RecordBatchIterator, NativeMergeInsertBuilder, Query, VectorQuery, Reranker, RrfReranker, Table } = nativeBinding;
 module.exports.Connection = Connection;
 module.exports.Index = Index;
 module.exports.RecordBatchIterator = RecordBatchIterator;
@@ -329,4 +329,3 @@ module.exports.VectorQuery = VectorQuery;
 module.exports.Reranker = Reranker;
 module.exports.RrfReranker = RrfReranker;
 module.exports.Table = Table;
-module.exports.WriteMode = WriteMode;

package/dist/query.d.ts

@@ -32,10 +32,22 @@ export interface FullTextSearchOptions {
      */
     columns?: string | string[];
 }
-/** Common methods supported by all query types */
+/** Common methods supported by all query types
+ *
+ * @see {@link Query}
+ * @see {@link VectorQuery}
+ *
+ * @hideconstructor
+ */
 export declare class QueryBase<NativeQueryType extends NativeQuery | NativeVectorQuery> implements AsyncIterable<RecordBatch> {
     protected inner: NativeQueryType | Promise<NativeQueryType>;
+    /**
+     * @hidden
+     */
     protected constructor(inner: NativeQueryType | Promise<NativeQueryType>);
+    /**
+     * @hidden
+     */
     protected doCall(fn: (inner: NativeQueryType) => void): void;
     /**
      * A filter statement to be applied to this query.
@@ -52,7 +64,7 @@ export declare class QueryBase<NativeQueryType extends NativeQuery | NativeVecto
     where(predicate: string): this;
     /**
      * A filter statement to be applied to this query.
-     * @alias where
+     * @see where
      * @deprecated Use `where` instead
      */
     filter(predicate: string): this;
@@ -100,7 +112,7 @@ export declare class QueryBase<NativeQueryType extends NativeQuery | NativeVecto
      * Skip searching un-indexed data. This can make search faster, but will miss
      * any data that is not yet indexed.
      *
-     * Use {@link lancedb.Table#optimize} to index all un-indexed data.
+     * Use {@link Table#optimize} to index all un-indexed data.
      */
     fastSearch(): this;
     /**
@@ -111,6 +123,9 @@ export declare class QueryBase<NativeQueryType extends NativeQuery | NativeVecto
      * order to perform hybrid search.
      */
     withRowId(): this;
+    /**
+     * @hidden
+     */
     protected nativeExecute(options?: Partial<QueryExecutionOptions>): Promise<NativeBatchIterator>;
     /**
      * Execute the query and return the results as an @see {@link AsyncIterator}
@@ -124,6 +139,9 @@ export declare class QueryBase<NativeQueryType extends NativeQuery | NativeVecto
      *
      */
     protected execute(options?: Partial<QueryExecutionOptions>): RecordBatchIterator;
+    /**
+     * @hidden
+     */
     [Symbol.asyncIterator](): AsyncIterator<RecordBatch<any>>;
     /** Collect the results as an Arrow @see {@link ArrowTable}. */
     toArrow(options?: Partial<QueryExecutionOptions>): Promise<ArrowTable>;
@@ -156,8 +174,15 @@ export interface ExecutableQuery {
  * A builder used to construct a vector search
  *
  * This builder can be reused to execute the query many times.
+ *
+ * @see {@link Query#nearestTo}
+ *
+ * @hideconstructor
  */
 export declare class VectorQuery extends QueryBase<NativeVectorQuery> {
+    /**
+     * @hidden
+     */
     constructor(inner: NativeVectorQuery | Promise<NativeVectorQuery>);
     /**
      * Set the number of partitions to search (probe)
@@ -282,8 +307,16 @@ export declare class VectorQuery extends QueryBase<NativeVectorQuery> {
     addQueryVector(vector: IntoVector): VectorQuery;
     rerank(reranker: Reranker): VectorQuery;
 }
-/** A builder for LanceDB queries. */
+/** A builder for LanceDB queries.
+ *
+ * @see {@link Table#query}, {@link Table#search}
+ *
+ * @hideconstructor
+ */
 export declare class Query extends QueryBase<NativeQuery> {
+    /**
+     * @hidden
+     */
     constructor(tbl: NativeTable);
     /**
      * Find the nearest vectors to the given query vector.

package/dist/query.js

@@ -44,14 +44,26 @@ class RecordBatchIterable {
         return new RecordBatchIterator(this.inner.execute(this.options?.maxBatchLength));
     }
 }
-/** Common methods supported by all query types */
+/** Common methods supported by all query types
+ *
+ * @see {@link Query}
+ * @see {@link VectorQuery}
+ *
+ * @hideconstructor
+ */
 class QueryBase {
     inner;
+    /**
+     * @hidden
+     */
     constructor(inner) {
         this.inner = inner;
         // intentionally empty
     }
     // call a function on the inner (either a promise or the actual object)
+    /**
+     * @hidden
+     */
     doCall(fn) {
         if (this.inner instanceof Promise) {
             this.inner = this.inner.then((inner) => {
@@ -81,7 +93,7 @@ class QueryBase {
     }
     /**
      * A filter statement to be applied to this query.
-     * @alias where
+     * @see where
      * @deprecated Use `where` instead
      */
     filter(predicate) {
@@ -173,7 +185,7 @@ class QueryBase {
      * Skip searching un-indexed data. This can make search faster, but will miss
      * any data that is not yet indexed.
      *
-     * Use {@link lancedb.Table#optimize} to index all un-indexed data.
+     * Use {@link Table#optimize} to index all un-indexed data.
      */
     fastSearch() {
         this.doCall((inner) => inner.fastSearch());
@@ -190,6 +202,9 @@ class QueryBase {
         this.doCall((inner) => inner.withRowId());
         return this;
     }
+    /**
+     * @hidden
+     */
     nativeExecute(options) {
         if (this.inner instanceof Promise) {
             return this.inner.then((inner) => inner.execute(options?.maxBatchLength));
@@ -212,6 +227,9 @@ class QueryBase {
     execute(options) {
         return new RecordBatchIterator(this.nativeExecute(options));
     }
+    /**
+     * @hidden
+     */
     // biome-ignore lint/suspicious/noExplicitAny: skip
     [Symbol.asyncIterator]() {
         const promise = this.nativeExecute();
@@ -266,8 +284,15 @@ exports.QueryBase = QueryBase;
  * A builder used to construct a vector search
  *
  * This builder can be reused to execute the query many times.
+ *
+ * @see {@link Query#nearestTo}
+ *
+ * @hideconstructor
  */
 class VectorQuery extends QueryBase {
+    /**
+     * @hidden
+     */
     constructor(inner) {
         super(inner);
     }
@@ -472,8 +497,16 @@ class VectorQuery extends QueryBase {
     }
 }
 exports.VectorQuery = VectorQuery;
-/** A builder for LanceDB queries. */
+/** A builder for LanceDB queries.
+ *
+ * @see {@link Table#query}, {@link Table#search}
+ *
+ * @hideconstructor
+ */
 class Query extends QueryBase {
+    /**
+     * @hidden
+     */
     constructor(tbl) {
         super(tbl.query());
     }

package/dist/rerankers/rrf.d.ts

@@ -3,10 +3,11 @@ import { RrfReranker as NativeRRFReranker } from "../native";
 /**
  * Reranks the results using the Reciprocal Rank Fusion (RRF) algorithm.
  *
- * Internally this uses the Rust implementation
+ * @hideconstructor
  */
 export declare class RRFReranker {
     private inner;
+    /** @ignore */
     constructor(inner: NativeRRFReranker);
     static create(k?: number): Promise<RRFReranker>;
     rerankHybrid(query: string, vecResults: RecordBatch, ftsResults: RecordBatch): Promise<RecordBatch>;

package/dist/rerankers/rrf.js

@@ -8,10 +8,11 @@ const native_1 = require("../native");
 /**
  * Reranks the results using the Reciprocal Rank Fusion (RRF) algorithm.
  *
- * Internally this uses the Rust implementation
+ * @hideconstructor
  */
 class RRFReranker {
     inner;
+    /** @ignore */
     constructor(inner) {
         this.inner = inner;
     }

package/dist/table.d.ts

@@ -1,5 +1,4 @@
-import { Table as ArrowTable, Data, IntoVector, Schema, TableLike } from "./arrow";
-import { CreateTableOptions } from "./connection";
+import { Table as ArrowTable, Data, IntoVector, Schema } from "./arrow";
 import { IndexOptions } from "./indices";
 import { MergeInsertBuilder } from "./merge";
 import { AddColumnsSql, ColumnAlteration, IndexConfig, IndexStatistics, OptimizeStats, Table as _NativeTable } from "./native";
@@ -61,8 +60,14 @@ export interface Version {
  * can call the `close` method.  Once the Table is closed, it cannot be used for any
  * further operations.
  *
+ * Tables are created using the methods {@link Connection#createTable}
+ * and {@link Connection#createEmptyTable}. Existing tables are opened
+ * using {@link Connection#openTable}.
+ *
  * Closing a table is optional.  It not closed, it will be closed when it is garbage
  * collected.
+ *
+ * @hideconstructor
  */
 export declare abstract class Table {
     /** Returns the name of the table */
@@ -148,8 +153,9 @@ export declare abstract class Table {
      * Indices on scalar columns will speed up filtering (in both
      * vector and non-vector searches)
      *
-     * @note We currently don't support custom named indexes,
-     * The index name will always be `${column}_idx`
+     * We currently don't support custom named indexes.
+     * The index name will always be `${column}_idx`.
+     *
      * @example
      * // If the column has a vector (fixed size list) data type then
      * // an IvfPq vector index will be created.
@@ -175,7 +181,7 @@ export declare abstract class Table {
      *
      * @param name The name of the index.
      *
-     * @note This does not delete the index from disk, it just removes it from the table.
+     * This does not delete the index from disk, it just removes it from the table.
      * To delete the index, run {@link Table#optimize} after dropping the index.
      *
      * Use {@link Table.listIndices} to find the names of the indices.
@@ -374,10 +380,6 @@ export declare abstract class Table {
      * Use {@link Table.listIndices} to find the names of the indices.
      */
     abstract indexStats(name: string): Promise<IndexStatistics | undefined>;
-    static parseTableData(data: Record<string, unknown>[] | TableLike, options?: Partial<CreateTableOptions>, streaming?: boolean): Promise<{
-        buf: Buffer;
-        mode: string;
-    }>;
 }
 export declare class LocalTable extends Table {
     private readonly inner;

package/dist/table.js

@@ -7,7 +7,6 @@ const arrow_1 = require("./arrow");
 const registry_1 = require("./embedding/registry");
 const merge_1 = require("./merge");
 const query_1 = require("./query");
-const sanitize_1 = require("./sanitize");
 const util_1 = require("./util");
 /**
  * A Table is a collection of Records in a LanceDB Database.
@@ -18,35 +17,19 @@ const util_1 = require("./util");
  * can call the `close` method.  Once the Table is closed, it cannot be used for any
  * further operations.
  *
+ * Tables are created using the methods {@link Connection#createTable}
+ * and {@link Connection#createEmptyTable}. Existing tables are opened
+ * using {@link Connection#openTable}.
+ *
  * Closing a table is optional.  It not closed, it will be closed when it is garbage
  * collected.
+ *
+ * @hideconstructor
  */
 class Table {
     [Symbol.for("nodejs.util.inspect.custom")]() {
         return this.display();
     }
-    static async parseTableData(data, options, streaming = false) {
-        let mode = options?.mode ?? "create";
-        const existOk = options?.existOk ?? false;
-        if (mode === "create" && existOk) {
-            mode = "exist_ok";
-        }
-        let table;
-        if ((0, arrow_1.isArrowTable)(data)) {
-            table = (0, sanitize_1.sanitizeTable)(data);
-        }
-        else {
-            table = (0, arrow_1.makeArrowTable)(data, options);
-        }
-        if (streaming) {
-            const buf = await (0, arrow_1.fromTableToStreamBuffer)(table, options?.embeddingFunction, options?.schema);
-            return { buf, mode };
-        }
-        else {
-            const buf = await (0, arrow_1.fromTableToBuffer)(table, options?.embeddingFunction, options?.schema);
-            return { buf, mode };
-        }
-    }
 }
 exports.Table = Table;
 class LocalTable extends Table {

package/package.json

@@ -11,7 +11,7 @@
     "ann"
   ],
   "private": false,
-  "version": "0.15.1-beta.2",
+  "version": "0.15.1-beta.3",
   "main": "dist/index.js",
   "exports": {
     ".": "./dist/index.js",
@@ -84,7 +84,7 @@
     "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 .",
-    "docs": "typedoc --plugin typedoc-plugin-markdown --out ../docs/src/js lancedb/index.ts",
+    "docs": "typedoc --plugin typedoc-plugin-markdown --treatWarningsAsErrors --out ../docs/src/js lancedb/index.ts",
     "postdocs": "node typedoc_post_process.js",
     "lint": "biome check . && biome format .",
     "lint-fix": "biome check --write . && biome format --write .",
@@ -98,14 +98,14 @@
     "reflect-metadata": "^0.2.2"
   },
   "optionalDependencies": {
-    "@lancedb/lancedb-darwin-x64": "0.15.1-beta.2",
-    "@lancedb/lancedb-darwin-arm64": "0.15.1-beta.2",
-    "@lancedb/lancedb-linux-x64-gnu": "0.15.1-beta.2",
-    "@lancedb/lancedb-linux-arm64-gnu": "0.15.1-beta.2",
-    "@lancedb/lancedb-linux-x64-musl": "0.15.1-beta.2",
-    "@lancedb/lancedb-linux-arm64-musl": "0.15.1-beta.2",
-    "@lancedb/lancedb-win32-x64-msvc": "0.15.1-beta.2",
-    "@lancedb/lancedb-win32-arm64-msvc": "0.15.1-beta.2"
+    "@lancedb/lancedb-darwin-x64": "0.15.1-beta.3",
+    "@lancedb/lancedb-darwin-arm64": "0.15.1-beta.3",
+    "@lancedb/lancedb-linux-x64-gnu": "0.15.1-beta.3",
+    "@lancedb/lancedb-linux-arm64-gnu": "0.15.1-beta.3",
+    "@lancedb/lancedb-linux-x64-musl": "0.15.1-beta.3",
+    "@lancedb/lancedb-linux-arm64-musl": "0.15.1-beta.3",
+    "@lancedb/lancedb-win32-x64-msvc": "0.15.1-beta.3",
+    "@lancedb/lancedb-win32-arm64-msvc": "0.15.1-beta.3"
   },
   "peerDependencies": {
     "apache-arrow": ">=15.0.0 <=18.1.0"

package/typedoc_post_process.js

@@ -40,23 +40,28 @@ function processDirectory(directoryPath) {
 function processContents(contents) {
   // This changes the parameters section to put the parameter description on
   // the same line as the bullet with the parameter name and type.
-  return contents.replace(/(## Parameters[\s\S]*?)(?=##|$)/g, (match) => {
-    let lines = match
-      .split("\n")
-      .map((line) => line.trim())
-
-      .filter((line) => line !== "")
-      .map((line) => {
-        if (line.startsWith("##")) {
-          return line;
-        } else if (line.startsWith("•")) {
-          return "\n*" + line.substring(1);
-        } else {
-          return "    " + line;
-        }
-      });
-    return lines.join("\n") + "\n\n";
-  });
+  return (
+    contents
+      .replace(/(## Parameters[\s\S]*?)(?=##|$)/g, (match) => {
+        let lines = match
+          .split("\n")
+          .map((line) => line.trim())
+
+          .filter((line) => line !== "")
+          .map((line) => {
+            if (line.startsWith("##")) {
+              return line;
+            } else if (line.startsWith("•")) {
+              return "\n*" + line.substring(1);
+            } else {
+              return "    " + line;
+            }
+          });
+        return lines.join("\n") + "\n\n";
+      })
+      // Also trim trailing whitespace
+      .replace(/([^ \t])[ \t]+\n/g, "$1\n")
+  );
 }
 
 // Start processing from the root directory