docs(task_history): the acceleration refresh task is acceleration_refresh
Eighteen deployment guides (and their 2.0.x-2.3.x snapshots) told readers to
correlate object reads and accelerator spans with a task named
accelerated_table_refresh. No release has ever recorded that name: the refresh
span is declared as "acceleration_refresh" in the accelerated-table refresh
task, and the task column is the span name unless a task_override label is
present.
The name a reader pastes into a task_history query has to match exactly, so a
fabricated one returns no rows. cli/reference/trace.md already carried the
correct name on these same snapshots.
a month ago
docs: publish v2.3.0 documentation and release notes (#2192)
* Add versioned docs for v2.3
* docs: publish v2.3.0 release notes and announcement
* docs: remove the temporary local build configuration
* docs: limit the LLM bundle to the latest released version
---------
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Phillip LeBlanc <879445+phillipleblanc@users.noreply.github.com>
a month ago
docs(task_history): the acceleration refresh task is acceleration_refresh
Eighteen deployment guides (and their 2.0.x-2.3.x snapshots) told readers to
correlate object reads and accelerator spans with a task named
accelerated_table_refresh. No release has ever recorded that name: the refresh
span is declared as "acceleration_refresh" in the accelerated-table refresh
task, and the task column is the span name unless a task_override label is
present.
The name a reader pastes into a task_history query has to match exactly, so a
fabricated one returns no rows. cli/reference/trace.md already carried the
correct name on these same snapshots.
a month ago
docs(dremio): dataset paths are not limited to three levels of nesting
17 days ago
docs: publish v2.3.0 documentation and release notes (#2192)
* Add versioned docs for v2.3
* docs: publish v2.3.0 release notes and announcement
* docs: remove the temporary local build configuration
* docs: limit the LLM bundle to the latest released version
---------
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Phillip LeBlanc <879445+phillipleblanc@users.noreply.github.com>
a month ago
docs(task_history): the acceleration refresh task is acceleration_refresh
Eighteen deployment guides (and their 2.0.x-2.3.x snapshots) told readers to
correlate object reads and accelerator spans with a task named
accelerated_table_refresh. No release has ever recorded that name: the refresh
span is declared as "acceleration_refresh" in the accelerated-table refresh
task, and the task column is the span name unless a task_override label is
present.
The name a reader pastes into a task_history query has to match exactly, so a
fabricated one returns no rows. cli/reference/trace.md already carried the
correct name on these same snapshots.
a month ago
docs(task_history): the acceleration refresh task is acceleration_refresh
Eighteen deployment guides (and their 2.0.x-2.3.x snapshots) told readers to
correlate object reads and accelerator spans with a task named
accelerated_table_refresh. No release has ever recorded that name: the refresh
span is declared as "acceleration_refresh" in the accelerated-table refresh
task, and the task column is the span name unless a task_override label is
present.
The name a reader pastes into a task_history query has to match exactly, so a
fabricated one returns no rows. cli/reference/trace.md already carried the
correct name on these same snapshots.
a month ago
docs(task_history): the acceleration refresh task is acceleration_refresh
Eighteen deployment guides (and their 2.0.x-2.3.x snapshots) told readers to
correlate object reads and accelerator spans with a task named
accelerated_table_refresh. No release has ever recorded that name: the refresh
span is declared as "acceleration_refresh" in the accelerated-table refresh
task, and the task column is the span name unless a task_override label is
present.
The name a reader pastes into a task_history query has to match exactly, so a
fabricated one returns no rows. cli/reference/trace.md already carried the
correct name on these same snapshots.
a month ago
docs(github): default concurrent connections limit is 4 (#2279)
16 days ago
docs(task_history): the acceleration refresh task is acceleration_refresh
Eighteen deployment guides (and their 2.0.x-2.3.x snapshots) told readers to
correlate object reads and accelerator spans with a task named
accelerated_table_refresh. No release has ever recorded that name: the refresh
span is declared as "acceleration_refresh" in the accelerated-table refresh
task, and the task column is the span name unless a task_override label is
present.
The name a reader pastes into a task_history query has to match exactly, so a
fabricated one returns no rows. cli/reference/trace.md already carried the
correct name on these same snapshots.
a month ago
Document snapshot copies, snapshot storage, and origin-first HTTP caching (#2286)
* docs: explain snapshot copies, snapshot storage, and origin-first caching
Acceleration snapshots are full copies on standard object storage, separate from Cayenne S3 Express One Zone. HTTP caching with a zero TTL serves the accelerator only after the origin fails.
Co-authored-by: Luke Kim <lukekim@users.noreply.github.com>
* docs: fix the snapshots link on the Spicepod reference and quote zero cache durations as 0s
The Spicepod reference linked ../../features/data-acceleration/snapshots
from reference/spicepod/index.md, one ../ too many for an index page.
The 2.3.x build failed on it, and trunk resolved to the 2.3.x page.
A bare caching_ttl: 0 is a YAML integer, and the runtime rejects it:
Invalid 'caching_ttl' param value: Int(0). Expected a duration string.
Write the zero durations in the origin-first examples as 0s.
* docs: scope origin-first caching to the accelerator and keep the cold tier on S3
The SQL results cache answers an identical query within its 1s item_ttl,
including a fallback served during an outage, before the request reaches
the accelerator or the origin. Say so on the caching-mode and read-through
pages, with Cache-Control: no-cache and sql_results.enabled: false as the
ways to send every query to the origin. An accelerated HTTP dataset skips
the connector's response cache, so origin max-age plays no part.
The Cayenne cold tier takes only a general-purpose S3 or S3-compatible
bucket. The performance-tuning summary row and three nearby sentences
grouped it with the GCS and ADLS snapshot backends.
---------
Co-authored-by: Cursor Agent <cursoragent@cursor.com>
Co-authored-by: Luke Kim <lukekim@users.noreply.github.com>
8 days ago
docs: publish v2.3.0 documentation and release notes (#2192)
* Add versioned docs for v2.3
* docs: publish v2.3.0 release notes and announcement
* docs: remove the temporary local build configuration
* docs: limit the LLM bundle to the latest released version
---------
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Phillip LeBlanc <879445+phillipleblanc@users.noreply.github.com>
a month ago
docs: Sync the cookbook page and recipe links with spiceai/cookbook (#2318)
* Sync the cookbook page with the current spiceai/cookbook recipes
List all 122 current recipes (up from 79) and leave out evals, llm-judge, and websearch, which the cookbook marks deprecated in v2.0+.
- Correct entries that pointed at the wrong recipe or described an old version: Results Caching linked the Caching Accelerator recipe, Nvidia NIM on Kubernetes linked the EC2 recipe, Hashed Partitioning now uses Cayenne, and Federated SQL Query no longer uses Dremio.
- Add the missing recipes, including Cayenne, async queries, native PostgreSQL/MySQL/MongoDB CDC, DynamoDB Streams, HTTP, Redshift, ScyllaDB, SMB, the catalog connectors, full-text search, distributed query, and Spice as an MCP server.
- Add Change Data Capture and Advanced Topics sections. Local Dataset Replication was tagged for no rendered section, so it never appeared.
- Show guides in Sample Applications and Guides instead of Security.
- Align Core Features with the cookbook's core scenarios and feature Cayenne as the data accelerator.
- Label recipes that need Spice.ai Enterprise.
- Remove forbidden words (enhance, leverage, utilize, robust) from section intros.
* Fix broken and stale cookbook recipe references across doc versions
Every version links to the recipes on cookbook trunk, so these corrections apply to each version that carries them.
- Query Federation: replace the walkthrough with the current Federated SQL Query recipe, which joins NYC taxi trips in S3 with taxi zones in PostgreSQL. The old walkthrough logged in to a demo Dremio, ran 'spice add spiceai/fed-demo' (that Spicepod no longer exists on Spicerack), and ran 'cd demo' twice. The new steps and output come from a run of the recipe on Spice v2.3.2.
- FAQ: the RAG recipe link (cookbook/tree/trunk/rag) never existed; link the RAG use-case page instead.
- Use cases: fix duckdb/accelerator/README and federation/README links that were missing the .md extension.
- PostgreSQL connector: link the connector recipe instead of the accelerator recipe, and fix 'configure Supabase a data connector'.
- ODBC connector: the recipe now connects to MySQL with the MariaDB driver, not Postgres.
- Glue catalog connector: its recipe configures the Glue Catalog Connector, not the Data Connector.
- Release notes: fix three recipe links that pointed at moved or malformed paths.
* Link docs pages to their cookbook recipes
49 cookbook recipes had no link from any docs page. Add a Cookbook section, or a bullet in an existing one, on the matching page in vNext and 2.3.x. Covered pages include CDC (PostgreSQL, MySQL, Aurora MySQL, MongoDB), the catalog connectors (DuckLake, MySQL, SQL Server, Unity Catalog, Databricks, Iceberg Hadoop, PostgreSQL CDC), acceleration (partitioning, snapshots, indexes, constraints, views, caching, cron refresh, dual-dataset registration), search, distributed query and async queries, MCP, LLM memory, text-to-SQL, the ai() function, models (OpenAI, DeepSeek, filesystem, xAI, NVIDIA NIM on Kubernetes), API keys, ADBC, JDBC, the SDKs, and Cloud Connect. The sidecar and microservice architecture partials, which every version shares, link their recipes too.
Related updates:
- The docs landing page lists Cayenne among the accelerators and links the Cayenne recipe.
- The Cayenne Transactions intro also covers tables configured for durable write-back, matching the section's own requirements.
- The FAQ says the cookbook has over 120 recipes, up from over 65.
docs: Sync the cookbook page and recipe links with spiceai/cookbook (#2318)
* Sync the cookbook page with the current spiceai/cookbook recipes
List all 122 current recipes (up from 79) and leave out evals, llm-judge, and websearch, which the cookbook marks deprecated in v2.0+.
- Correct entries that pointed at the wrong recipe or described an old version: Results Caching linked the Caching Accelerator recipe, Nvidia NIM on Kubernetes linked the EC2 recipe, Hashed Partitioning now uses Cayenne, and Federated SQL Query no longer uses Dremio.
- Add the missing recipes, including Cayenne, async queries, native PostgreSQL/MySQL/MongoDB CDC, DynamoDB Streams, HTTP, Redshift, ScyllaDB, SMB, the catalog connectors, full-text search, distributed query, and Spice as an MCP server.
- Add Change Data Capture and Advanced Topics sections. Local Dataset Replication was tagged for no rendered section, so it never appeared.
- Show guides in Sample Applications and Guides instead of Security.
- Align Core Features with the cookbook's core scenarios and feature Cayenne as the data accelerator.
- Label recipes that need Spice.ai Enterprise.
- Remove forbidden words (enhance, leverage, utilize, robust) from section intros.
* Fix broken and stale cookbook recipe references across doc versions
Every version links to the recipes on cookbook trunk, so these corrections apply to each version that carries them.
- Query Federation: replace the walkthrough with the current Federated SQL Query recipe, which joins NYC taxi trips in S3 with taxi zones in PostgreSQL. The old walkthrough logged in to a demo Dremio, ran 'spice add spiceai/fed-demo' (that Spicepod no longer exists on Spicerack), and ran 'cd demo' twice. The new steps and output come from a run of the recipe on Spice v2.3.2.
- FAQ: the RAG recipe link (cookbook/tree/trunk/rag) never existed; link the RAG use-case page instead.
- Use cases: fix duckdb/accelerator/README and federation/README links that were missing the .md extension.
- PostgreSQL connector: link the connector recipe instead of the accelerator recipe, and fix 'configure Supabase a data connector'.
- ODBC connector: the recipe now connects to MySQL with the MariaDB driver, not Postgres.
- Glue catalog connector: its recipe configures the Glue Catalog Connector, not the Data Connector.
- Release notes: fix three recipe links that pointed at moved or malformed paths.
* Link docs pages to their cookbook recipes
49 cookbook recipes had no link from any docs page. Add a Cookbook section, or a bullet in an existing one, on the matching page in vNext and 2.3.x. Covered pages include CDC (PostgreSQL, MySQL, Aurora MySQL, MongoDB), the catalog connectors (DuckLake, MySQL, SQL Server, Unity Catalog, Databricks, Iceberg Hadoop, PostgreSQL CDC), acceleration (partitioning, snapshots, indexes, constraints, views, caching, cron refresh, dual-dataset registration), search, distributed query and async queries, MCP, LLM memory, text-to-SQL, the ai() function, models (OpenAI, DeepSeek, filesystem, xAI, NVIDIA NIM on Kubernetes), API keys, ADBC, JDBC, the SDKs, and Cloud Connect. The sidecar and microservice architecture partials, which every version shares, link their recipes too.
Related updates:
- The docs landing page lists Cayenne among the accelerators and links the Cayenne recipe.
- The Cayenne Transactions intro also covers tables configured for durable write-back, matching the section's own requirements.
- The FAQ says the cookbook has over 120 recipes, up from over 65.
docs(task_history): the acceleration refresh task is acceleration_refresh
Eighteen deployment guides (and their 2.0.x-2.3.x snapshots) told readers to
correlate object reads and accelerator spans with a task named
accelerated_table_refresh. No release has ever recorded that name: the refresh
span is declared as "acceleration_refresh" in the accelerated-table refresh
task, and the task column is the span name unless a task_override label is
present.
The name a reader pastes into a task_history query has to match exactly, so a
fabricated one returns no rows. cli/reference/trace.md already carried the
correct name on these same snapshots.
a month ago
docs: publish v2.3.0 documentation and release notes (#2192)
* Add versioned docs for v2.3
* docs: publish v2.3.0 release notes and announcement
* docs: remove the temporary local build configuration
* docs: limit the LLM bundle to the latest released version
---------
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Phillip LeBlanc <879445+phillipleblanc@users.noreply.github.com>
a month ago
docs(task_history): the acceleration refresh task is acceleration_refresh
Eighteen deployment guides (and their 2.0.x-2.3.x snapshots) told readers to
correlate object reads and accelerator spans with a task named
accelerated_table_refresh. No release has ever recorded that name: the refresh
span is declared as "acceleration_refresh" in the accelerated-table refresh
task, and the task column is the span name unless a task_override label is
present.
The name a reader pastes into a task_history query has to match exactly, so a
fabricated one returns no rows. cli/reference/trace.md already carried the
correct name on these same snapshots.
a month ago
docs: publish v2.3.0 documentation and release notes (#2192)
* Add versioned docs for v2.3
* docs: publish v2.3.0 release notes and announcement
* docs: remove the temporary local build configuration
* docs: limit the LLM bundle to the latest released version
---------
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Phillip LeBlanc <879445+phillipleblanc@users.noreply.github.com>
a month ago
Prepare docs for `2.3.2` release (#2241)
* Prepare docs for 2.3.2 release
* Simplify
22 days ago
docs(clickhouse): a connection-string connection_timeout needs a unit suffix
17 days ago
docs: publish v2.3.0 documentation and release notes (#2192)
* Add versioned docs for v2.3
* docs: publish v2.3.0 release notes and announcement
* docs: remove the temporary local build configuration
* docs: limit the LLM bundle to the latest released version
---------
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Phillip LeBlanc <879445+phillipleblanc@users.noreply.github.com>
a month ago
docs: publish v2.3.0 documentation and release notes (#2192)
* Add versioned docs for v2.3
* docs: publish v2.3.0 release notes and announcement
* docs: remove the temporary local build configuration
* docs: limit the LLM bundle to the latest released version
---------
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Phillip LeBlanc <879445+phillipleblanc@users.noreply.github.com>
a month ago
docs: publish v2.3.0 documentation and release notes (#2192)
* Add versioned docs for v2.3
* docs: publish v2.3.0 release notes and announcement
* docs: remove the temporary local build configuration
* docs: limit the LLM bundle to the latest released version
---------
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Phillip LeBlanc <879445+phillipleblanc@users.noreply.github.com>
a month ago
docs: publish v2.3.0 documentation and release notes (#2192)
* Add versioned docs for v2.3
* docs: publish v2.3.0 release notes and announcement
* docs: remove the temporary local build configuration
* docs: limit the LLM bundle to the latest released version
---------
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Phillip LeBlanc <879445+phillipleblanc@users.noreply.github.com>
a month ago
docs: publish v2.3.0 documentation and release notes (#2192)
* Add versioned docs for v2.3
* docs: publish v2.3.0 release notes and announcement
* docs: remove the temporary local build configuration
* docs: limit the LLM bundle to the latest released version
---------
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Phillip LeBlanc <879445+phillipleblanc@users.noreply.github.com>
a month ago
docs(glue): Glue-catalog writes need glue:UpdateTable
17 days ago
docs: note query failure logs, Iceberg append layout, and Cayenne cross-batch keys (#2307)
* docs: note query failure logs, Iceberg append layout, and Cayenne cross-batch keys
Document operator checks that match the released runtime: query_failures
codes and where the error text is returned, how Iceberg append polls skip
files and row groups, and Cayenne's per-batch primary-key upsert.
Co-authored-by: Luke Kim <lukekim@users.noreply.github.com>
* docs: correct Cayenne no-on_conflict and err_code claims against v2.3.2
- Cayenne: the in-batch "keep the first row" and stored-key "incoming
row is dropped" rules are on_conflict: drop, not a primary key with no
on_conflict. On spiced v2.3.2's append refresh, no on_conflict kept the
last in-batch copy and replaced a stored key, while drop kept the first
copy and kept the stored row. Scope the check to an append refresh: a
refresh_mode: full load stored both copies of a duplicated key. The
cross-batch rejection applies with or without on_conflict.
- Troubleshooting: a parse error is SyntaxError, but an unknown table or
column (and a GROUP BY violation) is labeled InternalError, not
QueryPlanningError. ErrorCode::from has no arm for DataFusion's
Diagnostic wrapper, so those planning errors fall through.
* docs: address Copilot review of #2307 and mirror the guidance into 2.3.x
- constraints and datasets reference: carve out Spice Cayenne, whose
append refresh collapses a key repeated within one batch (upsert keeps
the last copy, drop the first) and rejects a key repeated across
batches, instead of failing on an in-batch duplicate.
- Iceberg: bin-pack compaction can mix old and new rows rather than
always mixing them; a sort order applies within partitions, so the
benchmark covers a time partition, a sort order, or both; on Cayenne's
no-primary-key log, rank the latest row per key before the soft-delete
filter (filtering first resurfaces the previous live version).
- Mirror the additions into versioned_docs/version-2.3.x, which the site
serves as the latest docs; the guidance describes v2.3.2 behavior. The
append-only-log paragraph stays trunk-only because 2.3.x has no such
section.
---------
Co-authored-by: Cursor Agent <cursoragent@cursor.com>
Co-authored-by: Luke Kim <lukekim@users.noreply.github.com>
8 days ago
docs: publish v2.3.0 documentation and release notes (#2192)
* Add versioned docs for v2.3
* docs: publish v2.3.0 release notes and announcement
* docs: remove the temporary local build configuration
* docs: limit the LLM bundle to the latest released version
---------
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Phillip LeBlanc <879445+phillipleblanc@users.noreply.github.com>
a month ago
docs(connectors): promote connector statuses, and list Databricks SQL Warehouse mode (#2264)
17 days ago
docs: publish v2.3.0 documentation and release notes (#2192)
* Add versioned docs for v2.3
* docs: publish v2.3.0 release notes and announcement
* docs: remove the temporary local build configuration
* docs: limit the LLM bundle to the latest released version
---------
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Phillip LeBlanc <879445+phillipleblanc@users.noreply.github.com>
a month ago
Prepare docs for `2.3.2` release (#2241)
* Prepare docs for 2.3.2 release
* Simplify
22 days ago
docs: publish v2.3.0 documentation and release notes (#2192)
* Add versioned docs for v2.3
* docs: publish v2.3.0 release notes and announcement
* docs: remove the temporary local build configuration
* docs: limit the LLM bundle to the latest released version
---------
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Phillip LeBlanc <879445+phillipleblanc@users.noreply.github.com>
a month ago
docs: Sync the cookbook page and recipe links with spiceai/cookbook (#2318)
* Sync the cookbook page with the current spiceai/cookbook recipes
List all 122 current recipes (up from 79) and leave out evals, llm-judge, and websearch, which the cookbook marks deprecated in v2.0+.
- Correct entries that pointed at the wrong recipe or described an old version: Results Caching linked the Caching Accelerator recipe, Nvidia NIM on Kubernetes linked the EC2 recipe, Hashed Partitioning now uses Cayenne, and Federated SQL Query no longer uses Dremio.
- Add the missing recipes, including Cayenne, async queries, native PostgreSQL/MySQL/MongoDB CDC, DynamoDB Streams, HTTP, Redshift, ScyllaDB, SMB, the catalog connectors, full-text search, distributed query, and Spice as an MCP server.
- Add Change Data Capture and Advanced Topics sections. Local Dataset Replication was tagged for no rendered section, so it never appeared.
- Show guides in Sample Applications and Guides instead of Security.
- Align Core Features with the cookbook's core scenarios and feature Cayenne as the data accelerator.
- Label recipes that need Spice.ai Enterprise.
- Remove forbidden words (enhance, leverage, utilize, robust) from section intros.
* Fix broken and stale cookbook recipe references across doc versions
Every version links to the recipes on cookbook trunk, so these corrections apply to each version that carries them.
- Query Federation: replace the walkthrough with the current Federated SQL Query recipe, which joins NYC taxi trips in S3 with taxi zones in PostgreSQL. The old walkthrough logged in to a demo Dremio, ran 'spice add spiceai/fed-demo' (that Spicepod no longer exists on Spicerack), and ran 'cd demo' twice. The new steps and output come from a run of the recipe on Spice v2.3.2.
- FAQ: the RAG recipe link (cookbook/tree/trunk/rag) never existed; link the RAG use-case page instead.
- Use cases: fix duckdb/accelerator/README and federation/README links that were missing the .md extension.
- PostgreSQL connector: link the connector recipe instead of the accelerator recipe, and fix 'configure Supabase a data connector'.
- ODBC connector: the recipe now connects to MySQL with the MariaDB driver, not Postgres.
- Glue catalog connector: its recipe configures the Glue Catalog Connector, not the Data Connector.
- Release notes: fix three recipe links that pointed at moved or malformed paths.
* Link docs pages to their cookbook recipes
49 cookbook recipes had no link from any docs page. Add a Cookbook section, or a bullet in an existing one, on the matching page in vNext and 2.3.x. Covered pages include CDC (PostgreSQL, MySQL, Aurora MySQL, MongoDB), the catalog connectors (DuckLake, MySQL, SQL Server, Unity Catalog, Databricks, Iceberg Hadoop, PostgreSQL CDC), acceleration (partitioning, snapshots, indexes, constraints, views, caching, cron refresh, dual-dataset registration), search, distributed query and async queries, MCP, LLM memory, text-to-SQL, the ai() function, models (OpenAI, DeepSeek, filesystem, xAI, NVIDIA NIM on Kubernetes), API keys, ADBC, JDBC, the SDKs, and Cloud Connect. The sidecar and microservice architecture partials, which every version shares, link their recipes too.
Related updates:
- The docs landing page lists Cayenne among the accelerators and links the Cayenne recipe.
- The Cayenne Transactions intro also covers tables configured for durable write-back, matching the section's own requirements.
- The FAQ says the cookbook has over 120 recipes, up from over 65.
docs(nfs): client_timeout has no effect on NFS connections
17 days ago
docs: Sync the cookbook page and recipe links with spiceai/cookbook (#2318)
* Sync the cookbook page with the current spiceai/cookbook recipes
List all 122 current recipes (up from 79) and leave out evals, llm-judge, and websearch, which the cookbook marks deprecated in v2.0+.
- Correct entries that pointed at the wrong recipe or described an old version: Results Caching linked the Caching Accelerator recipe, Nvidia NIM on Kubernetes linked the EC2 recipe, Hashed Partitioning now uses Cayenne, and Federated SQL Query no longer uses Dremio.
- Add the missing recipes, including Cayenne, async queries, native PostgreSQL/MySQL/MongoDB CDC, DynamoDB Streams, HTTP, Redshift, ScyllaDB, SMB, the catalog connectors, full-text search, distributed query, and Spice as an MCP server.
- Add Change Data Capture and Advanced Topics sections. Local Dataset Replication was tagged for no rendered section, so it never appeared.
- Show guides in Sample Applications and Guides instead of Security.
- Align Core Features with the cookbook's core scenarios and feature Cayenne as the data accelerator.
- Label recipes that need Spice.ai Enterprise.
- Remove forbidden words (enhance, leverage, utilize, robust) from section intros.
* Fix broken and stale cookbook recipe references across doc versions
Every version links to the recipes on cookbook trunk, so these corrections apply to each version that carries them.
- Query Federation: replace the walkthrough with the current Federated SQL Query recipe, which joins NYC taxi trips in S3 with taxi zones in PostgreSQL. The old walkthrough logged in to a demo Dremio, ran 'spice add spiceai/fed-demo' (that Spicepod no longer exists on Spicerack), and ran 'cd demo' twice. The new steps and output come from a run of the recipe on Spice v2.3.2.
- FAQ: the RAG recipe link (cookbook/tree/trunk/rag) never existed; link the RAG use-case page instead.
- Use cases: fix duckdb/accelerator/README and federation/README links that were missing the .md extension.
- PostgreSQL connector: link the connector recipe instead of the accelerator recipe, and fix 'configure Supabase a data connector'.
- ODBC connector: the recipe now connects to MySQL with the MariaDB driver, not Postgres.
- Glue catalog connector: its recipe configures the Glue Catalog Connector, not the Data Connector.
- Release notes: fix three recipe links that pointed at moved or malformed paths.
* Link docs pages to their cookbook recipes
49 cookbook recipes had no link from any docs page. Add a Cookbook section, or a bullet in an existing one, on the matching page in vNext and 2.3.x. Covered pages include CDC (PostgreSQL, MySQL, Aurora MySQL, MongoDB), the catalog connectors (DuckLake, MySQL, SQL Server, Unity Catalog, Databricks, Iceberg Hadoop, PostgreSQL CDC), acceleration (partitioning, snapshots, indexes, constraints, views, caching, cron refresh, dual-dataset registration), search, distributed query and async queries, MCP, LLM memory, text-to-SQL, the ai() function, models (OpenAI, DeepSeek, filesystem, xAI, NVIDIA NIM on Kubernetes), API keys, ADBC, JDBC, the SDKs, and Cloud Connect. The sidecar and microservice architecture partials, which every version shares, link their recipes too.
Related updates:
- The docs landing page lists Cayenne among the accelerators and links the Cayenne recipe.
- The Cayenne Transactions intro also covers tables configured for durable write-back, matching the section's own requirements.
- The FAQ says the cookbook has over 120 recipes, up from over 65.
docs: publish v2.3.0 documentation and release notes (#2192)
* Add versioned docs for v2.3
* docs: publish v2.3.0 release notes and announcement
* docs: remove the temporary local build configuration
* docs: limit the LLM bundle to the latest released version
---------
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Phillip LeBlanc <879445+phillipleblanc@users.noreply.github.com>
a month ago
docs: publish v2.3.0 documentation and release notes (#2192)
* Add versioned docs for v2.3
* docs: publish v2.3.0 release notes and announcement
* docs: remove the temporary local build configuration
* docs: limit the LLM bundle to the latest released version
---------
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Phillip LeBlanc <879445+phillipleblanc@users.noreply.github.com>
a month ago
docs: publish v2.3.0 documentation and release notes (#2192)
* Add versioned docs for v2.3
* docs: publish v2.3.0 release notes and announcement
* docs: remove the temporary local build configuration
* docs: limit the LLM bundle to the latest released version
---------
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Phillip LeBlanc <879445+phillipleblanc@users.noreply.github.com>
a month ago
docs(smb): client_timeout is a per-response read timeout that defaults to 30s
Signed-off-by: emma <emma@spice.ai>
17 days ago
docs: Sync the cookbook page and recipe links with spiceai/cookbook (#2318)
* Sync the cookbook page with the current spiceai/cookbook recipes
List all 122 current recipes (up from 79) and leave out evals, llm-judge, and websearch, which the cookbook marks deprecated in v2.0+.
- Correct entries that pointed at the wrong recipe or described an old version: Results Caching linked the Caching Accelerator recipe, Nvidia NIM on Kubernetes linked the EC2 recipe, Hashed Partitioning now uses Cayenne, and Federated SQL Query no longer uses Dremio.
- Add the missing recipes, including Cayenne, async queries, native PostgreSQL/MySQL/MongoDB CDC, DynamoDB Streams, HTTP, Redshift, ScyllaDB, SMB, the catalog connectors, full-text search, distributed query, and Spice as an MCP server.
- Add Change Data Capture and Advanced Topics sections. Local Dataset Replication was tagged for no rendered section, so it never appeared.
- Show guides in Sample Applications and Guides instead of Security.
- Align Core Features with the cookbook's core scenarios and feature Cayenne as the data accelerator.
- Label recipes that need Spice.ai Enterprise.
- Remove forbidden words (enhance, leverage, utilize, robust) from section intros.
* Fix broken and stale cookbook recipe references across doc versions
Every version links to the recipes on cookbook trunk, so these corrections apply to each version that carries them.
- Query Federation: replace the walkthrough with the current Federated SQL Query recipe, which joins NYC taxi trips in S3 with taxi zones in PostgreSQL. The old walkthrough logged in to a demo Dremio, ran 'spice add spiceai/fed-demo' (that Spicepod no longer exists on Spicerack), and ran 'cd demo' twice. The new steps and output come from a run of the recipe on Spice v2.3.2.
- FAQ: the RAG recipe link (cookbook/tree/trunk/rag) never existed; link the RAG use-case page instead.
- Use cases: fix duckdb/accelerator/README and federation/README links that were missing the .md extension.
- PostgreSQL connector: link the connector recipe instead of the accelerator recipe, and fix 'configure Supabase a data connector'.
- ODBC connector: the recipe now connects to MySQL with the MariaDB driver, not Postgres.
- Glue catalog connector: its recipe configures the Glue Catalog Connector, not the Data Connector.
- Release notes: fix three recipe links that pointed at moved or malformed paths.
* Link docs pages to their cookbook recipes
49 cookbook recipes had no link from any docs page. Add a Cookbook section, or a bullet in an existing one, on the matching page in vNext and 2.3.x. Covered pages include CDC (PostgreSQL, MySQL, Aurora MySQL, MongoDB), the catalog connectors (DuckLake, MySQL, SQL Server, Unity Catalog, Databricks, Iceberg Hadoop, PostgreSQL CDC), acceleration (partitioning, snapshots, indexes, constraints, views, caching, cron refresh, dual-dataset registration), search, distributed query and async queries, MCP, LLM memory, text-to-SQL, the ai() function, models (OpenAI, DeepSeek, filesystem, xAI, NVIDIA NIM on Kubernetes), API keys, ADBC, JDBC, the SDKs, and Cloud Connect. The sidecar and microservice architecture partials, which every version shares, link their recipes too.
Related updates:
- The docs landing page lists Cayenne among the accelerators and links the Cayenne recipe.
- The Cayenne Transactions intro also covers tables configured for durable write-back, matching the section's own requirements.
- The FAQ says the cookbook has over 120 recipes, up from over 65.
docs: quote shell placeholders in the version-2.3.x snapshot too
#2197 fixed every doc set except version-2.3.x, which was cut hours
before it merged. 53 lines across 16 pages still carry a bare
<placeholder> inside a shell fence, where the shell reads it as a
redirection rather than as a thing to fill in.
a month ago