mirror of https://github.com/lancedb/lancedb.git synced 2026-10-13 15:22:30 +00:00

Files

T

Daniel RammerandClaude Opus 5.5 d7e921dbec refactor!: rename the LSM table APIs to MemWAL

The write path these APIs drive is Lance's MemWAL, and "LSM" described
its shape rather than naming it. The surface now says MemWAL, and turning
it on and off reads as enabling a feature rather than installing a spec.

| Before | After |
|---|---|
| `set_lsm_write_spec` | `enable_memwal` |
| `unset_lsm_write_spec` | `disable_memwal` |
| `get_lsm_write_spec` | `get_memwal_spec` |
| `flush_lsm` / `compact_lsm` / `checkpoint_lsm` | `flush_memwal` / `compact_memwal` / `checkpoint_memwal` |
| `get_lsm_stats` | `get_memwal_stats` |
| `close_lsm_writers` | `close_memwal_writers` |
| `use_lsm` (query, merge insert) | `use_memwal` |
| `LsmWriteSpec` / `LsmStats` | `MemWalWriteSpec` / `MemWalStats` |
| Java `LanceDbTableLsm` | `LanceDbTableMemWal` |

TypeScript and Java use camelCase (`enableMemWal`, `getMemWalStats`,
...); the napi methods set `js_name` so the generated names keep the
`MemWal` casing. The flush/compact/checkpoint methods keep a `_memwal`
suffix so `compact_memwal` is not confused with `compact_files` and
`optimize`, which compact the base table.

## Wire

The remote routes and JSON envelopes move with the SDKs and must ship
together with the matching server change:

- `/set_lsm_write_spec/` -> `/enable_memwal/`, `/unset_lsm_write_spec/`
  -> `/disable_memwal/`, `/get_lsm_write_spec/` -> `/get_memwal_spec/`,
  `/flush_lsm/`, `/compact_lsm/`, `/get_lsm_stats/` -> `*_memwal/`
- response keys `lsm_write_spec` -> `memwal_spec`, `lsm_stats` ->
  `memwal_stats`; query and merge-insert body field `use_lsm` ->
  `use_memwal`

## Also fixed

The previous rename turned the Java `bucket` sharding mode into
`tableShard` in the javadoc example and tests, and the test fixtures
sent `tableShards` where the parser reads `table_shards`, so the Java
tests did not compile. Both are restored.

Internal names (`LsmMode`, `LsmScanner`, the `merge::lsm` and
`query::lsm` modules) are unchanged.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>

2026-10-12 15:54:03 -05:00

_media

docs(python): fill gaps in the Python API reference (#3746 )

2026-07-30 16:50:05 -07:00

classes

refactor!: rename the LSM table APIs to MemWAL

2026-10-12 15:54:03 -05:00

enumerations

feat: use oauth2 crate for OAuth with configurable client auth (#4181 )

2026-09-16 20:11:08 +08:00

functions

feat!: list_databases returns an iterator (#4442 )

2026-10-05 19:41:53 -07:00

interfaces

refactor!: rename the LSM table APIs to MemWAL

2026-10-12 15:54:03 -05:00

namespaces

fix(node): update arrow to 21 (#4362 )

2026-10-02 15:56:46 -05:00

type-aliases

fix(node): accept code as a base tokenizer (#4368 )

2026-10-08 19:46:02 -07:00

globals.md

refactor!: rename the LSM table APIs to MemWAL

2026-10-12 15:54:03 -05:00

README.md

docs: fix broken documentation links (#3278 )

2026-04-15 20:56:59 +08:00

README.md

@lancedb/lancedb • Docs

LanceDB JavaScript SDK

A JavaScript library for LanceDB.

Installation

npm install @lancedb/lancedb

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

Linux (x86_64 and aarch64 on glibc and musl)
MacOS (Intel and ARM/M1/M2)
Windows (x86_64 and aarch64)

Usage

Basic Example

import * as lancedb from "@lancedb/lancedb";
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.vectorSearch([0.1, 0.3]).limit(20).toArray();
console.log(results);

The quickstart contains more complete examples.

Development

See CONTRIBUTING.md for information on how to contribute to LanceDB.