rust/lancedb
1
0
Fork 0
mirror of https://github.com/lancedb/lancedb.git synced 2026-01-06 20:02:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: minor updates for js migration guides (#1451)

Browse Source 
Co-authored-by: Will Jones <willjones127@gmail.com>
This commit is contained in:
Cory Grinstead
2024-07-22 12:26:49 -05:00
committed by GitHub
parent 2276b114c5
commit 69295548cc
51 changed files with 2353 additions and 1853 deletions
Download Patch File Download Diff File Expand all files Collapse all files

82
docs/src/js/functions/connect.md Normal file
View File

@@ -0,0 +1,82 @@
[**@lancedb/lancedb**](../README.md) • **Docs**
***
[@lancedb/lancedb](../globals.md) / connect
# Function: connect()
## connect(uri, opts)
> **connect**(`uri`, `opts`?): `Promise`&lt;[`Connection`](../classes/Connection.md)&gt;
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`&lt;[`ConnectionOptions`](../interfaces/ConnectionOptions.md) \| `RemoteConnectionOptions`&gt;
### Returns
`Promise`&lt;[`Connection`](../classes/Connection.md)&gt;
### See
[ConnectionOptions](../interfaces/ConnectionOptions.md) for more details on the URI format.
### Examples
```ts
const conn = await connect("/path/to/database");
```
```ts
const conn = await connect(
"s3://bucket/path/to/database",
{storageOptions: {timeout: "60s"}
});
```
## connect(opts)
> **connect**(`opts`): `Promise`&lt;[`Connection`](../classes/Connection.md)&gt;
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
• **opts**: `Partial`&lt;[`ConnectionOptions`](../interfaces/ConnectionOptions.md) \| `RemoteConnectionOptions`&gt; & `object`
### Returns
`Promise`&lt;[`Connection`](../classes/Connection.md)&gt;
### See
[ConnectionOptions](../interfaces/ConnectionOptions.md) for more details on the URI format.
### Example
```ts
const conn = await connect({
uri: "/path/to/database",
storageOptions: {timeout: "60s"}
});
```