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 - 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
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 - 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.

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