mirror of
https://github.com/lancedb/lancedb.git
synced 2026-05-31 19:00:39 +00:00
6331807b95
In addition, there are also a number of changes in nodejs to the docstrings of existing methods because this PR adds a jsdoc linter.
45 lines
1.6 KiB
TypeScript
45 lines
1.6 KiB
TypeScript
// Copyright 2024 Lance Developers.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
import { Connection } from "./connection";
|
|
import {
|
|
Connection as LanceDbConnection,
|
|
ConnectionOptions,
|
|
} from "./native.js";
|
|
|
|
export { ConnectionOptions, WriteOptions, Query } from "./native.js";
|
|
export { Connection, CreateTableOptions } from "./connection";
|
|
export { Table, AddDataOptions } from "./table";
|
|
|
|
/**
|
|
* Connect to a LanceDB instance at the given URI.
|
|
*
|
|
* Accpeted 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)
|
|
* @param {string} uri - The uri of the database. If the database uri starts
|
|
* with `db://` then it connects to a remote database.
|
|
* @see {@link ConnectionOptions} for more details on the URI format.
|
|
*/
|
|
export async function connect(
|
|
uri: string,
|
|
opts?: Partial<ConnectionOptions>,
|
|
): Promise<Connection> {
|
|
opts = opts ?? {};
|
|
const nativeConn = await LanceDbConnection.new(uri, opts);
|
|
return new Connection(nativeConn);
|
|
}
|