Files
lancedb/docs
Xuanwo 2f496322ef fix: report multipart rows only after part acknowledgement (#5020)
Remote multipart progress currently counts every scanned row before the
corresponding IPC part is acknowledged. A rejected first part can
therefore report uploaded rows, even though its acknowledged byte count
remains zero.

Count both rows and IPC bytes only after each part succeeds, including
parts assembled from multiple batches or split from one batch. Retried
parts count once. Native and single-request writes retain their existing
accounting; acknowledged multipart progress describes staged data, not a
successful commit.

Validation follows the actual TCP upload path: one scanned batch becomes
six decoded IPC parts, the sixth response is lost, and each
request/retry observes only previously acknowledged rows and bytes.
Rejection and complete-outcome cases preserve the same accounting
boundary. This validation covers local HTTP behavior; deployed service
throughput and the original disconnect investigation remain outside its
scope.


Frozen candidate validation: 839 remote tests and 7 progress tests
passed. Scoped Clippy (`lancedb`, remote feature, lib/tests/examples,
warnings denied) passed with unchanged source. Python/Node bindings were
unchanged and were not rebuilt for this patch.
2026-11-14 20:51:25 +08:00
..

LanceDB Documentation

For website guides in docs/web, start with Documentation in CONTRIBUTING.md. That covers editing pages, generated examples, previews, availability and drafts.

This page covers the SDK reference in docs/src, built with MkDocs. Its GitHub Actions workflow builds and deploys on pushes to main, so it can include unreleased APIs. That is separate from the release editions of the Mintlify website.

Building the docs

Setup

  1. Install LanceDB Python. See setup in Python contributing guide. Run make develop to install the Python package.
  2. Install documentation dependencies. From LanceDB repo root: pip install -r docs/requirements.txt

Preview the docs

Run these commands from the LanceDB repository root. The subshell changes into docs to load mkdocs.yml, while leaving your shell in the repository root.

(cd docs && PYTHONPATH=. mkdocs serve)

If you want to just generate the HTML files:

(cd docs && PYTHONPATH=. mkdocs build)

If successful, you should see a docs/site directory in the repository root that you can verify locally.

Adding examples

To make sure examples are correct, we put examples in test files so they can be run as part of our test suites.

You can see the tests are at:

  • Python: python/python/tests/docs
  • Typescript: nodejs/examples/

Checking python examples

cd python
pytest -vv python/tests/docs

Checking typescript examples

The examples depend on @lancedb/lancedb at file:../dist, so the package must be built before running the tests. This uses pnpm; see the Typescript contributing guide for the toolchain setup.

pushd nodejs
pnpm install
pnpm build
popd

Then you can run the examples by going to the nodejs/examples directory, which is a separate pnpm package with its own lockfile:

pushd nodejs/examples
pnpm install
pnpm test
popd

API documentation

Python

The Python API documentation is organized based on the file docs/src/python/python.md. We manually add entries there so we can control the organization of the reference page. However, this means any new types must be manually added to the file. No additional steps are needed to generate the API documentation.

Typescript

The typescript API documentation is generated from the typescript source code using typedoc.

When new APIs are added, you must manually re-run the typedoc command to update the API documentation. The new files should be checked into the repository.

pushd nodejs
# `pnpm docs` would invoke pnpm's built-in `docs` command, not the script.
pnpm run docs
popd