docs(duckdb): correct connector memory/spill guidance (no connection-string channel)#1935
Open
claudespice wants to merge 1 commit into
Open
docs(duckdb): correct connector memory/spill guidance (no connection-string channel)#1935claudespice wants to merge 1 commit into
claudespice wants to merge 1 commit into
Conversation
Contributor
✅ Pull with Spice PassedPassing checks:
|
Contributor
|
🚀 deployed to https://28831e61.spiceai-org-website.pages.dev |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The DuckDB data connector deployment guide told users, in the Capacity & Sizing section, to configure DuckDB via a channel the connector does not expose:
memory_limitpragma via the connection string"temp_directoryto a fast local volume"Neither is actionable. The DuckDB connector exposes exactly one parameter —
duckdb_open(a file path or:memory:) — and opens the database read-only. There is no connection-string input, nomemory_limitparameter, and notemp_directory/pragma channel. This is the same fabricated-mechanism class as the DuckDB/SQLite accelerator guides fixed in #1906; the connector guide was the latent second occurrence.This corrects both bullets to describe DuckDB's actual (self-managed, internal) behavior and points readers to the DuckDB accelerator, which really does expose a configurable
duckdb_memory_limitacceleration parameter, when they need a Spice-configurable limit.Verified against code (spiceai/spiceai)
open, opened read-only:crates/data-connectors/connector-duckdb/src/lib.rs:162(const PARAMETERS: &[ParameterSpec] = &[ParameterSpec::component("open")...]); no connection-string / pragma parsing.open-only atv2.1.0andv2.0.1.duckdb_memory_limitexists (crates/runtime/src/dataaccelerator/duckdb.rs:418,ParameterSpec::component("memory_limit")) — present atv2.1.0too — so the cross-reference is accurate.The identical wrong text lived in vNext +
version-2.1.x+version-2.0.x(correction predates versioning), so all three are fixed here.Test plan
cd website && npm run buildpasses (DocusaurusonBrokenLinks: 'throw'; the added../../data-accelerators/duckdblink resolves — same path already used in the page's Known Limitations section, target confirmed present in each versioned tree)