rust/lancedb
1
0
Fork 0
mirror of https://github.com/lancedb/lancedb.git synced 2025-12-25 06:19:57 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
e08d45e0908bb3229de97f33c52bb75686930b7f
lancedb/docs/src/js/functions/connect.md
Will Jones e05c0cd87e ci(node): check docs in CI (#2084) 
* 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
2025-01-30 16:06:06 -08:00

1.9 KiB
Raw Blame History

@lancedb/lancedb • Docs

@lancedb/lancedb / connect

Function: connect()

connect(uri, options)

function connect(uri, options?): Promise<Connection>

Connect to a LanceDB instance at the given URI.

Accepted 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 (LanceDB cloud)

Parameters

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

  • options?: Partial<ConnectionOptions> The options to use when connecting to the database

Returns

Promise<Connection>

See

ConnectionOptions for more details on the URI format.

Examples

const conn = await connect("/path/to/database");

const conn = await connect(
  "s3://bucket/path/to/database",
  {storageOptions: {timeout: "60s"}
});

connect(options)

function connect(options): Promise<Connection>

Connect to a LanceDB instance at the given URI.

Accepted 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 (LanceDB cloud)

Parameters

  • options: Partial<ConnectionOptions> & object The options to use when connecting to the database

Returns

Promise<Connection>

See

ConnectionOptions for more details on the URI format.

Example

const conn = await connect({
  uri: "/path/to/database",
  storageOptions: {timeout: "60s"}
});