mirror of
https://github.com/lancedb/lancedb.git
synced 2026-11-21 18:13:57 +00:00
## Summary - **Define Storage Integration**: un-gates the Python (and Rust, for S3) `create_storage_integration` examples, drafted against #4618 and held back until it shipped -- it's now in v0.42.0-beta.0+, and the signature matches the drafts exactly. - **Naming rules**: drops the `Branch` row and its "Learn more" link, consistent with de-emphasizing branches elsewhere in this nav. - **Distributed RTE Write**: removes the REST path, the `__lance_mem_wal` index name, and "WAL node" terminology in favor of an abstract framing -- a query node routes writes to RTE nodes, each of which can host shards from many different tables. Both diagram variants are updated to match. - **Data Page Cache / Tiered Index Cache / Cache Prewarm**: drop Helm-specific and exact-percentage detail (disk-budget math, `startup_prewarm_block_query_ready`/`healthPort`/failure-policy table) in favor of a short feature → architecture → why-it-matters shape, each closing with a contact-sales pointer. Data Page Cache's on-demand prewarm section is removed outright. ## Note I wasn't able to get a clean visual render of the updated Distributed RTE Write diagram in local preview -- Mermaid isn't rendering in headless Chrome in this environment for *any* page right now, confirmed against an unmodified reference page showing the identical symptom. The diagram source follows the exact pattern already shipped and working in the 21 diagrams from the earlier brand-theming pass, and `mint validate`/`mint broken-links` both pass clean. --------- Co-authored-by: Claude Sonnet 5 <noreply@anthropic.com>
88 lines
3.7 KiB
Plaintext
88 lines
3.7 KiB
Plaintext
---
|
|
title: "Cache Prewarm"
|
|
sidebarTitle: "Cache Prewarm"
|
|
description: "Populate the tiered index cache ahead of a request, instead of filling it lazily on first read."
|
|
icon: "fire"
|
|
keywords: ["prewarm", "cache", "index cache", "startup"]
|
|
availability:
|
|
embedded: unavailable
|
|
enterprise: available
|
|
---
|
|
|
|
Cache Prewarm loads the [tiered index cache](/enterprise/tiered-index-cache)
|
|
a plan executor keeps as part of Enterprise's serving layer, instead of
|
|
leaving it to fill lazily on first read. You configure which tables to
|
|
prewarm; on startup, each plan executor loads those tables' indexes into
|
|
cache before it joins the fleet. The executor does not accept queries until
|
|
prewarming finishes, so it never serves a request against a cold cache.
|
|
|
|
LanceDB Embedded has no such cache, so there is nothing for it to warm
|
|
there. Embedded does have its own, separate `prewarm_index()` on a table --
|
|
an idempotent hint that loads a built index into memory ahead of a query.
|
|
|
|
<div className="hidden dark:block">
|
|
|
|
```mermaid
|
|
%%{init: {"theme": "base", "themeVariables": {
|
|
"background": "#171513", "primaryColor": "#1e1b19", "primaryTextColor": "#f4ebe8",
|
|
"primaryBorderColor": "#4c443f", "lineColor": "#847770", "textColor": "#f4ebe8",
|
|
"edgeLabelBackground": "#171513", "fontFamily": "Inter, sans-serif", "fontSize": "18px"
|
|
}}}%%
|
|
flowchart LR
|
|
List[("Configured list<br/>of tables to prewarm")]
|
|
Start["Plan executor starts<br/>(not ready — no queries served)"] --> Warm["Loads the configured<br/>tables' indexes into cache"]
|
|
List -.-> Warm
|
|
Warm --> Ready["Ready — joins the fleet,<br/>starts serving queries"]
|
|
classDef default fill:#1e1b19,stroke:#4c443f,stroke-width:1px,color:#f4ebe8
|
|
classDef accent fill:#2a1810,stroke:#e8582d,stroke-width:1.5px,color:#f4ebe8
|
|
class Warm,List accent
|
|
```
|
|
|
|
</div>
|
|
|
|
<div className="block dark:hidden">
|
|
|
|
```mermaid
|
|
%%{init: {"theme": "base", "themeVariables": {
|
|
"background": "#ffffff", "primaryColor": "#ffffff", "primaryTextColor": "#221d19",
|
|
"primaryBorderColor": "#ad9e95", "lineColor": "#6b625c", "textColor": "#221d19",
|
|
"edgeLabelBackground": "#ffffff", "fontFamily": "Inter, sans-serif", "fontSize": "18px"
|
|
}}}%%
|
|
flowchart LR
|
|
List[("Configured list<br/>of tables to prewarm")]
|
|
Start["Plan executor starts<br/>(not ready — no queries served)"] --> Warm["Loads the configured<br/>tables' indexes into cache"]
|
|
List -.-> Warm
|
|
Warm --> Ready["Ready — joins the fleet,<br/>starts serving queries"]
|
|
classDef default fill:#ffffff,stroke:#ad9e95,stroke-width:1px,color:#221d19
|
|
classDef accent fill:#fff1ec,stroke:#e8582d,stroke-width:1.5px,color:#221d19
|
|
class Warm,List accent
|
|
```
|
|
|
|
</div>
|
|
|
|
## Why it matters {#why-it-matters}
|
|
|
|
Without prewarming, a fresh or restarted executor would fill its indexes
|
|
lazily, so the first queries it serves pay the cost of loading and
|
|
deserializing them from object storage. Holding the executor out of the
|
|
fleet until its configured tables are warm means every query it ever
|
|
serves gets a warm cache, so performance stays consistent through restarts
|
|
and rollouts instead of dipping right after each one.
|
|
|
|
[Contact us](https://www.lancedb.com/contact) to learn more about how
|
|
prewarming is configured for your deployment.
|
|
|
|
## What to read next {#next}
|
|
|
|
<CardGroup cols={2}>
|
|
<Card title="Data Page Cache" icon="database" href="/enterprise/data-page-cache">
|
|
The raw-data-page cache -- a separate cache from the one prewarm fills.
|
|
</Card>
|
|
<Card title="Tiered Index Cache" icon="layer-group" href="/enterprise/tiered-index-cache">
|
|
The deserialized-index cache prewarm fills.
|
|
</Card>
|
|
<Card title="Architecture" icon="diagram-project" href="/index#architecture">
|
|
Where plan executors and query nodes sit in the serving fleet.
|
|
</Card>
|
|
</CardGroup>
|