rust/lancedb
1
0
Fork 0
mirror of https://github.com/lancedb/lancedb.git synced 2025-12-26 14:49:57 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
93d33812563aa1df971fed8e941196d85715d534
lancedb/docs/src/javascript/modules.md
Lei Xu 9a9fc77a95 doc: improve docs for nodejs connect functions (#833) 
* improve the docstring for NodeJS connect functions and
`ConnectOptions` parameters.
* Simplify `npm run build` steps.
2024-01-19 16:07:53 -08:00

3.2 KiB
Raw Blame History

vectordb / Exports

vectordb

Table of contents

Enumerations

Classes

Interfaces

Type Aliases

Functions

Type Aliases

VectorIndexParams

Ƭ VectorIndexParams: IvfPQIndexConfig

Defined in

index.ts:996

Functions

connect

▸ connect(uri): Promise<Connection>

Connect to a LanceDB instance at the given URI.

Accpeted formats:

  • /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)

Parameters

Name Type Description
uri string The uri of the database. If the database uri starts with db:// then it connects to a remote database.

Returns

Promise<Connection>

See

ConnectionOptions for more details on the URI format.

Defined in

index.ts:141

▸ connect(opts): Promise<Connection>

Connect to a LanceDB instance with connection options.

Parameters

Name Type Description
opts Partial<ConnectionOptions> The ConnectionOptions to use when connecting to the database.

Returns

Promise<Connection>

Defined in

index.ts:147

isWriteOptions

▸ isWriteOptions(value): value is WriteOptions

Parameters

Name Type
value any

Returns

value is WriteOptions

Defined in

index.ts:1022