Skip to content

Document the streaming EXPLAIN ANALYZE HTTP API #2719

Description

@fengjiachun

Context

GreptimeDB v1.2 introduces a streaming SQL analysis endpoint:

The current docs only expose the related configuration and do not document the API contract.

Documentation work

Add HTTP API/reference documentation covering:

  • A request example using one EXPLAIN ANALYZE VERBOSE statement.
  • Accepted format constraints and rejection of non-explain or multi-statement requests.
  • SSE event types: metrics, final, canceled, and error.
  • Metrics as complete, best-effort snapshots rather than deltas, including snapshot coalescing.
  • Terminal event behavior and client disconnect cancellation.
  • No resume, reconnect, or detached-query lifecycle.
  • The v1.2 default for the related configuration, verified against the v1.2 source/tag.

Scope

Update both English and Chinese documentation in:

  • Nightly
  • v1.2

Completion criteria

  • The endpoint has a complete request and event-stream example.
  • Lifecycle, cancellation, and snapshot semantics are explicit.
  • Version-sensitive defaults are verified against v1.2.
  • English and Chinese content is aligned.
  • Affected locale builds pass.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions