mirror of
https://github.com/lancedb/lancedb.git
synced 2026-01-07 12:22:59 +00:00
60 lines
1.2 KiB
Markdown
60 lines
1.2 KiB
Markdown
# LanceDB
|
|
|
|
A JavaScript / Node.js library for [LanceDB](https://github.com/lancedb/lancedb).
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
npm install vectordb
|
|
```
|
|
|
|
This will download the appropriate native library for your platform. We currently
|
|
support x86_64 Linux, Intel MacOS, and ARM (M1/M2) MacOS.
|
|
|
|
## Usage
|
|
|
|
### Basic Example
|
|
|
|
```javascript
|
|
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](./examples) folder contains complete examples.
|
|
|
|
## Development
|
|
|
|
Build and install the rust library with:
|
|
|
|
```bash
|
|
npm run build
|
|
npm run pack-build
|
|
npm install --no-save ./dist/vectordb-*.tgz
|
|
```
|
|
|
|
`npm run build` builds the Rust library, `npm run pack-build` packages the Rust
|
|
binary into an npm module called `@vectordb/<platform>` (for example,
|
|
`@vectordb/darwin-arm64.node`), and then `npm run install ...` installs that
|
|
module.
|
|
|
|
The LanceDB javascript is built with npm:
|
|
|
|
```bash
|
|
npm run tsc
|
|
```
|
|
|
|
Run the tests with
|
|
|
|
```bash
|
|
npm test
|
|
```
|
|
|
|
To run the linter and have it automatically fix all errors
|
|
|
|
```bash
|
|
npm run lint -- --fix
|
|
```
|