Skip to content

Commit 8a10283

Browse files
lukekimclaude
lukekim
and
claude
authored
docs: Refresh outdated Cayenne catalog docs and remove shipped "coming soon" notes (#1697)
* docs: Refresh outdated Cayenne catalog docs and remove shipped "coming soon" notes - Promote Cayenne catalog connector from Alpha to Release Candidate in catalogs index - Add cayenne_file_path, cayenne_unsupported_type_action, cayenne_metastore params and S3 Express One Zone parameter table to Cayenne catalog connector docs - Remove "HTTP Streaming support for MCP is coming soon" admonition from API overview - Mark spice.js and spicepy as supported in parameterized-queries SDK table (version and method-name details still pending) https://claude.ai/code/session_01TBt7vB2F9VK163uV7tqdur * docs: Fill in spice.js and spicepy parameterized-query SDK details Both SDKs added parameterized query support in v3.1.0: - spice.js: SpiceClient.sql() with positional/named params (#268) - spicepy: Client.query_with_params() with Param class (#131) https://claude.ai/code/session_01TBt7vB2F9VK163uV7tqdur --------- Co-authored-by: Claude <noreply@anthropic.com>
1 parent bb36996 commit 8a10283

4 files changed

Lines changed: 45 additions & 29 deletions

File tree

‎website/docs/api/overview.md‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,3 @@ Spice provides high-performance, industry-standard APIs:
2525
### MCP API
2626

2727
- **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).
28-
29-
:::note
30-
HTTP Streaming support for MCP is coming soon.
31-
:::

‎website/docs/components/catalogs/cayenne.md‎

Lines changed: 28 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -38,14 +38,34 @@ Use the `include` field to specify which tables to include from the catalog. The
3838

3939
## `params`
4040

41-
| Parameter Name | Description | Default |
42-
| -------------------------------- | -------------------------------------------------------------------------------------- | ------------ |
43-
| `cayenne_data_dir` | Local directory for table data files (Vortex format). | Spice data directory |
44-
| `cayenne_metadata_dir` | Local directory for Cayenne SQLite metadata. | Spice data directory |
45-
| `cayenne_target_file_size_mb` | Target Vortex file size in MB. | `128` |
46-
| `cayenne_footer_cache_mb` | Size of the in-memory Vortex footer cache in MB for query performance. | `128` |
47-
| `cayenne_segment_cache_mb` | Size of the in-memory Vortex segment cache in MB for caching decompressed data. | `256` |
48-
| `cayenne_compression_strategy` | Compression algorithm for Vortex files. Options: `btrblocks`, `zstd`. | `btrblocks` |
41+
| Parameter Name | Description | Default |
42+
| --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | -------------------- |
43+
| `cayenne_data_dir` | Local directory for table data files (Vortex format). | Spice data directory |
44+
| `cayenne_metadata_dir` | Local directory for Cayenne SQLite metadata. | Spice data directory |
45+
| `cayenne_target_file_size_mb` | Target Vortex file size in MB. | `128` |
46+
| `cayenne_footer_cache_mb` | Size of the in-memory Vortex footer cache in MB for query performance. | `128` |
47+
| `cayenne_segment_cache_mb` | Size of the in-memory Vortex segment cache in MB for caching decompressed data. | `256` |
48+
| `cayenne_compression_strategy` | Compression algorithm for Vortex files. Options: `btrblocks`, `zstd`. | `btrblocks` |
49+
| `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/`). | - |
50+
| `cayenne_unsupported_type_action` | Action when an unsupported data type is encountered. Options: `error`, `string`, `warn`, `ignore`. | `error` |
51+
| `cayenne_metastore` | Metastore backend type. Supports `sqlite` or `turso` (requires `turso` feature flag). | `sqlite` |
52+
53+
### S3 Express One Zone Parameters
54+
55+
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:
56+
57+
| Parameter | Description | Default |
58+
| ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ---------- |
59+
| `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`. | - |
60+
| `cayenne_s3_region` | AWS region (e.g., `us-west-2`). Auto-derived from zone ID if not specified. | - |
61+
| `cayenne_s3_auth` | Authentication method: `iam_role` or `key`. | `iam_role` |
62+
| `cayenne_s3_key` | AWS access key ID (required when `cayenne_s3_auth: key`). | - |
63+
| `cayenne_s3_secret` | AWS secret access key (required when `cayenne_s3_auth: key`). | - |
64+
| `cayenne_s3_session_token` | AWS session token (optional, for temporary credentials). | - |
65+
| `cayenne_s3_endpoint` | Custom S3 endpoint URL (optional, overrides auto-generated endpoint). | - |
66+
| `cayenne_s3_client_timeout` | Request timeout duration (e.g., `30s`, `5m`). | `120s` |
67+
| `cayenne_s3_unsigned_payload` | Use unsigned payload for S3 Express One Zone requests. | `true` |
68+
| `cayenne_s3_allow_http` | Set to `true` for testing with local S3-compatible storage. | `false` |
4969

