rust/lancedb
1
0
Fork 0
mirror of https://github.com/lancedb/lancedb.git synced 2026-06-01 03:10:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

ci(node): check docs in CI (#2084)

Browse Source 
* Make `npm run docs` fail if there are any warnings. This will catch
items missing from the API reference.
* Add a check in our CI to make sure `npm run dos` runs without warnings
and doesn't generate any new files (indicating it might be out-of-date.
* Hide constructors that aren't user facing.
* Remove unused enum `WriteMode`.

Closes #2068
This commit is contained in:
Will Jones
2025-01-30 16:06:06 -08:00
committed by GitHub
parent 25c17ebf4e
commit e05c0cd87e
59 changed files with 1287 additions and 597 deletions
Download Patch File Download Diff File Expand all files Collapse all files

83
docs/src/js/classes/Table.md
View File

@@ -14,21 +14,13 @@ will be freed when the Table is garbage collected. To eagerly free the cache yo
can call the `close` method. Once the Table is closed, it cannot be used for any
further operations.
Tables are created using the methods [Connection#createTable](Connection.md#createtable)
and [Connection#createEmptyTable](Connection.md#createemptytable). Existing tables are opened
using [Connection#openTable](Connection.md#opentable).
Closing a table is optional. It not closed, it will be closed when it is garbage
collected.
## Constructors
### new Table()
```ts
new Table(): Table
```
#### Returns
[`Table`](Table.md)
## Accessors
### name
@@ -216,6 +208,9 @@ Indices on vector columns will speed up vector searches.
Indices on scalar columns will speed up filtering (in both
vector and non-vector searches)
We currently don't support custom named indexes.
The index name will always be `${column}_idx`.
#### Parameters
* **column**: `string`
@@ -226,11 +221,6 @@ vector and non-vector searches)
`Promise`<`void`>
#### Note
We currently don't support custom named indexes,
The index name will always be `${column}_idx`
#### Examples
```ts
@@ -329,18 +319,14 @@ Drop an index from the table.
* **name**: `string`
The name of the index.
This does not delete the index from disk, it just removes it from the table.
To delete the index, run [Table#optimize](Table.md#optimize) after dropping the index.
Use [Table.listIndices](Table.md#listindices) to find the names of the indices.
#### Returns
`Promise`<`void`>
#### Note
This does not delete the index from disk, it just removes it from the table.
To delete the index, run [Table#optimize](Table.md#optimize) after dropping the index.
Use [Table.listIndices](Table.md#listindices) to find the names of the indices.
***
### indexStats()
@@ -404,7 +390,7 @@ List all the versions of the table
#### Returns
`Promise`<`Version`[]>
`Promise`<[`Version`](../interfaces/Version.md)[]>
***
@@ -420,7 +406,7 @@ abstract mergeInsert(on): MergeInsertBuilder
#### Returns
`MergeInsertBuilder`
[`MergeInsertBuilder`](MergeInsertBuilder.md)
***
@@ -464,7 +450,7 @@ Modeled after ``VACUUM`` in PostgreSQL.
#### Returns
`Promise`<`OptimizeStats`>
`Promise`<[`OptimizeStats`](../interfaces/OptimizeStats.md)>
***
@@ -581,7 +567,7 @@ Get the schema of the table.
abstract search(
query,
queryType?,
ftsColumns?): VectorQuery | Query
ftsColumns?): Query | VectorQuery
```
Create a search query to find the nearest neighbors
@@ -589,7 +575,7 @@ of the given query
#### Parameters
* **query**: `string` \| `IntoVector`
* **query**: `string` \| [`IntoVector`](../type-aliases/IntoVector.md)
the query, a vector or string
* **queryType?**: `string`
@@ -603,7 +589,7 @@ of the given query
#### Returns
[`VectorQuery`](VectorQuery.md) \| [`Query`](Query.md)
[`Query`](Query.md) \| [`VectorQuery`](VectorQuery.md)
***
@@ -722,7 +708,7 @@ by `query`.
#### Parameters
* **vector**: `IntoVector`
* **vector**: [`IntoVector`](../type-aliases/IntoVector.md)
#### Returns
@@ -745,38 +731,3 @@ Retrieve the version of the table
#### Returns
`Promise`<`number`>
***
### parseTableData()
```ts
static parseTableData(
data,
options?,
streaming?): Promise<object>
```
#### Parameters
* **data**: `TableLike` \| `Record`&lt;`string`, `unknown`&gt;[]
* **options?**: `Partial`&lt;[`CreateTableOptions`](../interfaces/CreateTableOptions.md)&gt;
* **streaming?**: `boolean` = `false`
#### Returns
`Promise`&lt;`object`&gt;
##### buf
```ts
buf: Buffer;
```
##### mode
```ts
mode: string;
```