v1

latestOpenAPI 3.1.1Apache 2.02026-07-2654130166.5 KB

Table

Data

Get query execution plan explanation

Get the query execution plan for a query against table id. Returns a human-readable explanation of how the query will be executed.

REST NAMESPACE ONLY REST namespace returns the response as a plain string instead of the ExplainTableQueryPlanResponse JSON object.

post/v1/table/{id}/explain_plan

contextContext

Arbitrary context as key-value pairs. How to use the context is custom to the specific implementation.

On a request, it carries caller-provided context to the implementation. On a response, it carries implementation-provided context back to the caller.

REST NAMESPACE ONLY Context entries are mapped to and from HTTP headers using the header. prefix:

On a request, any entry whose key starts with header. is sent as an HTTP request header with the prefix stripped. For example, the entry {"header.Authorization": "Bearer abc"} is sent as the request header Authorization: Bearer abc.
On a response, every HTTP response header is returned as an entry whose key is the header name prefixed with header.. For example, the response header x-request-id: abc123 is returned as the entry {"header.x-request-id": "abc123"}.

idstring[]

branchstring

Branch to target. When not specified, the main branch is used.

verboseboolean

Whether to return verbose explanation

Query execution plan explanation

string required

Human-readable query execution plan