Skip to content

docs: Refresh outdated Cayenne catalog docs and remove shipped "coming soon" notes #1697

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
phillipleblanc merged 3 commits into from
May 11, 2026
+45 −29
Merged

docs: Refresh outdated Cayenne catalog docs and remove shipped "coming soon" notes #1697

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cba3fa9
docs: Refresh outdated Cayenne catalog docs and remove shipped "comin…
claude May 9, 2026
7f03845
docs: Fill in spice.js and spicepy parameterized-query SDK details
claude May 10, 2026
2d2014a
Merge branch 'trunk' into claude/review-outdated-docs-UOUyr
lukekim May 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions website/docs/api/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,3 @@ Spice provides high-performance, industry-standard APIs:
### MCP API

- **HTTP APIs**: The Model Context Protocol (MCP) helps integrate external tools and services into the Spice runtime. MCP tools can be accessed via HTTP APIs for tool integration and orchestration. For details, see the [MCP documentation](../features/large-language-models/mcp).

:::note
HTTP Streaming support for MCP is coming soon.
:::
36 changes: 28 additions & 8 deletions website/docs/components/catalogs/cayenne.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,14 +38,34 @@ Use the `include` field to specify which tables to include from the catalog. The

## `params`

| Parameter Name | Description | Default |
| -------------------------------- | -------------------------------------------------------------------------------------- | ------------ |
| `cayenne_data_dir` | Local directory for table data files (Vortex format). | Spice data directory |
| `cayenne_metadata_dir` | Local directory for Cayenne SQLite metadata. | Spice data directory |
| `cayenne_target_file_size_mb` | Target Vortex file size in MB. | `128` |
| `cayenne_footer_cache_mb` | Size of the in-memory Vortex footer cache in MB for query performance. | `128` |
| `cayenne_segment_cache_mb` | Size of the in-memory Vortex segment cache in MB for caching decompressed data. | `256` |
| `cayenne_compression_strategy` | Compression algorithm for Vortex files. Options: `btrblocks`, `zstd`. | `btrblocks` |
| Parameter Name | Description | Default |
| --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | -------------------- |
| `cayenne_data_dir` | Local directory for table data files (Vortex format). | Spice data directory |
| `cayenne_metadata_dir` | Local directory for Cayenne SQLite metadata. | Spice data directory |
| `cayenne_target_file_size_mb` | Target Vortex file size in MB. | `128` |
| `cayenne_footer_cache_mb` | Size of the in-memory Vortex footer cache in MB for query performance. | `128` |
| `cayenne_segment_cache_mb` | Size of the in-memory Vortex segment cache in MB for caching decompressed data. | `256` |
| `cayenne_compression_strategy` | Compression algorithm for Vortex files. Options: `btrblocks`, `zstd`. | `btrblocks` |
| `cayenne_file_path` | Custom path for storing Cayenne data files. Supports local paths or S3 Express One Zone URLs (e.g., `s3://bucket--usw2-az1--x-s3/prefix/`). | - |
| `cayenne_unsupported_type_action` | Action when an unsupported data type is encountered. Options: `error`, `string`, `warn`, `ignore`. | `error` |
| `cayenne_metastore` | Metastore backend type. Supports `sqlite` or `turso` (requires `turso` feature flag). | `sqlite` |

### S3 Express One Zone Parameters

When `cayenne_file_path` is set to an S3 Express One Zone URL (or `cayenne_s3_zone_ids` is configured), the following parameters control S3 connectivity:

| Parameter | Description | Default |
| ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ---------- |
| `cayenne_s3_zone_ids` | Comma-separated availability zone IDs (e.g., `usw2-az1,usw2-az2`). Auto-generates bucket names in format `spice-{app}-{dataset}--{zone}--x-s3`. | - |
| `cayenne_s3_region` | AWS region (e.g., `us-west-2`). Auto-derived from zone ID if not specified. | - |
| `cayenne_s3_auth` | Authentication method: `iam_role` or `key`. | `iam_role` |
| `cayenne_s3_key` | AWS access key ID (required when `cayenne_s3_auth: key`). | - |
| `cayenne_s3_secret` | AWS secret access key (required when `cayenne_s3_auth: key`). | - |
| `cayenne_s3_session_token` | AWS session token (optional, for temporary credentials). | - |
| `cayenne_s3_endpoint` | Custom S3 endpoint URL (optional, overrides auto-generated endpoint). | - |
| `cayenne_s3_client_timeout` | Request timeout duration (e.g., `30s`, `5m`). | `120s` |
| `cayenne_s3_unsigned_payload` | Use unsigned payload for S3 Express One Zone requests. | `true` |
| `cayenne_s3_allow_http` | Set to `true` for testing with local S3-compatible storage. | `false` |

