doc: improve docs for nodejs connect functions (#833)

* improve the docstring for NodeJS connect functions and `ConnectOptions` parameters. * Simplify `npm run build` steps.
2026-01-07 04:12:59 +00:00 · 2024-01-19 16:07:53 -08:00
parent 7bdca7a092
commit 5b2c602fb3
33 changed files with 1375 additions and 5009 deletions
--- a/docs/src/javascript/interfaces/AwsCredentials.md
+++ b/docs/src/javascript/interfaces/AwsCredentials.md
@@ -18,7 +18,7 @@

 #### Defined in

-[index.ts:34](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L34)
+[index.ts:54](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/index.ts#L54)

 ___

@@ -28,7 +28,7 @@ ___

 #### Defined in

-[index.ts:36](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L36)
+[index.ts:56](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/index.ts#L56)

 ___

@@ -38,4 +38,4 @@ ___

 #### Defined in

-[index.ts:38](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L38)
+[index.ts:58](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/index.ts#L58)
--- a/docs/src/javascript/interfaces/CleanupStats.md
+++ b/docs/src/javascript/interfaces/CleanupStats.md
@@ -19,7 +19,7 @@ The number of bytes removed from disk.

 #### Defined in

-[index.ts:637](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L637)
+[index.ts:878](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/index.ts#L878)

 ___

@@ -31,4 +31,4 @@ The number of old table versions removed.

 #### Defined in

-[index.ts:641](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L641)
+[index.ts:882](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/index.ts#L882)
--- a/docs/src/javascript/interfaces/CompactionMetrics.md
+++ b/docs/src/javascript/interfaces/CompactionMetrics.md
@@ -22,7 +22,7 @@ fragments added.

 #### Defined in

-[index.ts:692](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L692)
+[index.ts:933](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/index.ts#L933)

 ___

@@ -35,7 +35,7 @@ file.

 #### Defined in

-[index.ts:687](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L687)
+[index.ts:928](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/index.ts#L928)

 ___

@@ -47,7 +47,7 @@ The number of new fragments that were created.

 #### Defined in

-[index.ts:682](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L682)
+[index.ts:923](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/index.ts#L923)

 ___

@@ -59,4 +59,4 @@ The number of fragments that were removed.

 #### Defined in

-[index.ts:678](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L678)
+[index.ts:919](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/index.ts#L919)
--- a/docs/src/javascript/interfaces/CompactionOptions.md
+++ b/docs/src/javascript/interfaces/CompactionOptions.md
@@ -24,7 +24,7 @@ Default is true.

 #### Defined in

-[index.ts:660](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L660)
+[index.ts:901](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/index.ts#L901)

 ___

@@ -38,7 +38,7 @@ the deleted rows. Default is 10%.

 #### Defined in

-[index.ts:666](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L666)
+[index.ts:907](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/index.ts#L907)

 ___

@@ -50,7 +50,7 @@ The maximum number of rows per group. Defaults to 1024.

 #### Defined in

-[index.ts:654](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L654)
+[index.ts:895](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/index.ts#L895)

 ___

@@ -63,7 +63,7 @@ the number of cores on the machine.

 #### Defined in

-[index.ts:671](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L671)
+[index.ts:912](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/index.ts#L912)

 ___

@@ -77,4 +77,4 @@ Defaults to 1024 * 1024.

 #### Defined in

-[index.ts:650](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L650)
+[index.ts:891](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/index.ts#L891)
--- a/docs/src/javascript/interfaces/Connection.md
+++ b/docs/src/javascript/interfaces/Connection.md
@@ -31,7 +31,7 @@ Connection could be local against filesystem or remote against a server.

 #### Defined in

-[index.ts:125](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L125)
+[index.ts:183](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/index.ts#L183)

 ## Methods

@@ -59,7 +59,7 @@ Creates a new Table, optionally initializing it with new data.

 #### Defined in

-[index.ts:146](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L146)
+[index.ts:207](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/index.ts#L207)

 ▸ **createTable**(`name`, `data`): `Promise`\<[`Table`](Table.md)\<`number`[]\>\>

@@ -78,7 +78,7 @@ Creates a new Table and initialize it with new data.

 #### Defined in

-[index.ts:154](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L154)
+[index.ts:221](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/index.ts#L221)

 ▸ **createTable**(`name`, `data`, `options`): `Promise`\<[`Table`](Table.md)\<`number`[]\>\>

@@ -98,7 +98,7 @@ Creates a new Table and initialize it with new data.

 #### Defined in

-[index.ts:163](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L163)
+[index.ts:233](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/index.ts#L233)

 ▸ **createTable**\<`T`\>(`name`, `data`, `embeddings`): `Promise`\<[`Table`](Table.md)\<`T`\>\>

@@ -124,7 +124,7 @@ Creates a new Table and initialize it with new data.

 #### Defined in

-[index.ts:172](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L172)
+[index.ts:246](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/index.ts#L246)

 ▸ **createTable**\<`T`\>(`name`, `data`, `embeddings`, `options`): `Promise`\<[`Table`](Table.md)\<`T`\>\>

@@ -151,7 +151,7 @@ Creates a new Table and initialize it with new data.

 #### Defined in

-[index.ts:181](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L181)
+[index.ts:259](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/index.ts#L259)

 ___

@@ -173,7 +173,7 @@ Drop an existing table.

 #### Defined in

-[index.ts:187](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L187)
+[index.ts:270](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/index.ts#L270)

 ___

@@ -202,7 +202,7 @@ Open a table in the database.

 #### Defined in

-[index.ts:135](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L135)
+[index.ts:193](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/index.ts#L193)

 ___

@@ -216,4 +216,4 @@ ___

 #### Defined in

-[index.ts:127](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L127)
+[index.ts:185](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/index.ts#L185)
--- a/docs/src/javascript/interfaces/ConnectionOptions.md
+++ b/docs/src/javascript/interfaces/ConnectionOptions.md
@@ -21,7 +21,7 @@

 #### Defined in

-[index.ts:49](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L49)
+[index.ts:81](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/index.ts#L81)

 ___

@@ -29,9 +29,13 @@ ___

 • `Optional` **awsCredentials**: [`AwsCredentials`](AwsCredentials.md)

+User provided AWS crednetials.
+
+If not provided, LanceDB will use the default credentials provider chain.
+
 #### Defined in

-[index.ts:44](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L44)
+[index.ts:75](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/index.ts#L75)

 ___

@@ -39,9 +43,11 @@ ___

 • `Optional` **awsRegion**: `string`

+AWS region to connect to. Default is defaultAwsRegion.
+
 #### Defined in

-[index.ts:46](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L46)
+[index.ts:78](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/index.ts#L78)

 ___

@@ -49,9 +55,13 @@ ___

 • `Optional` **hostOverride**: `string`

+Override the host URL for the remote connections.
+
+This is useful for local testing.
+
 #### Defined in

-[index.ts:54](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L54)
+[index.ts:91](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/index.ts#L91)

 ___

@@ -59,9 +69,11 @@ ___

 • `Optional` **region**: `string`

+Region to connect
+
 #### Defined in

-[index.ts:51](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L51)
+[index.ts:84](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/index.ts#L84)

 ___

@@ -69,6 +81,12 @@ ___

 • **uri**: `string`

+LanceDB database URI.
+
+- `/path/to/database` - local database
+- `s3://bucket/path/to/database` or `gs://bucket/path/to/database` - database on cloud storage
+- `db://host:port` - remote database (SaaS)
+
 #### Defined in

-[index.ts:42](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L42)
+[index.ts:69](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/index.ts#L69)
--- a/docs/src/javascript/interfaces/CreateTableOptions.md
+++ b/docs/src/javascript/interfaces/CreateTableOptions.md
@@ -26,7 +26,7 @@

 #### Defined in

-[index.ts:79](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L79)
+[index.ts:116](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/index.ts#L116)

 ___

@@ -36,7 +36,7 @@ ___

 #### Defined in

-[index.ts:85](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L85)
+[index.ts:122](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/index.ts#L122)

 ___

@@ -46,7 +46,7 @@ ___

 #### Defined in

-[index.ts:76](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L76)
+[index.ts:113](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/index.ts#L113)

 ___

@@ -56,7 +56,7 @@ ___

 #### Defined in

-[index.ts:82](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L82)
+[index.ts:119](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/index.ts#L119)

 ___

@@ -66,4 +66,4 @@ ___

 #### Defined in

-[index.ts:88](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L88)
+[index.ts:125](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/index.ts#L125)
--- a/docs/src/javascript/interfaces/EmbeddingFunction.md
+++ b/docs/src/javascript/interfaces/EmbeddingFunction.md
@@ -45,7 +45,7 @@ Creates a vector representation for the given values.

 #### Defined in

-[embedding/embedding_function.ts:27](https://github.com/lancedb/lancedb/blob/7856a94/node/src/embedding/embedding_function.ts#L27)
+[embedding/embedding_function.ts:27](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/embedding/embedding_function.ts#L27)

 ___

@@ -57,4 +57,4 @@ The name of the column that will be used as input for the Embedding Function.

 #### Defined in

-[embedding/embedding_function.ts:22](https://github.com/lancedb/lancedb/blob/7856a94/node/src/embedding/embedding_function.ts#L22)
+[embedding/embedding_function.ts:22](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/embedding/embedding_function.ts#L22)
--- a/docs/src/javascript/interfaces/IndexStats.md
+++ b/docs/src/javascript/interfaces/IndexStats.md
@@ -17,7 +17,7 @@

 #### Defined in

-[index.ts:344](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L344)
+[index.ts:478](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/index.ts#L478)

 ___

@@ -27,4 +27,4 @@ ___

 #### Defined in

-[index.ts:345](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L345)
+[index.ts:479](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/index.ts#L479)
--- a/docs/src/javascript/interfaces/IvfPQIndexConfig.md
+++ b/docs/src/javascript/interfaces/IvfPQIndexConfig.md
@@ -29,7 +29,7 @@ The column to be indexed

 #### Defined in

-[index.ts:701](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L701)
+[index.ts:942](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/index.ts#L942)

 ___

@@ -41,7 +41,7 @@ Cache size of the index

 #### Defined in

-[index.ts:750](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L750)
+[index.ts:991](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/index.ts#L991)

 ___

@@ -53,7 +53,7 @@ A unique name for the index

 #### Defined in

-[index.ts:706](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L706)
+[index.ts:947](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/index.ts#L947)

 ___

@@ -65,7 +65,7 @@ The max number of iterations for kmeans training.

 #### Defined in

-[index.ts:721](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L721)
+[index.ts:962](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/index.ts#L962)

 ___

@@ -77,7 +77,7 @@ Max number of iterations to train OPQ, if `use_opq` is true.

 #### Defined in

-[index.ts:740](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L740)
+[index.ts:981](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/index.ts#L981)

 ___

@@ -89,7 +89,7 @@ Metric type, L2 or Cosine

 #### Defined in

-[index.ts:711](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L711)
+[index.ts:952](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/index.ts#L952)

 ___

@@ -101,7 +101,7 @@ The number of bits to present one PQ centroid.

 #### Defined in

-[index.ts:735](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L735)
+[index.ts:976](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/index.ts#L976)

 ___

@@ -113,7 +113,7 @@ The number of partitions this index

 #### Defined in

-[index.ts:716](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L716)
+[index.ts:957](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/index.ts#L957)

 ___

@@ -125,7 +125,7 @@ Number of subvectors to build PQ code

 #### Defined in

-[index.ts:731](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L731)
+[index.ts:972](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/index.ts#L972)

 ___

@@ -137,7 +137,7 @@ Replace an existing index with the same name if it exists.

 #### Defined in

-[index.ts:745](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L745)
+[index.ts:986](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/index.ts#L986)

 ___

@@ -147,7 +147,7 @@ ___

 #### Defined in

-[index.ts:752](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L752)
+[index.ts:993](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/index.ts#L993)

 ___

@@ -159,4 +159,4 @@ Train as optimized product quantization.

 #### Defined in

-[index.ts:726](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L726)
+[index.ts:967](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/index.ts#L967)
--- a/docs/src/javascript/interfaces/Table.md
+++ b/docs/src/javascript/interfaces/Table.md
@@ -21,11 +21,13 @@ A LanceDB Table is the collection of Records. Each Record has one or more vector
 - [add](Table.md#add)
 - [countRows](Table.md#countrows)
 - [createIndex](Table.md#createindex)
+- [createScalarIndex](Table.md#createscalarindex)
 - [delete](Table.md#delete)
 - [indexStats](Table.md#indexstats)
 - [listIndices](Table.md#listindices)
 - [name](Table.md#name)
 - [overwrite](Table.md#overwrite)
+- [schema](Table.md#schema)
 - [search](Table.md#search)
 - [update](Table.md#update)

@@ -55,7 +57,7 @@ The number of rows added to the table

 #### Defined in

-[index.ts:209](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L209)
+[index.ts:291](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/index.ts#L291)

 ___

@@ -75,7 +77,7 @@ Returns the number of rows in this table.

 #### Defined in

-[index.ts:229](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L229)
+[index.ts:361](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/index.ts#L361)

 ___

@@ -105,7 +107,42 @@ VectorIndexParams.

 #### Defined in

-[index.ts:224](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L224)
+[index.ts:306](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/index.ts#L306)
+
+___
+
+### createScalarIndex
+
+• **createScalarIndex**: (`column`: `string`, `replace`: `boolean`) => `Promise`\<`void`\>
+
+#### Type declaration
+
+▸ (`column`, `replace`): `Promise`\<`void`\>
+
+Create a scalar index on this Table for the given column
+
+##### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `column` | `string` | The column to index |
+| `replace` | `boolean` | If false, fail if an index already exists on the column Scalar indices, like vector indices, can be used to speed up scans. A scalar index can speed up scans that contain filter expressions on the indexed column. For example, the following scan will be faster if the column `my_col` has a scalar index: ```ts const con = await lancedb.connect('./.lancedb'); const table = await con.openTable('images'); const results = await table.where('my_col = 7').execute(); ``` Scalar indices can also speed up scans containing a vector search and a prefilter: ```ts const con = await lancedb.connect('././lancedb'); const table = await con.openTable('images'); const results = await table.search([1.0, 2.0]).where('my_col != 7').prefilter(true); ``` Scalar indices can only speed up scans for basic filters using equality, comparison, range (e.g. `my_col BETWEEN 0 AND 100`), and set membership (e.g. `my_col IN (0, 1, 2)`) Scalar indices can be used if the filter contains multiple indexed columns and the filter criteria are AND'd or OR'd together (e.g. `my_col < 0 AND other_col> 100`) Scalar indices may be used if the filter contains non-indexed columns but, depending on the structure of the filter, they may not be usable. For example, if the column `not_indexed` does not have a scalar index then the filter `my_col = 0 OR not_indexed = 1` will not be able to use any scalar index on `my_col`. |
+
+##### Returns
+
+`Promise`\<`void`\>
+
+**`Examples`**
+
+```ts
+const con = await lancedb.connect('././lancedb')
+const table = await con.openTable('images')
+await table.createScalarIndex('my_col')
+```
+
+#### Defined in
+
+[index.ts:356](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/index.ts#L356)

 ___

@@ -157,7 +194,7 @@ await tbl.countRows() // Returns 1

 #### Defined in

-[index.ts:263](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L263)
+[index.ts:395](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/index.ts#L395)

 ___

@@ -183,7 +220,7 @@ Get statistics about an index.

 #### Defined in

-[index.ts:306](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L306)
+[index.ts:438](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/index.ts#L438)

 ___

@@ -203,7 +240,7 @@ List the indicies on this table.

 #### Defined in

-[index.ts:301](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L301)
+[index.ts:433](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/index.ts#L433)

 ___

@@ -213,7 +250,7 @@ ___

 #### Defined in

-[index.ts:195](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L195)
+[index.ts:277](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/index.ts#L277)

 ___

@@ -241,7 +278,17 @@ The number of rows added to the table

 #### Defined in

-[index.ts:217](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L217)
+[index.ts:299](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/index.ts#L299)
+
+___
+
+### schema
+
+• **schema**: `Promise`\<`Schema`\<`any`\>\>
+
+#### Defined in
+
+[index.ts:440](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/index.ts#L440)

 ___

@@ -267,7 +314,7 @@ Creates a search query to find the nearest neighbors of the given search term

 #### Defined in

-[index.ts:201](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L201)
+[index.ts:283](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/index.ts#L283)

 ___

@@ -305,8 +352,8 @@ const data = [
 const tbl = await con.createTable("my_table", data)

 await tbl.update({
-  filter: "id = 2",
-  updates: { vector: [2, 2], name: "Michael" },
+  where: "id = 2",
+  values: { vector: [2, 2], name: "Michael" },
 })

 let results = await tbl.search([1, 1]).execute();
@@ -318,4 +365,4 @@ let results = await tbl.search([1, 1]).execute();

 #### Defined in

-[index.ts:296](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L296)
+[index.ts:428](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/index.ts#L428)
--- a/docs/src/javascript/interfaces/UpdateArgs.md
+++ b/docs/src/javascript/interfaces/UpdateArgs.md
@@ -20,7 +20,7 @@ new values to set

 #### Defined in

-[index.ts:320](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L320)
+[index.ts:454](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/index.ts#L454)

 ___

@@ -33,4 +33,4 @@ in which case all rows will be updated.

 #### Defined in

-[index.ts:314](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L314)
+[index.ts:448](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/index.ts#L448)
--- a/docs/src/javascript/interfaces/UpdateSqlArgs.md
+++ b/docs/src/javascript/interfaces/UpdateSqlArgs.md
@@ -20,7 +20,7 @@ new values to set as SQL expressions.

 #### Defined in

-[index.ts:334](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L334)
+[index.ts:468](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/index.ts#L468)

 ___

@@ -33,4 +33,4 @@ in which case all rows will be updated.

 #### Defined in

-[index.ts:328](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L328)
+[index.ts:462](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/index.ts#L462)
--- a/docs/src/javascript/interfaces/VectorIndex.md
+++ b/docs/src/javascript/interfaces/VectorIndex.md
@@ -18,7 +18,7 @@

 #### Defined in

-[index.ts:338](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L338)
+[index.ts:472](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/index.ts#L472)

 ___

@@ -28,7 +28,7 @@ ___

 #### Defined in

-[index.ts:339](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L339)
+[index.ts:473](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/index.ts#L473)

 ___

@@ -38,4 +38,4 @@ ___

 #### Defined in

-[index.ts:340](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L340)
+[index.ts:474](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/index.ts#L474)
--- a/docs/src/javascript/interfaces/WriteOptions.md
+++ b/docs/src/javascript/interfaces/WriteOptions.md
@@ -24,4 +24,4 @@ A [WriteMode](../enums/WriteMode.md) to use on this operation

 #### Defined in

-[index.ts:774](https://github.com/lancedb/lancedb/blob/7856a94/node/src/index.ts#L774)
+[index.ts:1015](https://github.com/lancedb/lancedb/blob/c89d5e6/node/src/index.ts#L1015)