Skip to content

Commit 3422907

Browse files
authored
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.
1 parent baacee0 commit 3422907

121 files changed

Lines changed: 557 additions & 566 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

website/docs/components/catalogs/ducklake.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -176,7 +176,3 @@ Spice integrates with multiple secret stores to help manage sensitive data secur
176176
- If a table fails to load during catalog refresh, it is skipped with a warning and does not fail the entire catalog.
177177

178178
:::
179-
180-
## Cookbook
181-
182-
- A cookbook recipe to configure DuckLake as a catalog connector in Spice. [DuckLake Catalog Connector](https://github.com/spiceai/cookbook/tree/trunk/catalogs/ducklake#readme)

website/docs/components/data-connectors/ducklake.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,3 @@ datasets:
156156
- Each dataset creates its own DuckDB connection pool. For querying many tables from the same catalog, consider using the [DuckLake Catalog Connector](../catalogs/ducklake) instead, which shares a single connection pool.
157157

158158
:::
159-
160-
## Cookbook
161-
162-
- A cookbook recipe to configure DuckLake as a catalog and data connector in Spice. [DuckLake Catalog Connector](https://github.com/spiceai/cookbook/tree/trunk/catalogs/ducklake#readme)

website/docs/components/data-connectors/glue.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -50,13 +50,13 @@ The dataset name cannot be a [reserved keyword](../../reference/spicepod/keyword
5050

5151
The following parameters are supported for configuring the connection to the Glue Data Catalog:
5252

53-
| Parameter Name | Definition |
54-
| -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
55-
| `glue_region` | The AWS region for the Glue Data Catalog. E.g. `us-west-2`. |
56-
| `glue_catalog_id` | The Glue catalog ID. For Amazon S3 Tables, use the format `<account_id>:s3tablescatalog/<table_bucket_name>`. If not provided, the default catalog for the account is used. |
57-
| `glue_key` | Access key (e.g. AWS_ACCESS_KEY_ID for AWS). If not provided, credentials will be loaded from environment variables or IAM roles. |
58-
| `glue_secret` | Secret key (e.g. AWS_SECRET_ACCESS_KEY for AWS). If not provided, credentials will be loaded from environment variables or IAM roles. |
59-
| `glue_session_token` | Session token (e.g. AWS_SESSION_TOKEN for AWS) for temporary credentials |
53+
| Parameter Name | Definition |
54+
| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
55+
| `glue_region` | The AWS region for the Glue Data Catalog. E.g. `us-west-2`. |
56+
| `glue_catalog_id` | The Glue catalog ID. For Amazon S3 Tables, use the format `<account_id>:s3tablescatalog/<table_bucket_name>`. If not provided, the default catalog for the account is used. |
57+
| `glue_key` | Access key (e.g. AWS_ACCESS_KEY_ID for AWS). If not provided, credentials will be loaded from environment variables or IAM roles. |
58+
| `glue_secret` | Secret key (e.g. AWS_SECRET_ACCESS_KEY for AWS). If not provided, credentials will be loaded from environment variables or IAM roles. |
59+
| `glue_session_token` | Session token (e.g. AWS_SESSION_TOKEN for AWS) for temporary credentials |
6060
| `glue_iam_role_source` | Optional. IAM role credential source. `auto` (default) uses the default AWS credential chain, `metadata` uses only instance/container metadata (IMDS, ECS, EKS/IRSA), `env` uses only environment variables. |
6161

6262
## Examples
@@ -241,4 +241,4 @@ Each query retrieves data from the S3 source, which might result in significant
241241

242242
## Cookbook
243243

244-
- A cookbook recipe to configure Glue as a data connector in Spice. [Glue Data Connector](https://github.com/spiceai/cookbook/tree/trunk/glue/README)
244+
- A cookbook recipe to configure Glue as a data connector in Spice. [Glue Data Connector](https://github.com/spiceai/cookbook/tree/trunk/glue#readme)

website/docs/components/data-connectors/imap.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,4 +124,4 @@ Spice integrates with multiple secret stores to help manage sensitive data secur
124124
## Cookbook
125125

126126
- A cookbook recipe to configure IMAP as a data connector in Spice. [IMAP Data Connector](https://github.com/spiceai/cookbook/tree/trunk/imap/#readme)
127-
- A cookbook recipe to configure IMAP with Outlook using OAuth authentication as a data connector in Spice. [Connecting to an Outlook mailbox](https://github.com/spiceai/cookbook/tree/trunk/imap/outlook)
127+
- A cookbook recipe to configure IMAP with Outlook using OAuth authentication as a data connector in Spice. [Connecting to an Outlook mailbox](https://github.com/spiceai/cookbook/tree/trunk/imap#readme)

website/docs/components/data-connectors/index.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -70,20 +70,19 @@ Supported Data Connectors include:
7070
| `debezium` | Debezium CDC | Alpha | Kafka + JSON |
7171
| `kafka` | Kafka | Alpha | Kafka + JSON |
7272
| `mongodb` | MongoDB | Alpha | |
73-
| `ducklake` | [DuckLake][ducklake] | Alpha | Parquet |
73+
| `ducklake` | DuckLake | Alpha | Parquet |
7474
| `scylladb` | ScyllaDB | Alpha | CQL, Alternator (DynamoDB) |
7575
| `adbc` | [ADBC][adbc] | Alpha | Arrow (ADBC) |
7676
| `elasticsearch` | ElasticSearch | Roadmap | |
7777

78-
[databricks]: https://github.com/spiceai/cookbook/tree/trunk/databricks/delta_lake
78+
[databricks]: https://github.com/spiceai/cookbook/tree/trunk/databricks#readme
7979
[spark]: https://spark.apache.org/docs/latest/spark-connect-overview.html
8080
[s3]: https://github.com/spiceai/cookbook/tree/trunk/s3#readme
8181
[spiceai]: https://github.com/spiceai/cookbook/tree/trunk/spiceai#readme
8282
[dremio]: https://github.com/spiceai/cookbook/tree/trunk/dremio#readme
8383
[localpod]: https://github.com/spiceai/cookbook/blob/trunk/localpod/README.md
8484
[iceberg]: https://github.com/spiceai/cookbook/tree/trunk/catalogs/iceberg#readme
85-
[glue]: https://github.com/spiceai/cookbook/tree/trunk/glue/README.md
86-
[ducklake]: https://github.com/spiceai/cookbook/tree/trunk/catalogs/ducklake#readme
85+
[glue]: https://github.com/spiceai/cookbook/tree/trunk/glue#readme
8786
[adbc]: https://arrow.apache.org/adbc/
8887
[ODPIC]: https://oracle.github.io/odpi/
8988

website/docs/components/data-connectors/kafka.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -159,4 +159,4 @@ Spice integrates with multiple secret stores to help manage sensitive data secur
159159

160160
## Cookbook
161161

162-
- See how to query Kafka real-time data with other datasets using federated queries in [Live Orders Analytics example](https://github.com/spiceai/cookbook/blob/trunk/kafka/README).
162+
- See how to query Kafka real-time data with other datasets using federated queries in [Live Orders Analytics example](https://github.com/spiceai/cookbook/blob/trunk/kafka/README.md).

website/docs/components/data-connectors/odbc.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -327,7 +327,7 @@ datasets:
327327
odbc_connection_string: Driver={PostgreSQL Unicode};Server=localhost;Port=5432;Database=spice_demo;Uid=postgres
328328
```
329329

330-
See the [ODBC Cookbook](https://github.com/spiceai/cookbook/blob/trunk/odbc/README) for more help on getting started with ODBC and Postgres.
330+
See the [ODBC Cookbook](https://github.com/spiceai/cookbook/blob/trunk/odbc/README.md) for more help on getting started with ODBC and Postgres.
331331

332332
## Secrets
333333

website/docs/components/data-connectors/oracle.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -198,4 +198,4 @@ Spice integrates with multiple secret stores to help manage sensitive data secur
198198

199199
## Cookbook
200200

201-
- A cookbook recipe to connect to and accelerate data from an Oracle database in Spice. [Oracle Data Connector](https://github.com/spiceai/cookbook/blob/trunk/oracle/README)
201+
- A cookbook recipe to connect to and accelerate data from an Oracle database in Spice. [Oracle Data Connector](https://github.com/spiceai/cookbook/blob/trunk/oracle/README.md)

website/docs/components/models/huggingface.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,4 +114,4 @@ For more details on authentication, see [access tokens](#access-tokens).
114114

115115
## Cookbook
116116

117-
- Use the Llama family of models locally from HuggingFace using Spice. [Running Llama3 Locally](https://github.com/spiceai/cookbook/blob/trunk/llama/README)
117+
- Use the Llama family of models locally from HuggingFace using Spice. [Running Llama3 Locally](https://github.com/spiceai/cookbook/blob/trunk/llama/README.md)

website/docs/index.mdx

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Spice is primarily used for:
4444

4545
- **Data Federation**: SQL query across any database, data warehouse, or data lake. [Learn More](https://spiceai.org/docs/features/query-federation).
4646
- **Data Materialization and Acceleration**: Materialize, accelerate, and cache database queries. [Read the MaterializedView interview - Building a CDN for Databases](https://materializedview.io/p/building-a-cdn-for-databases-spice-ai).
47-
- **Enterprise Search**: Keyword, vector, and full-text search with Tantivy-powered BM25 and vector similarity search for structured and unstructured data. [Learn More](https://github.com/spiceai/cookbook/blob/trunk/vectors/s3/README).
47+
- **Enterprise Search**: Keyword, vector, and full-text search with Tantivy-powered BM25 and vector similarity search for structured and unstructured data. [Learn More](https://github.com/spiceai/cookbook/blob/trunk/vectors/s3/README.md).
4848
- **AI Apps and Agents**: An AI-database powering retrieval-augmented generation (RAG) and intelligent agents. [Learn More](https://spiceai.org/docs/use-cases/rag).
4949

5050
:::info[Watch 🎥]
@@ -101,23 +101,23 @@ For detailed comparisons with other data query engines and AI frameworks, see [H
101101

102102
### Data-Grounded Agentic AI Applications
103103

104-
- **OpenAI-Compatible API**: Connect to hosted models (OpenAI, Anthropic, xAI) or deploy locally (Llama, NVIDIA NIM). [AI Gateway Recipe](https://github.com/spiceai/cookbook/blob/trunk/openai_sdk/README)
105-
- **Federated Data Access**: Query using SQL and NSQL (text-to-SQL) across databases, data warehouses, and data lakes with advanced query push-down. [Federated SQL Query Recipe](https://github.com/spiceai/cookbook/blob/trunk/federation/README)
106-
- **Search and RAG**: Perform keyword, vector, and full-text search with Tantivy-powered BM25 and vector similarity search (VSS) integrated into SQL queries using `vector_search` and `text_search`. Supports multi-column vector search with reciprocal rank fusion. [Amazon S3 Vectors Recipe](https://github.com/spiceai/cookbook/blob/trunk/vectors/s3/README)
107-
- **LLM Memory and Observability**: Store and retrieve history and context for AI agents with visibility into data flows, model performance, and traces. [LLM Memory Recipe](https://github.com/spiceai/cookbook/blob/trunk/llm-memory/README) | [Observability Documentation](https://spiceai.org/docs/features/observability)
104+
- **OpenAI-Compatible API**: Connect to hosted models (OpenAI, Anthropic, xAI) or deploy locally (Llama, NVIDIA NIM). [AI Gateway Recipe](https://github.com/spiceai/cookbook/blob/trunk/openai_sdk/README.md)
105+
- **Federated Data Access**: Query using SQL and NSQL (text-to-SQL) across databases, data warehouses, and data lakes with advanced query push-down. [Federated SQL Query Recipe](https://github.com/spiceai/cookbook/blob/trunk/federation/README.md)
106+
- **Search and RAG**: Perform keyword, vector, and full-text search with Tantivy-powered BM25 and vector similarity search (VSS) integrated into SQL queries using `vector_search` and `text_search`. Supports multi-column vector search with reciprocal rank fusion. [Amazon S3 Vectors Recipe](https://github.com/spiceai/cookbook/blob/trunk/vectors/s3/README.md)
107+
- **LLM Memory and Observability**: Store and retrieve history and context for AI agents with visibility into data flows, model performance, and traces. [LLM Memory Recipe](https://github.com/spiceai/cookbook/blob/trunk/llm-memory/README.md) | [Observability Documentation](https://spiceai.org/docs/features/observability)
108108

109109
### Database CDN and Query Mesh
110110

111-
- **Data Acceleration**: Co-locate materialized datasets in Arrow, SQLite, or DuckDB for sub-second queries. [DuckDB Data Accelerator Recipe](https://github.com/spiceai/cookbook/blob/trunk/duckdb/accelerator/README)
112-
- **Resiliency and Local Dataset Replication**: Maintain availability with local replicas of critical datasets. [Local Dataset Replication Recipe](https://github.com/spiceai/cookbook/blob/trunk/localpod/README)
113-
- **Responsive Dashboards**: Enable fast, real-time analytics for frontends and BI tools. [Sales BI Dashboard Demo](https://github.com/spiceai/cookbook/blob/trunk/sales-bi/README)
114-
- **Simplified Legacy Migration**: Unify legacy systems with modern infrastructure via federated SQL querying. [Federated SQL Query Recipe](https://github.com/spiceai/cookbook/blob/trunk/federation/README)
111+
- **Data Acceleration**: Co-locate materialized datasets in Arrow, SQLite, or DuckDB for sub-second queries. [DuckDB Data Accelerator Recipe](https://github.com/spiceai/cookbook/blob/trunk/duckdb/accelerator/README.md)
112+
- **Resiliency and Local Dataset Replication**: Maintain availability with local replicas of critical datasets. [Local Dataset Replication Recipe](https://github.com/spiceai/cookbook/blob/trunk/localpod/README.md)
113+
- **Responsive Dashboards**: Enable fast, real-time analytics for frontends and BI tools. [Sales BI Dashboard Demo](https://github.com/spiceai/cookbook/blob/trunk/sales-bi/README.md)
114+
- **Simplified Legacy Migration**: Unify legacy systems with modern infrastructure via federated SQL querying. [Federated SQL Query Recipe](https://github.com/spiceai/cookbook/blob/trunk/federation/README.md)
115115

116116
### Retrieval-Augmented Generation (RAG)
117117

118-
- **Unified Search with Vector Similarity**: Perform efficient vector similarity search across structured and unstructured data, with native support for Amazon S3 Vectors for petabyte-scale storage and querying. Supports distance metrics like cosine similarity, Euclidean distance, or dot product. [Amazon S3 Vectors Recipe](https://github.com/spiceai/cookbook/blob/trunk/vectors/s3/README)
118+
- **Unified Search with Vector Similarity**: Perform efficient vector similarity search across structured and unstructured data, with native support for Amazon S3 Vectors for petabyte-scale storage and querying. Supports distance metrics like cosine similarity, Euclidean distance, or dot product. [Amazon S3 Vectors Recipe](https://github.com/spiceai/cookbook/blob/trunk/vectors/s3/README.md)
119119
- **Semantic Knowledge Layer**: Define a semantic context model to enrich data for AI. [Semantic Model Documentation](./features/semantic-model/index.md)
120-
- **Text-to-SQL**: Convert natural language queries into SQL using built-in NSQL and sampling tools. [Text-to-SQL Recipe](https://github.com/spiceai/cookbook/blob/trunk/text-to-sql/README)
120+
- **Text-to-SQL**: Convert natural language queries into SQL using built-in NSQL and sampling tools. [Text-to-SQL Recipe](https://github.com/spiceai/cookbook/blob/trunk/text-to-sql/README.md)
121121

122122
## FAQ
123123

0 commit comments

Comments
 (0)