Check in versioned docs and remove generate-versions script (#1386)
* Check in versioned docs and remove generate-versions script
Transition from per-branch versioning to all versions checked in.
Generated versioned docs from release branches 1.5 through 1.11.
Removed generate-versions.sh and updated .gitignore.
* Remove generate-versions script from build workflow
Versioned docs are now checked in directly. Remove the script
invocation from package.json build, drop the fetch-depth: 0 from CI
(no longer needed), and update README to reflect the new process.
8 months ago
docs(api): the Iceberg REST catalog endpoints are served at /v1/config and /v1/namespaces, not under /v1/iceberg (#2334)
* docs(api): the Iceberg REST catalog endpoints are served at /v1/config and /v1/namespaces, not under /v1/iceberg
* chore: update API docs
* docs(api): drop /iceberg from the request URL encoded in the versioned Iceberg API pages
---------
Co-authored-by: Spice Schema Bot <schema-bot@spice.ai>
5 days ago
docs(tracing): the SPICED_LOG equivalents did not match the filter spiced installs (#2211)
* docs(tracing): the SPICED_LOG equivalents did not match the filter spiced installs
The documented per-level SPICED_LOG strings listed nine internal components
and a single off-filter, and gave the trailing global level as DEBUG for -v
and TRACE for -vv. env_filter_string() in bin/spiced/src/tracing.rs composes
internal_components(level) + OFF_FILTERS [+ OFF_UNLESS_VERY_VERBOSE_FILTERS]
+ a global level that is WARN / INFO / DEBUG respectively - it has never been
DEBUG at -v or TRACE at -vv in any release back to v1.5.
Regenerate all three strings per snapshot from the constants at that release's
tag, so each version's page carries its own component list and off-filter set.
* docs(tracing): not every held-down target is off from v2.0
OFF_FILTERS pins opentelemetry to warn from v2.0.0, and
OFF_UNLESS_VERY_VERBOSE_FILTERS adds tantivy=warn (v2.0.0) and
text_embeddings_backend_candle=error (v2.2.0), so 'turned off outright' is
only exact on the 1.x snapshots. Split the wording per version.
* docs(tracing): name the noisy-target overrides the -v and -vv fallbacks do not cover
The -v and -vv sections said the filter raises Spice's components and sets
'everything else' to INFO / DEBUG. The trailing level is the fallback for
targets the filter does not name, but each string also pins a dozen noisy
targets to off/warn/error, so 'everything else' overstated what the fallback
reaches.
Each section now names the fallback and the exception, with the exception's
level set derived from that snapshot's own filter string: 'off' alone for
1.5.x-1.11.x, 'off' or 'warn' for 2.0.x-2.1.x, and 'off', 'warn' or 'error'
for 2.2.x onward. The -vv wording additionally distinguishes the filters that
are lifted at very-verbose from the ones that stay held down.
The Default section carried the same over-claim in the other direction on
2.0.x and 2.1.x, which have no '=error' directive yet advertised 'warn'/'error';
both now say 'warn'.
* docs(tracing): drop 'warn' from the default level's held-down list, where it is the fallback
At the default level the trailing fallback is WARN, so an explicit
'opentelemetry=warn' or 'tantivy=warn' admits exactly what the fallback
already admits. Listing 'warn' among the targets 'held down further still'
claimed a suppression those directives do not perform; only 'off', and
'error' where the snapshot has it, sit below the fallback.
Measured with tracing-subscriber 0.3.23 against the default string: tantivy
and opentelemetry both pass ERROR and WARN, identical to an unnamed target,
while reqwest_retry::middleware is silenced and
text_embeddings_backend_candle passes ERROR alone.
The -v and -vv sections are unaffected: their fallbacks are INFO and DEBUG,
so a 'warn' directive is genuinely more restrictive there.
a month ago
docs(powerbi): cast LargeUtf8 with arrow_cast(..., 'Utf8'); ::TEXT plans as Utf8View; fix view YAML (#2253)
Co-authored-by: claudespice <claudespice@users.noreply.github.com>
19 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.
Add cluster-sidecar hybrid architecture (#1387)
* Refactor deployment architecture documentation to use MDX components for better modularity and maintainability
- Updated microservice, sharded, sidecar, tiered, cluster, hosted, and hybrid architecture documentation to import content from MDX partials.
- Removed inline content in favor of centralized MDX files for each architecture type.
- Added new hybrid architecture documentation to support sidecar caching backed by a centralized cluster.
* Update image formatting in deployment architecture documentation for consistency
8 months 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(telemetry): the Data Collected list omitted the host hardware attributes
crates/telemetry/src/anonymous.rs::resource builds the telemetry
resource with five attributes beyond service.name/name:
service.version, service.instance.id, spicepod.id, host.cpu.count,
host.gpu.count and host.memory.bytes. The page — whose purpose is to
enumerate what leaves the host — listed only the first three. The
hardware attributes arrived in spiceai/spiceai#8483, first released
v1.11.0, so they are added to v1.11.x and later.
The instance-id formula also lost a separator: since
spiceai/spiceai#9321 (first released v2.0.0) the hash is
SHA256(hostname + ":" + spicepod_name), not the concatenation the
page describes. Corrected for v2.0.x and later; v1.11.x and older
document their own releases correctly.
Both source links pointed at blob/trunk with a line anchor, so every
snapshot linked today's code at a line that has since moved — L65 of
anonymous.rs is now a blank line inside resource(), and L32 of lib.rs
is a histogram-bucket comment rather than the metric definitions.
Each doc set now links its own release tag (vNext links the reviewed
trunk SHA), the identifier link spans the whole resource() function
at that ref, and the metrics link drops the stale line anchor.
a month ago
Check in versioned docs and remove generate-versions script (#1386)
* Check in versioned docs and remove generate-versions script
Transition from per-branch versioning to all versions checked in.
Generated versioned docs from release branches 1.5 through 1.11.
Removed generate-versions.sh and updated .gitignore.
* Remove generate-versions script from build workflow
Versioned docs are now checked in directly. Remove the script
invocation from package.json build, drop the fetch-depth: 0 from CI
(no longer needed), and update README to reflect the new process.
8 months ago
fix: Correct "Dashbord" typo in Datadog monitoring docs
The Datadog import-dashboard step read "Dashbord is now configured..."
across the unversioned docs and all 7 versioned copies. Addresses one of
the items called out in spiceai/docs#506.
6 months 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
fix: propagate JS SDK camelCase parameters to versioned docs (fixes #544)
PR #1434 updated the unversioned JS SDK docs to use the current
spice.js API (`flightUrl` constructor parameter and `sql()` query
method), but the change was not propagated to the versioned copies.
All seven versioned docs (1.5.x through 1.11.x) still showed the old
`flight_url` and `spiceClient.query()` API, which has not matched the
published spice.js package since v2.x (October 2024).
Updated the seven versioned JavaScript SDK pages to match the current
SDK surface.
6 months ago
docs: quote placeholders in shell examples so the blocks paste safely
An unquoted <placeholder> inside a shell-tagged fence is redirection from
a file of that name, so a copied command aborts (exit 1), fails to parse
(exit 2), or — where it sits mid-block — is silently skipped while the
block still reports exit 0. Quote the placeholder, which keeps it visible
as a placeholder and passes it through verbatim.
Usage synopses are left alone: where a fence carries [...] optional-argument
notation, or a placeholder fills a command slot, the <> is grammar for the
command's shape rather than a command to paste.
Fixes #2196
a month ago
Fix links in documentation for Federated SQL Query recipes and update (#1423)
* Fix links in documentation for Federated SQL Query recipes and update IMAP connector references across multiple versions
* Refactor IMAP documentation across multiple versions to improve schema and parameter formatting
- Updated schema tables in imap.md for versions 1.5.x, 1.6.x, 1.7.x, 1.8.x, 1.9.x, and 1.10.x to enhance readability.
- Standardized parameter descriptions in IMAP connection settings for clarity.
- Adjusted formatting for file format support tables in index.md for versions 1.5.x, 1.6.x, 1.7.x, 1.8.x, and 1.9.x to ensure consistency.
7 months ago
docs: update community Slack URL to https://spice.ai/slack (#1752)
5 months ago
Check in versioned docs and remove generate-versions script (#1386)
* Check in versioned docs and remove generate-versions script
Transition from per-branch versioning to all versions checked in.
Generated versioned docs from release branches 1.5 through 1.11.
Removed generate-versions.sh and updated .gitignore.
* Remove generate-versions script from build workflow
Versioned docs are now checked in directly. Remove the script
invocation from package.json build, drop the fetch-depth: 0 from CI
(no longer needed), and update README to reflect the new process.
8 months ago
Check in versioned docs and remove generate-versions script (#1386)
* Check in versioned docs and remove generate-versions script
Transition from per-branch versioning to all versions checked in.
Generated versioned docs from release branches 1.5 through 1.11.
Removed generate-versions.sh and updated .gitignore.
* Remove generate-versions script from build workflow
Versioned docs are now checked in directly. Remove the script
invocation from package.json build, drop the fetch-depth: 0 from CI
(no longer needed), and update README to reflect the new process.
8 months ago