rust/lancedb
1
0
Fork 0
mirror of https://github.com/lancedb/lancedb.git synced 2026-10-13 07:12:27 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
5b5ed930acd8daf607f857346fbff0556db37a16
lancedb/docs/web/docs.json
T
Jack Ye 5b5ed930ac docs: restructure Documentation around one axis, promote the SQL reference 
Every group now answers exactly one question. Get started and Concepts cover
what the system is; the verb groups cover doing something with it; Operate,
Secure and Deploy cover running it; SQL reference is lookup. Maintenance becomes
Operate, Governance becomes Secure, and the rest take verbs to match.

Three new pages in Concepts and Get started:

Guarantees states what a write promises when it returns, which version a reader
sees, what survives a failure, and -- the half usually missing -- what is not
guaranteed: no multi-table transactions, no read-your-writes across processes
without an interval, unenforced primary keys that do not enforce, no background
compaction.

Limits collects bounds that were stated in passing across a dozen pages, with
the numbers verified against the code rather than inferred: name lengths, job
event caps, SHOW ERRORS bounds, the sampling range that is refused rather than
clamped.

Architecture illustrates embedded against distributed as the one deployment
decision, and is written to cover both rather than only Enterprise.

Indexing splits by question. Choosing an index is a Query decision and moves
there; building, repairing and GPU-building it stay in Operate.

SQL becomes a top-level reference of fifteen pages instead of a sub-group of
Query. Auditing sophon-sql turned up a large undocumented surface: ALTER TABLE
ADD COLUMN in its plain, computed and function forms with FILTER, IGNORE NULLS
and OVER modifiers; SET UNENFORCED PRIMARY KEY; SET and UNSET WAL with sharding;
CREATE FUNCTION with its dependency options; REFRESH COLUMN and REFRESH
MATERIALIZED VIEW; and the SHOW family. None of it was written down.
2026-09-13 23:32:15 -07:00

430 lines
12 KiB
JSON
Raw Blame History

