Skip to content

docs(datasets): document schema_inference depth field#1843

Merged
lukekim merged 1 commit into
trunkfrom
docs-schema-inference
Jun 13, 2026
Merged

docs(datasets): document schema_inference depth field#1843
lukekim merged 1 commit into
trunkfrom
docs-schema-inference

Conversation

@claudespice

Copy link
Copy Markdown
Collaborator

Summary

spiceai/spiceai#11284 adds the dataset-level schema_inference field, which controls how deeply the runtime infers source-schema metadata. It was undocumented (only referenced indirectly from the Cayenne accelerator page, which requires schema_inference: extended for adaptive auto-tuning). This adds a reference section in the dataset spec.

Documents both values verified against source:

  • standard (default) — SchemaInference::Standard, base column/type inference only
  • extended — additionally auto-detects primary key, secondary indexes, and sort/clustering columns

Verified against crates/spicepod/src/component/dataset.rs (top-level dataset field, #[serde(rename_all = "snake_case")], default Standard). The field's own doc-comment confirms only the PostgreSQL and MongoDB connectors emit this metadata; other connectors treat extended as a no-op, and it applies to all refresh modes.

Addition → vNext only (website/docs/).

Source PRs

Test plan

  • cd website && npm run build passes
  • Versioned-docs propagation: addition, vNext only — no versioned copies
  • Files updated: 1 (website/docs/reference/spicepod/datasets.md)

@github-actions

github-actions Bot commented Jun 13, 2026

Copy link
Copy Markdown

✅ Pull with Spice Passed

Passing checks:

  • ✅ Title meets minimum length requirement (10 characters)
  • ✅ Has at least one of the required labels: area/blog, area/docs, area/cookbook, dependencies
  • ✅ No banned labels detected
  • ✅ Has at least one assignee: claudespice

1 similar comment
@github-actions

Copy link
Copy Markdown

✅ Pull with Spice Passed

Passing checks:

  • ✅ Title meets minimum length requirement (10 characters)
  • ✅ Has at least one of the required labels: area/blog, area/docs, area/cookbook, dependencies
  • ✅ No banned labels detected
  • ✅ Has at least one assignee: claudespice

@github-actions

Copy link
Copy Markdown

🔍 Pull with Spice Failed

Passing checks:

  • ✅ Title meets minimum length requirement (10 characters)
  • ✅ Has at least one of the required labels: area/blog, area/docs, area/cookbook, dependencies
  • ✅ No banned labels detected

Failed checks:

  • ❌ At least one assignee is required for this pull request.

Please address these issues and update your pull request.

@github-actions

Copy link
Copy Markdown

🚀 deployed to https://8b6e85b9.spiceai-org-website.pages.dev

@lukekim lukekim merged commit 2f2b68f into trunk Jun 13, 2026
8 of 11 checks passed
@lukekim lukekim deleted the docs-schema-inference branch June 13, 2026 16:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants