@lancedb/lancedb 0.15.0 → 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

@@ -1,17 +1,6 @@
 "use strict";
-// Copyright 2023 Lance 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.
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-FileCopyrightText: Copyright The LanceDB Authors
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);
@@ -218,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";
  *
@@ -239,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)
  * ```
  */
@@ -499,6 +487,12 @@ async function applyEmbeddings(table, embeddings, schema) {
     else if (embeddings == null || embeddings === undefined) {
         return table;
     }
+    let schemaMetadata = schema?.metadata || new Map();
+    if (!(embeddings == null || embeddings === undefined)) {
+        const registry = (0, registry_1.getRegistry)();
+        const embeddingMetadata = registry.getTableMetadata([embeddings]);
+        schemaMetadata = new Map([...schemaMetadata, ...embeddingMetadata]);
+    }
     // Convert from ArrowTable to Record<String, Vector>
     const colEntries = [...Array(table.numCols).keys()].map((_, idx) => {
         const name = table.schema.fields[idx].name;
@@ -553,13 +547,14 @@ async function applyEmbeddings(table, embeddings, schema) {
         const destType = newVectorType(vectors[0].length, innerDestType);
         newColumns[destColumn] = makeVector(vectors, destType);
     }
-    const newTable = new apache_arrow_1.Table(newColumns);
+    let newTable = new apache_arrow_1.Table(newColumns);
     if (schema != null) {
         if (schema.fields.find((f) => f.name === destColumn) === undefined) {
             throw new Error(`When using embedding functions and specifying a schema the schema should include the embedding column but the column ${destColumn} was missing`);
         }
-        return alignTable(newTable, schema);
+        newTable = alignTable(newTable, schema);
     }
+    newTable = new apache_arrow_1.Table(new apache_arrow_1.Schema(newTable.schema.fields, schemaMetadata), newTable.batches);
     return newTable;
 }
 /**

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

@@ -1,22 +1,13 @@
 "use strict";
-// Copyright 2024 Lance 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.
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-FileCopyrightText: Copyright The LanceDB Authors
 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.
@@ -35,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")]() {
@@ -42,8 +34,10 @@ class Connection {
     }
 }
 exports.Connection = Connection;
+/** @hideconstructor */
 class LocalConnection extends Connection {
     inner;
+    /** @hidden */
     constructor(inner) {
         super();
         this.inner = inner;
@@ -72,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;
@@ -102,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);
     }
@@ -147,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

@@ -1,17 +1,6 @@
 "use strict";
-// Copyright 2024 Lance 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.
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-FileCopyrightText: Copyright The LanceDB Authors
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TextEmbeddingFunction = exports.EmbeddingFunction = void 0;
 require("reflect-metadata");
@@ -32,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
@@ -49,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/index.js

@@ -1,17 +1,6 @@
 "use strict";
-// Copyright 2023 Lance 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.
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-FileCopyrightText: Copyright The LanceDB Authors
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);

package/dist/embedding/openai.js

@@ -1,17 +1,6 @@
 "use strict";
-// Copyright 2023 Lance 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.
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-FileCopyrightText: Copyright The LanceDB Authors
 var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
     var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
     if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);

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

@@ -1,17 +1,6 @@
 "use strict";
-// Copyright 2024 Lance 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.
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-FileCopyrightText: Copyright The LanceDB Authors
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.EmbeddingFunctionRegistry = void 0;
 exports.register = register;
@@ -33,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/embedding/transformers.js

@@ -1,17 +1,6 @@
 "use strict";
-// Copyright 2023 Lance 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.
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-FileCopyrightText: Copyright The LanceDB Authors
 var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
     var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
     if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);

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

@@ -1,24 +1,11 @@
 "use strict";
-// Copyright 2024 Lance 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.
+// 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; } });
@@ -34,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;
@@ -49,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;
     /**