Files
lancedb/docs
Xuanwo e5a5b67212 feat: support nullable scalar Function declarations (#5030)
Function declarations currently reject nullable scalar returns. Accept
`Optional[T]`, `T | None`, and explicit nullable Arrow fields,
preserving `nullable: true` in registration signatures, JSON round
trips, and remote `add_columns` requests.

The Rust planner accepts nullable scalar outputs, and binding readback
recognizes the server-owned assignment marker for a single nullable
scalar result. Clients do not allocate that marker. Non-nullable whole
results, whole structs, and Blob v2 retain their existing assignment
restrictions.

Validated with 127 Python tests, 30 documentation tests (1 skipped), and
seven focused Rust tests covering planning, binding readback, rejection
boundaries, and the remote request body. The final condition-collapse
change addresses strict Clippy; its delta check and CI are pending.
Python tests use a source overlay on a retained native extension, and
Rust remote coverage uses HTTP mocks.

Server support and end-to-end validation remain separate. This PR does
not claim that server publication distinguishes computed NULL values
from pending rows.
2026-11-14 20:59:20 +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