Skip to main content

explain_handler

fraiseql_server::routes::api::admin

Function explain_handler 

Source 
pub async fn explain_handler<A: DatabaseAdapter + 'static>(
    __arg0: State<AppState<A>>,
    __arg1: Json<ExplainRequest>,
) -> Result<Json<ApiResponse<ExplainResult>>, ApiError>
Expand description

Run EXPLAIN (ANALYZE, BUFFERS, FORMAT JSON) for a named query.

Accepts a query name and optional variable filters, then executes EXPLAIN ANALYZE against the backing PostgreSQL view using the exact same parameterized SQL that a live query would use.

§Errors

  • 400 Bad Request — empty query name, unknown query, or mutation given
  • 500 Internal Server Error — database execution failure

Requires admin token authentication.