## Examples

Expand Down
30 changes: 15 additions & 15 deletions website/docs/components/catalogs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,21 +22,21 @@ Catalog Connectors connect to external catalog providers and make their tables a

Supported Catalog Connectors include:

| Name | Description | Status | Protocol/Format |
| --------------- | ----------------------- | ------ | ---------------------------- |
| `cayenne` | Cayenne Lakehouse | Alpha | Vortex |
| `unity_catalog` | Unity Catalog | Stable | Delta Lake |
| `databricks` | Databricks | Beta | Spark Connect, S3/Delta Lake |
| `iceberg` | Apache Iceberg | Beta | Parquet |
| `spice.ai` | Spice.ai Cloud Platform | Beta | Arrow Flight |
| `ducklake` | DuckLake | Beta | Parquet |
| `glue` | AWS Glue | Alpha | Parquet, Iceberg |
| `snowflake` | Snowflake | Alpha | Snowflake SQL |
| `pg` | PostgreSQL / Redshift | Alpha | PostgreSQL Wire Protocol |
| `mysql` | MySQL | Alpha | MySQL Wire Protocol |
| `mssql` | Microsoft SQL Server | Alpha | TDS |
| `adbc` | ADBC | Alpha | Arrow (ADBC) |
| `oracle` | Oracle | Alpha | Oracle Net |
| Name | Description | Status | Protocol/Format |
| --------------- | ----------------------- | ----------------- | ---------------------------- |
| `cayenne` | Cayenne Lakehouse | Release Candidate | Vortex |
| `unity_catalog` | Unity Catalog | Stable | Delta Lake |
| `databricks` | Databricks | Beta | Spark Connect, S3/Delta Lake |
| `iceberg` | Apache Iceberg | Beta | Parquet |
| `spice.ai` | Spice.ai Cloud Platform | Beta | Arrow Flight |
| `ducklake` | DuckLake | Beta | Parquet |
| `glue` | AWS Glue | Alpha | Parquet, Iceberg |
| `snowflake` | Snowflake | Alpha | Snowflake SQL |
| `pg` | PostgreSQL / Redshift | Alpha | PostgreSQL Wire Protocol |
| `mysql` | MySQL | Alpha | MySQL Wire Protocol |
| `mssql` | Microsoft SQL Server | Alpha | TDS |
| `adbc` | ADBC | Alpha | Arrow (ADBC) |
| `oracle` | Oracle | Alpha | Oracle Net |

## Catalog Connector Docs

Expand Down
4 changes: 2 additions & 2 deletions website/docs/features/query-federation/parameterized-queries.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -354,8 +354,8 @@ Parameterized queries can improve performance in several ways:
| [spice-rs](https://github.com/spiceai/spice-rs) (Rust) | v3.0.0+ | `query_with_params()` with `RecordBatch` | ✅ Full |
| [spice-dotnet](https://github.com/spiceai/spice-dotnet) (Dotnet) | v1.1.0+ | `Query()` with `Dictionary<string, object>` | ✅ Full |
| [spice-java](https://github.com/spiceai/spice-java) (Java) | v0.5.0+ | `queryWithParams()` with `Param` class | ✅ Full |
| [spice.js](https://github.com/spiceai/spice.js) (JavaScript) | - | Coming soon | ❌ Not yet |
| [spicepy](https://github.com/spiceai/spicepy) (Python) | - | Coming soon (use ADBC) | ❌ Not yet |
| [spice.js](https://github.com/spiceai/spice.js) (JavaScript) | v3.1.0+ | `sql()` with positional or named parameters | ✅ Full |
| [spicepy](https://github.com/spiceai/spicepy) (Python) | v3.1.0+ | `query_with_params()` with `Param` class | ✅ Full |
| ADBC (Python) | - | `cursor.execute()` with `parameters` | ✅ Full |
| JDBC | - | `PreparedStatement` | ✅ Full |
| ODBC | - | Parameterized queries | ✅ Full |
Expand Down
Loading