Skip to content

Add async queries cookbook recipe#357

Merged
lukekim merged 5 commits into
trunkfrom
lukim/async-queries-recipe
Mar 2, 2026
Merged

Add async queries cookbook recipe#357
lukekim merged 5 commits into
trunkfrom
lukim/async-queries-recipe

Conversation

@lukekim
Copy link
Copy Markdown
Contributor

@lukekim lukekim commented Mar 2, 2026

Summary

Adds a new cookbook recipe demonstrating the async queries API for long-running SQL queries in distributed cluster mode.

Recipe: async-queries/

Covers:

  • mTLS certificate setup with spice cluster tls
  • Scheduler and executor startup configuration
  • Submitting queries via HTTP REST API (curl examples)
  • Polling for completion and retrieving paginated results
  • spice query CLI: submit, list, status, results, cancel
  • Interactive REPL session with dot-commands
  • Parameterized queries with bind variables
  • Per-query timeouts and maximum result size limits

References:

Demonstrates the async queries API for long-running SQL queries in
distributed cluster mode:
- mTLS certificate setup with spice cluster tls
- Scheduler and executor startup
- Submit/poll/retrieve via HTTP REST API (curl examples)
- spice query CLI and interactive REPL usage
- Parameterized queries, timeouts, and size limits

References:
- https://spiceai.org/docs/features/async-queries-api
- https://spiceai.org/docs/features/distributed-query
@lukekim lukekim self-assigned this Mar 2, 2026
@lukekim lukekim added the documentation Improvements or additions to documentation label Mar 2, 2026
@lukekim lukekim added this to the v2.0 milestone Mar 2, 2026
@lukekim lukekim enabled auto-merge (squash) March 2, 2026 22:31
@lukekim lukekim requested a review from krinart March 2, 2026 22:31
@lukekim lukekim merged commit 24bf225 into trunk Mar 2, 2026
7 checks passed
@lukekim lukekim deleted the lukim/async-queries-recipe branch March 2, 2026 22:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants