rust/lancedb
1
0
Fork 0
mirror of https://github.com/lancedb/lancedb.git synced 2025-12-25 14:29:56 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
8debf26b819e30972f67e4506c60cea1b5e5212d
lancedb/docs/src/javascript/interfaces/ConnectionOptions.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

1.8 KiB
Raw Blame History

vectordb / Exports / ConnectionOptions

Interface: ConnectionOptions

Table of contents

Properties

Properties

apiKey

• Optional apiKey: string

Defined in

index.ts:81

awsCredentials

• Optional awsCredentials: AwsCredentials

User provided AWS crednetials.

If not provided, LanceDB will use the default credentials provider chain.

Defined in

index.ts:75

awsRegion

• Optional awsRegion: string

AWS region to connect to. Default is defaultAwsRegion.

Defined in

index.ts:78

hostOverride

• Optional hostOverride: string

Override the host URL for the remote connections.

This is useful for local testing.

Defined in

index.ts:91

region

• Optional region: string

Region to connect

Defined in

index.ts:84

uri

• 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:69