lancedb/docs/src/javascript/README.md

vectordb / Exports

LanceDB

A JavaScript / Node.js library for LanceDB.

Installation

npm install vectordb

Usage

Basic Example

const lancedb = require('vectordb');
const db = lancedb.connect('<PATH_TO_LANCEDB_DATASET>');
const table = await db.openTable('my_table');
const query = await table.search([0.1, 0.3]).setLimit(20).execute();
console.log(results);

The examples folder contains complete examples.

Development

The LanceDB javascript is built with npm:

npm run tsc

Run the tests with

npm test

To run the linter and have it automatically fix all errors

npm run lint -- --fix

To build documentation

npx typedoc --plugin typedoc-plugin-markdown --out ../docs/src/javascript src/index.ts