Start here2 min read

What LanceScope is

A workbench for understanding a LanceDB database — what is in it, why it behaves the way it does, and what every answer cost to get.

It is built around one property of Lance that most tools hide. A Lance table can hold a two-gigabyte video in a Blob V2 column while a search over that table reads kilobytes, because the bytes a search touches and the bytes a table holds are in different files. LanceScope measures both, from Lance's own IO counters, and puts the number next to whatever you just did.

What it does

Reads a database, exactly. Schema, versions, indices, fragments and rows, with the byte cost of each read shown as you go. Describing 2.65 GB of video costs 23.8 KB and opens none of it.

Answers "why is this slow". Run a scalar, full-text, vector or hybrid search, see which access path Lance chose, what it read, and the script that reproduces it elsewhere. Compare two versions of a table and run the same query against both.

Says what it already knows. Seven rules over metadata — an unindexed vector column, small-file counts that would be misleading to act on, tombstone debt — each carrying the numbers it was derived from. No model is involved in any of them.

Adds language, optionally. With a local model or an API key it will translate a question into a filter and describe a table in a few sentences. Every response reports the tokens and dollars it spent beside the bytes it read.

What it does not do

It does not write. No route creates, compacts, restores or deletes anything, and the only file the whole project writes is its own settings file.

It is not a general SQL IDE, an analytics notebook, or an autonomous administrator. Those positions are crowded, and taking one would dilute the only advantage it has: Lance-aware evidence rather than generic metadata.

How these docs are organised

Four kinds of page, because four different questions bring people here.

  • Start here — one path from nothing to a real answer.
  • How to — a specific job, done. Connecting a database, diagnosing a query, enabling the language layer, pointing an agent at it.
  • Reference — precise and complete. Every route, every rule, every setting. These pages are generated from the code, so they cannot drift from it.
  • Why it works this way — the reasoning. Read these when a decision looks odd; most of them are odd for a measured reason.
Choose your path

The guide is arranged by kind — something to follow, something to do, something to look up, something to understand. That is a good way to keep documentation and a poor way to start reading it. Pick what you are here to do and it will be put in an order instead.

Remembered on this machine, changed whenever you like, and it hides nothing — every page stays in the sidebar.