mirror of
https://github.com/lancedb/lancedb.git
synced 2026-10-13 07:12:27 +00:00
Jack Ye
cb45b67c4c
Indexing loses its wrapper group -- Overview, Vector Index, FTS Index, Scalar Index and Build & Repair sit directly in Maintenance now, followed by Compaction, Cleanup and Background Jobs at the same level. Cleanup is new, split out of Compaction: pruning old versions is a distinct Enterprise job (cleanup) from merging files (compact), even though optimize() in OSS bundles both into one call. The retention, disk-usage and failed-transaction material that used to live under Compaction's umbrella moves with it. Background Jobs is new and covers what nothing else does: the job types a deployment runs on its own -- WAL/SPFresh maintenance, cache prewarming, registry archiving and metering export, and the object-teardown job that follows a namespace or view drop. Every entry is grounded against the job-coordinator's public job_type constants, not the internal two-letter wire codes used for registry storage. Five existing pages (Build & Repair, Table, Function, Column Refresh, Materialized View Refresh) gain a one-line job-type note rather than duplicating a page for job types they already document. Storage folds into Deployment: storage/index (choosing a backend) and storage/configuration (configuring one) merge into a single Storage page -- they never overlapped, one is the decision and one is the how-to -- and move under Deployment along with Monitoring. Cloud Providers loses its nesting; its two pages plus Azure sit flat, and the former Overview is retitled Deployment Models so it doesn't collide with the group's own Overview entry. Redirects cover every moved URL.
505 lines
13 KiB
JSON
505 lines
13 KiB
JSON
{
|
|
"$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": "/management/table#multimodal"
|
|
},
|
|
{
|
|
"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"
|
|
},
|
|
{
|
|
"source": "/tables",
|
|
"destination": "/management/table"
|
|
},
|
|
{
|
|
"source": "/namespaces",
|
|
"destination": "/management/namespace"
|
|
},
|
|
{
|
|
"source": "/namespaces/usage",
|
|
"destination": "/management/namespace"
|
|
},
|
|
{
|
|
"source": "/basics/data-types",
|
|
"destination": "/sql/data-types"
|
|
},
|
|
{
|
|
"source": "/tables/schema",
|
|
"destination": "/management/table#schema"
|
|
},
|
|
{
|
|
"source": "/tables/versioning",
|
|
"destination": "/management/table#versioning"
|
|
},
|
|
{
|
|
"source": "/search/multivector-search",
|
|
"destination": "/search/vector-search"
|
|
},
|
|
{
|
|
"source": "/search/explain-analyze",
|
|
"destination": "/search/explain"
|
|
},
|
|
{
|
|
"source": "/indexing/quantization",
|
|
"destination": "/indexing/vector-index"
|
|
},
|
|
{
|
|
"source": "/performance",
|
|
"destination": "/search#performance"
|
|
},
|
|
{
|
|
"source": "/reranking/:slug*",
|
|
"destination": "/reranking"
|
|
},
|
|
{
|
|
"source": "/training",
|
|
"destination": "/training/data-loading"
|
|
},
|
|
{
|
|
"source": "/build-with-ai-agents",
|
|
"destination": "/basics/agentic-skills"
|
|
},
|
|
{
|
|
"source": "/core/update",
|
|
"destination": "/ingestion/update"
|
|
},
|
|
{
|
|
"source": "/storage",
|
|
"destination": "/deployment/storage"
|
|
},
|
|
{
|
|
"source": "/storage/configuration",
|
|
"destination": "/deployment/storage"
|
|
},
|
|
{
|
|
"source": "/storage/monitoring",
|
|
"destination": "/deployment/monitoring"
|
|
},
|
|
{
|
|
"source": "/enterprise/deployment",
|
|
"destination": "/enterprise/deployment/index"
|
|
}
|
|
],
|
|
"navigation": {
|
|
"tabs": [
|
|
{
|
|
"tab": "Documentation",
|
|
"groups": [
|
|
{
|
|
"group": "Getting Started",
|
|
"pages": [
|
|
"index",
|
|
"quickstart",
|
|
"architecture",
|
|
"basics/agentic-skills"
|
|
]
|
|
},
|
|
{
|
|
"group": "Concepts",
|
|
"pages": [
|
|
"basics/lance",
|
|
"basics/catalog",
|
|
"basics/lakehouse",
|
|
"basics/query",
|
|
"basics/jobs",
|
|
"tables/consistency",
|
|
"basics/guarantees",
|
|
"basics/limits",
|
|
"basics/apis"
|
|
]
|
|
},
|
|
{
|
|
"group": "Data Ingestion",
|
|
"pages": [
|
|
"ingestion/index",
|
|
"ingestion/create-table",
|
|
"ingestion/insert",
|
|
"ingestion/merge-insert",
|
|
"ingestion/update",
|
|
"ingestion/delete"
|
|
]
|
|
},
|
|
{
|
|
"group": "Semantic Search",
|
|
"pages": [
|
|
"search/index",
|
|
"search/vector-search",
|
|
"search/full-text-search",
|
|
"search/hybrid-search",
|
|
"search/filtering",
|
|
"reranking/index",
|
|
"search/explain"
|
|
]
|
|
},
|
|
{
|
|
"group": "Data Curation",
|
|
"pages": [
|
|
"curation/index",
|
|
"curation/aggregate",
|
|
"curation/sampling",
|
|
"curation/join",
|
|
"curation/windowing"
|
|
]
|
|
},
|
|
{
|
|
"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": "Training",
|
|
"pages": [
|
|
"training/why-lancedb",
|
|
"training/data-loading",
|
|
"training/torch"
|
|
]
|
|
},
|
|
{
|
|
"group": "Management",
|
|
"pages": [
|
|
"management/index",
|
|
"management/database",
|
|
"management/namespace",
|
|
"management/table",
|
|
"tables/branching",
|
|
"management/materialized-view",
|
|
"management/view",
|
|
"management/function"
|
|
]
|
|
},
|
|
{
|
|
"group": "Maintenance",
|
|
"pages": [
|
|
"indexing/index",
|
|
"indexing/vector-index",
|
|
"indexing/fts-index",
|
|
"indexing/scalar-index",
|
|
"indexing/reindexing",
|
|
"maintenance/compaction",
|
|
"maintenance/cleanup",
|
|
"maintenance/background-jobs"
|
|
]
|
|
},
|
|
{
|
|
"group": "Security",
|
|
"pages": [
|
|
"enterprise/authentication",
|
|
"governance/authorization",
|
|
"enterprise/security"
|
|
]
|
|
},
|
|
{
|
|
"group": "Deployment",
|
|
"pages": [
|
|
"enterprise/index",
|
|
"enterprise/architecture",
|
|
"enterprise/deployment/index",
|
|
"deployment/storage",
|
|
"deployment/monitoring",
|
|
"enterprise/deployment/azure",
|
|
"enterprise/benchmarks"
|
|
]
|
|
},
|
|
{
|
|
"group": "SQL Reference",
|
|
"pages": [
|
|
"sql/index",
|
|
"search/sql/index",
|
|
"sql/data-types",
|
|
"sql/select",
|
|
"search/sql/fts-sql",
|
|
"sql/subqueries",
|
|
"sql/join",
|
|
"sql/aggregation",
|
|
"sql/window",
|
|
"sql/sampling",
|
|
"sql/ddl",
|
|
"sql/dml",
|
|
"sql/refresh",
|
|
"sql/show",
|
|
"sql/explain",
|
|
"sql/prepared-statements",
|
|
"sql/operators",
|
|
"sql/functions",
|
|
"sql/scalar-functions"
|
|
]
|
|
},
|
|
{
|
|
"group": "Support",
|
|
"pages": [
|
|
"troubleshooting",
|
|
{
|
|
"group": "FAQ",
|
|
"pages": [
|
|
"faq/index",
|
|
"faq/faq-oss",
|
|
"faq/faq-enterprise"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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": "Tutorials",
|
|
"pages": [
|
|
"tutorials/index",
|
|
{
|
|
"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"
|
|
},
|
|
"links": [
|
|
{
|
|
"items": [
|
|
{
|
|
"label": "Cookie settings",
|
|
"href": "#cookie-settings"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"integrations": {
|
|
"ga4": {
|
|
"measurementId": "G-1TMC2PR69E"
|
|
}
|
|
}
|
|
}
|