mirror of
https://github.com/lancedb/lancedb.git
synced 2026-11-02 00:36:53 +00:00
docs(nodejs): regenerate the connection API docs for dropViewAsync
`pnpm run docs` output is checked in, so adding a public method leaves the generated page stale and the NodeJS job fails on the diff. Applied exactly what it printed: the new `dropViewAsync()` entry and the reworded `dropView` description that now points at it.
This commit is contained in:
@@ -557,9 +557,10 @@ on the returned job to know when cleanup has finished.
|
||||
abstract dropView(name, namespacePath?): Promise<void>
|
||||
```
|
||||
|
||||
Drop the view named `name`.
|
||||
Drop the view named `name` and wait for its definition to be deleted.
|
||||
|
||||
The tables it reads are untouched: a view holds no rows of its own.
|
||||
The tables it reads are untouched: a view holds no rows of its own. Use
|
||||
[dropViewAsync](Connection.md#dropviewasync) to retain the cleanup job instead of waiting on it.
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -573,6 +574,30 @@ The tables it reads are untouched: a view holds no rows of its own.
|
||||
|
||||
***
|
||||
|
||||
### dropViewAsync()
|
||||
|
||||
```ts
|
||||
abstract dropViewAsync(name, namespacePath?): Promise<Job>
|
||||
```
|
||||
|
||||
Start dropping the view named `name` and return the job deleting its
|
||||
definition, without waiting for completion.
|
||||
|
||||
The name is free before this resolves. When nothing was bound to it, the
|
||||
returned job is already finished and has no id.
|
||||
|
||||
#### Parameters
|
||||
|
||||
* **name**: `string`
|
||||
|
||||
* **namespacePath?**: `string`[]
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<[`Job`](Job.md)>
|
||||
|
||||
***
|
||||
|
||||
### isOpen()
|
||||
|
||||
```ts
|
||||
|
||||
Reference in New Issue
Block a user