5070
## Examples
5171

‎website/docs/components/catalogs/index.md‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -22,21 +22,21 @@ Catalog Connectors connect to external catalog providers and make their tables a
2222

2323
Supported Catalog Connectors include:
2424

25-
| Name | Description | Status | Protocol/Format |
26-
| --------------- | ----------------------- | ------ | ---------------------------- |
27-
| `cayenne` | Cayenne Lakehouse | Alpha | Vortex |
28-
| `unity_catalog` | Unity Catalog | Stable | Delta Lake |
29-
| `databricks` | Databricks | Beta | Spark Connect, S3/Delta Lake |
30-
| `iceberg` | Apache Iceberg | Beta | Parquet |
31-
| `spice.ai` | Spice.ai Cloud Platform | Beta | Arrow Flight |
32-
| `ducklake` | DuckLake | Beta | Parquet |
33-
| `glue` | AWS Glue | Alpha | Parquet, Iceberg |
34-
| `snowflake` | Snowflake | Alpha | Snowflake SQL |
35-
| `pg` | PostgreSQL / Redshift | Alpha | PostgreSQL Wire Protocol |
36-
| `mysql` | MySQL | Alpha | MySQL Wire Protocol |
37-
| `mssql` | Microsoft SQL Server | Alpha | TDS |
38-
| `adbc` | ADBC | Alpha | Arrow (ADBC) |
39-
| `oracle` | Oracle | Alpha | Oracle Net |
25+
| Name | Description | Status | Protocol/Format |
26+
| --------------- | ----------------------- | ----------------- | ---------------------------- |
27+
| `cayenne` | Cayenne Lakehouse | Release Candidate | Vortex |
28+
| `unity_catalog` | Unity Catalog | Stable | Delta Lake |
29+
| `databricks` | Databricks | Beta | Spark Connect, S3/Delta Lake |
30+
| `iceberg` | Apache Iceberg | Beta | Parquet |
31+
| `spice.ai` | Spice.ai Cloud Platform | Beta | Arrow Flight |
32+
| `ducklake` | DuckLake | Beta | Parquet |
33+
| `glue` | AWS Glue | Alpha | Parquet, Iceberg |
34+
| `snowflake` | Snowflake | Alpha | Snowflake SQL |
35+
| `pg` | PostgreSQL / Redshift | Alpha | PostgreSQL Wire Protocol |
36+
| `mysql` | MySQL | Alpha | MySQL Wire Protocol |
37+
| `mssql` | Microsoft SQL Server | Alpha | TDS |
38+
| `adbc` | ADBC | Alpha | Arrow (ADBC) |
39+
| `oracle` | Oracle | Alpha | Oracle Net |
4040

4141
## Catalog Connector Docs
4242

‎website/docs/features/query-federation/parameterized-queries.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -354,8 +354,8 @@ Parameterized queries can improve performance in several ways:
354354
| [spice-rs](https://github.com/spiceai/spice-rs) (Rust) | v3.0.0+ | `query_with_params()` with `RecordBatch` | ✅ Full |
355355
| [spice-dotnet](https://github.com/spiceai/spice-dotnet) (Dotnet) | v1.1.0+ | `Query()` with `Dictionary<string, object>` | ✅ Full |
356356
| [spice-java](https://github.com/spiceai/spice-java) (Java) | v0.5.0+ | `queryWithParams()` with `Param` class | ✅ Full |
357-
| [spice.js](https://github.com/spiceai/spice.js) (JavaScript) | - | Coming soon | ❌ Not yet |
358-
| [spicepy](https://github.com/spiceai/spicepy) (Python) | - | Coming soon (use ADBC) | ❌ Not yet |
357+
| [spice.js](https://github.com/spiceai/spice.js) (JavaScript) | v3.1.0+ | `sql()` with positional or named parameters | ✅ Full |
358+
| [spicepy](https://github.com/spiceai/spicepy) (Python) | v3.1.0+ | `query_with_params()` with `Param` class | ✅ Full |
359359
| ADBC (Python) | - | `cursor.execute()` with `parameters` | ✅ Full |
360360
| JDBC | - | `PreparedStatement` | ✅ Full |
361361
| ODBC | - | Parameterized queries | ✅ Full |

0 commit comments

Comments
 (0)