docs(datatypes): Parquet BYTE_ARRAY strings and binaries read as LargeUtf8/LargeBinary (#2252)
Co-authored-by: claudespice <claudespice@users.noreply.github.com>
19 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(datasets): a time_format mismatch fails the dataset, and iso8601 on a timestamp or date column is ignored with a warning (#2325)
* docs(datasets): a time_format mismatch fails the dataset, and iso8601 on a timestamp or date column is ignored with a warning (spiceai/spiceai#14777)
* docs(datasets): a string time_column needs time_format iso8601 (spiceai/spiceai#14777)
6 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.
7 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
fix: add the missing Elasticsearch row to the Distribution Availability table (fixes #2208) (#2228)
* docs(distributions): add the missing Elasticsearch row to Distribution Availability
The page enumerates the connectors gated out of the default `spiced`
build twice. "Additional Connectors" names four (ODBC, ScyllaDB, NFS,
Elasticsearch); "Distribution Availability", the table a reader scans
first, carried rows for only three of them. A reader checking whether
the stock open source image can talk to Elasticsearch found the
connector absent from the availability table and could reasonably
conclude it ships by default. It does not.
* docs(distributions): carry the Elasticsearch row into the v2.0.x-v2.2.x snapshots
The connector exists and is gated out of the default `spiced` build in
every release from v2.0 onward, so the same omission is present in those
snapshots' availability tables, and their Additional Connectors section
named ODBC alone. v1.11.x is unchanged: that release has no Elasticsearch
connector to document.
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
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: document the spice-trace-id correlation header for HTTP and Flight
18 days ago