{
"$schema": "https://mintlify.com/docs.json",
"appearance": {
"strict": false
},
"theme": "mint",
"name": "LanceDB",
"banner": {
"content": "[Why Multimodal Data Needs a Better Lakehouse? \u2014 Download the Research Study](https://lancedb.com/download/)",
"dismissible": true
},
"colors": {
"primary": "#FF6B35",
"light": "#FF8A5C",
"dark": "#E55A2B"
},
"fonts": {
"family": "Inter"
},
"styling": {
"codeblocks": {
"theme": {
"light": "vitesse-light",
"dark": "catppuccin-mocha"
}
}
},
"favicon": "/static/favicon.ico",
"redirects": [
{
"source": "/tables/update",
"destination": "/ingestion/update"
},
{
"source": "/search/fts-examples",
"destination": "/search/full-text-search"
},
{
"source": "/search/optimize-queries",
"destination": "/search/explain"
},
{
"source": "/lance",
"destination": "/basics/lance"
},
{
"source": "/tables-and-namespaces",
"destination": "/basics/catalog"
},
{
"source": "/catalog",
"destination": "/basics/catalog"
},
{
"source": "/catalog/database",
"destination": "/basics/catalog"
},
{
"source": "/api-reference",
"destination": "/basics/apis"
},
{
"source": "/feature-engineering/computed-columns",
"destination": "/feature-engineering/add-computed-column"
},
{
"source": "/feature-engineering/functions",
"destination": "/management/function"
},
{
"source": "/tables/create",
"destination": "/ingestion"
},
{
"source": "/tables/multimodal",
"destination": "/basics/data-types#blob"
},
{
"source": "/search/select",
"destination": "/sql/select"
},
{
"source": "/tutorials/search",
"destination": "/tutorials/search/hybrid-search-beir"
},
{
"source": "/tutorials/agents",
"destination": "/tutorials/agents/contextual-rag"
},
{
"source": "/tutorials/feature-engineering",
"destination": "/tutorials/feature-engineering/feature-engineering-101"
}
],
"navigation": {
"tabs": [
{
"tab": "Documentation",
"groups": [
{
"group": "Get started",
"pages": [
"index",
"quickstart",
"architecture"
]
},
{
"group": "Concepts",
"pages": [
"basics/lance",
"basics/catalog",
"basics/jobs",
"basics/data-types",
"tables/consistency",
"basics/guarantees",
"basics/limits",
"basics/apis",
"basics/agentic-skills"
]
},
{
"group": "Manage",
"pages": [
"management/index",
"management/database",
{
"group": "Namespace",
"pages": [
"namespaces/index",
"namespaces/usage"
]
},
{
"group": "Table",
"pages": [
"tables/index",
"tables/schema",
"tables/versioning",
"tables/branching"
]
},
"management/materialized-view",
"management/function"
]
},
{
"group": "Ingest",
"pages": [
"ingestion/index",
"ingestion/insert",
"ingestion/merge-insert",
"ingestion/update",
"ingestion/delete"
]
},
{
"group": "Query",
"pages": [
"search/index",
"search/vector-search",
"search/multivector-search",
"search/full-text-search",
"search/hybrid-search",
"search/filtering",
{
"group": "Reranking",
"pages": [
"reranking/index",
"reranking/rrf",
"reranking/linear_combination",
"reranking/mrr",
"reranking/cross_encoder",
"reranking/custom-reranker",
"reranking/eval"
]
},
{
"group": "Indexing",
"pages": [
"indexing/index",
"indexing/vector-index",
"indexing/fts-index",
"indexing/scalar-index",
"indexing/quantization"
]
},
"search/explain",
"search/explain-analyze"
]
},
{
"group": "Feature engineering",
"pages": [
"feature-engineering/index",
"feature-engineering/data-evolution",
"feature-engineering/add-computed-column",
"feature-engineering/refresh-column",
"feature-engineering/materialized-views"
]
},
{
"group": "Train",
"pages": [
"training/why-lancedb",
"training/index",
"training/torch"
]
},
{
"group": "Operate",
"pages": [
"indexing/reindexing",
"maintenance/compaction",
{
"group": "Storage",
"pages": [
"storage/index",
"storage/configuration",
"storage/monitoring"
]
},
"performance"
]
},
{
"group": "SQL reference",
"pages": [
"sql/index",
"sql/data-types",
"sql/select",
"sql/subqueries",
"sql/join",
"sql/aggregation",
"sql/window",
"sql/sampling",
"sql/ddl",
"sql/dml",
"sql/refresh",
"sql/show",
"sql/explain",
"sql/operators",
"sql/functions"
]
},
{
"group": "Support",
"pages": [
"troubleshooting",
{
"group": "FAQ",
"pages": [
"faq/index",
"faq/faq-oss"
]
}
]
}
]
},
{
"tab": "Integrations",
"pages": [
"integrations/index",
{
"group": "Embedding Registry",
"pages": [
"embedding/index",
"embedding/quickstart"
]
},
{
"group": "Embedding Providers",
"pages": [
"integrations/embedding/huggingface",
"integrations/embedding/aws",
"integrations/embedding/cohere",
"integrations/embedding/colpali",
"integrations/embedding/gemini",
"integrations/embedding/ibm",
"integrations/embedding/imagebind",
"integrations/embedding/instructor",
"integrations/embedding/jina",
"integrations/embedding/ollama",
"integrations/embedding/openai",
"integrations/embedding/openclip",
"integrations/embedding/sentence-transformers",
"integrations/embedding/voyageai",
"integrations/embedding/superlinked"
]
},
{
"group": "Rerankers",
"pages": [
"integrations/reranking/answerdotai",
"integrations/reranking/cohere",
"integrations/reranking/colbert",
"integrations/reranking/jina",
"integrations/reranking/openai",
"integrations/reranking/voyageai",
"integrations/reranking/watsonx"
]
},
{
"group": "Data Platforms & Frameworks",
"expanded": true,
"pages": [
"integrations/data/pydantic",
"integrations/data/duckdb",
"integrations/data/pandas_and_pyarrow",
"integrations/data/polars_arrow",
"integrations/data/dlt",
"integrations/data/voxel51"
]
},
{
"group": "AI Platforms & Frameworks",
"expanded": true,
"pages": [
"integrations/ai/agno",
"integrations/ai/hermes-agent",
"integrations/ai/huggingface",
"integrations/ai/langchain",
"integrations/ai/llamaIndex",
"integrations/ai/genkit",
"integrations/ai/kiln",
"integrations/ai/prompttools",
"integrations/ai/synthetic-data-kit"
]
}
]
},
{
"tab": "Use Cases",
"pages": [
"tutorials/index",
{
"group": "General",
"pages": [
"build-with-ai-agents"
]
},
{
"group": "Search",
"pages": [
"tutorials/search/hybrid-search-beir",
"tutorials/search/multivector-xtr",
"tutorials/search/multivector-needle-in-a-haystack",
"tutorials/search/video-search",
"tutorials/search/vector-arithmetic",
"tutorials/search/ner-search",
"tutorials/search/reddit-summarizer"
]
},
{
"group": "RAG",
"pages": [
"tutorials/agents/contextual-rag",
"tutorials/agents/nvidia-rag-blueprint/index",
"tutorials/agents/time-travel-rag/index",
"tutorials/agents/multimodal-agent/index",
"tutorials/agents/matryoshka-embeddings",
"tutorials/agents/hyde",
"tutorials/agents/late-chunking",
"tutorials/agents/agentic-rag"
]
},
{
"group": "Feature Engineering",
"pages": [
"tutorials/feature-engineering/feature-engineering-101",
"tutorials/feature-engineering/materialized-views",
"agent-branch-experiments"
]
},
{
"group": "Training",
"pages": [
"training/object-detection",
"training/vlm-finetuning",
"integrations/stable-worldmodel"
]
}
]
},
{
"tab": "Demos",
"pages": [
"demos/index",
"demos/semantic-art",
"demos/wikipedia-search",
"demos/video-search"
]
}
]
},
"logo": {
"light": "/static/assets/logo/dark-lancedb-logo.svg",
"dark": "/static/assets/logo/light-lancedb-logo.svg",
"href": "https://lancedb.com"
},
"background": {
"color": {
"light": "#FAF5F0",
"dark": "#000000"
}
},
"navbar": {
"links": [
{
"label": "Support",
"href": "mailto:contact@lancedb.com"
}
]
},
"footer": {
"socials": {
"github": "https://github.com/lancedb",
"linkedin": "https://www.linkedin.com/company/lancedb",
"x": "https://x.com/lancedb",
"discord": "https://discord.gg/AUEWnJ7Txb"
}
},
"integrations": {
"ga4": {
"measurementId": "G-1TMC2PR69E"
}
}
}
Reference in New Issue View Git Blame Copy Permalink