Files
lancedb/docs/src/js/functions/connect.md
T
Will JonesandClaude Opus 5.5 4d7a64712f docs: adopt Embedded/Distributed terminology across docs and SDKs (#4713)
## Summary

Adopts the product terminology guide across the docs site pages, SDK
docstrings and error messages. "LanceDB OSS" and local mode become
**LanceDB Embedded**. "Remote" as the execution model becomes **LanceDB
Distributed**, which LanceDB Enterprise provides. Where free vs paid is
the point, pages contrast "LanceDB Embedded (open source)" with "LanceDB
Enterprise". This is a first trial of the Embedded name, so reviewers
can judge it in context.

- **Embedded vs Distributed** for where execution runs (`optimize()`,
consistency, branching, maintenance). Main pages define it once:
"LanceDB Enterprise runs LanceDB Distributed: …"
- **LanceDB Cloud** is kept only for legacy-Cloud specifics (`db://`
region, the brute-force KNN limit) and marked legacy. "Cloud and
Enterprise" becomes Enterprise or Distributed.
- **Plan executor** becomes "executor" or the fleet name.
- **Error messages** change, e.g. `optimize is not supported for remote
tables.` → `... in LanceDB Distributed.` Tests that match on them are
updated.
- **Vale rules** (`EmbeddedName`, `OSSProduct`, `RemoteExecution`,
`DistributedEnterprise`, `LegacyCloud`, `InternalNames`) enforce the
terms in prose.

Unchanged: identifiers (`availability.oss`, the `remote` module and
feature, `RemoteTable`, `db://`), heading anchors, internal code
comments, and Geneva.

## Evidence

- Rust lib tests for the changed messages and the Python tests in
`test_remote_db.py`, `test_materialized_views.py` and `test_table.py`
pass locally.
- Not run locally:
- The Node tests: `remote.test.ts` and `table.test.ts` have updated
assertions.
  - Vale.
  - The `experimental_functions`-marked materialized-view tests.
- `docs/src` API reference was hand-edited to match the docstrings
rather than regenerated.

## Merge Risk

**Door:** two-way; prose and message text only.
**Blast Radius:** `docs`, `error-messages`: callers matching on old
error strings would break.

Companion PRs: lancedb/docs (assembler labels, STYLE.md) and sophon
(Enterprise pages).

🤖 Generated with [Claude Code](https://claude.com/claude-code)

---------

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-28 14:04:41 -07:00

2.6 KiB

@lancedb/lancedb • Docs


@lancedb/lancedb / connect

Function: connect()

connect(uri, options, session, headerProvider)

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

Connect to a LanceDB instance at the given URI.

Accepted formats:

  • /path/to/database - database on the local file system
  • s3://bucket/path/to/database or gs://bucket/path/to/database - database on cloud storage
  • db://host:port - LanceDB Enterprise or LanceDB Cloud (legacy) database

Parameters

  • uri: string The uri of the database. If the database uri starts with db:// then it connects to LanceDB Enterprise or LanceDB Cloud (legacy).

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

  • session?: Session

  • headerProvider?: HeaderProvider | () => Record<string, string> | () => Promise<Record<string, string>>

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"}
});

Using with a header provider for per-request authentication:

const provider = new StaticHeaderProvider({
  "X-API-Key": "my-key"
});
const conn = await connectWithHeaderProvider(
  "db://host:port",
  options,
  provider
);

connect(options)

function connect(options): Promise<Connection>

Connect to a LanceDB instance at the given URI.

Accepted formats:

  • /path/to/database - database on the local file system
  • s3://bucket/path/to/database or gs://bucket/path/to/database - database on cloud storage
  • db://host:port - LanceDB Enterprise or LanceDB Cloud (legacy) database

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.

Examples

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