mirror of https://github.com/lancedb/lancedb.git synced 2025-12-27 07:09:57 +00:00

Files

Will Jones fbcbc75b5b feat: upgrade lance to stable version (#2420 )

Adds a script to change the lance dependency easily. To make this
change, I just had to run:

```bash
python ci/set_lance_version.py stable
```

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

- **New Features**
- Added a script to automate updating the Lance package version in
project dependencies.
- **Chores**
- Updated workflows to improve lockfile management and automate updates
during releases and publishing.
- Switched Lance dependencies from git-based references to fixed version
numbers for improved stability.
- Enhanced lockfile update script with an option to amend commits and
quieter output.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

2025-06-04 13:34:30 -07:00

examples

feat(node): Improve concurrency (#376 )

2023-08-01 14:22:04 -07:00

src

fix: revert change default read_consistency_interval=5s (#2327 )

2025-04-14 08:48:15 -07:00

.eslintrc.js

fix: sanitize foreign schemas (#1058 )

2024-04-05 16:31:42 -07:00

.npmignore

feat(node): pull node binaries into separate packages (3) (#285 )

2023-07-12 16:52:04 -07:00

CHANGELOG.md

[nodejs] bumping version to 0.1.5 (#171 )

2023-06-09 12:33:17 -07:00

native.js

fix(node) Give preference to local index.node lib (#393 )

2023-08-01 15:29:15 -07:00

package-lock.json

feat: upgrade lance to stable version (#2420 )

2025-06-04 13:34:30 -07:00

package.json

Bump version: 0.20.0-beta.1 → 0.20.0-beta.2

2025-06-04 07:14:39 +00:00

README.md

chore: add deprecation warning to vectordb (#2003 )

2025-01-13 14:53:12 -08:00

tsconfig.json

feat: make it easier to create empty tables (#942 )

2024-04-05 16:30:30 -07:00

README.md

LanceDB

A JavaScript / Node.js library for LanceDB.

DEPRECATED: This library is deprecated. Please use the new client, @lancedb/lancedb.

Installation

npm install vectordb

This will download the appropriate native library for your platform. We currently support:

Linux (x86_64 and aarch64)
MacOS (Intel and ARM/M1/M2)
Windows (x86_64 only)

We do not yet support musl-based Linux (such as Alpine Linux) or aarch64 Windows.

Usage

Basic Example

const lancedb = require('vectordb');
const db = await lancedb.connect('data/sample-lancedb');
const table = await db.createTable("my_table",
      [{ id: 1, vector: [0.1, 1.0], item: "foo", price: 10.0 },
      { id: 2, vector: [3.9, 0.5], item: "bar", price: 20.0 }])
const results = await table.search([0.1, 0.3]).limit(20).execute();
console.log(results);

The examples folder contains complete examples.

Development

To build everything fresh:

npm install
npm run build

Then you should be able to run the tests with:

npm test

Fix lints

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