rust/lancedb
1
0
Fork 0
mirror of https://github.com/lancedb/lancedb.git synced 2026-01-09 13:22:58 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
43747278c809d9fde2c3c1ef7f2eae007886e632
lancedb/docs/src/js/functions/connect.md
Will Jones db125013fc docs: better formatting for Node API docs (#1892) 
* Sets `"useCodeBlocks": true`
* Adds a post-processing script `nodejs/typedoc_post_process.js` that
puts the parameter description on the same line as the parameter name,
like it is in our Python docs. This makes the text hierarchy clearer in
those sections and also makes the sections shorter.
2024-12-09 17:04:09 -08:00

1.8 KiB
Raw Blame History

@lancedb/lancedb • Docs

@lancedb/lancedb / connect

Function: connect()

connect(uri, opts)

function connect(uri, opts?): 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.

  • opts?: Partial<ConnectionOptions>

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(opts)

function connect(opts): 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

Returns

Promise<Connection>

See

ConnectionOptions for more details on the URI format.

Example

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