Explain a VoidQL query
Checks a VoidQL SELECT and explains it without running it: the columns it would return and whether each can be NULL, the tables it reads (relations), the projects it covers, whether it reads personal data, and the database's index-based estimate of the rows it would scan (null when it cannot estimate).
The database checks the query without reading data, so it fails like query for a query that does not compile or that the database would refuse (voidql_rejected). Use it to check a query, or its cost, before query.
Guide: Query analytics with VoidQL
A project secret key: vh_sk_... for production, vh_sk_test_... for test. Keep it on your servers.
In: header
Path parameters
The project's id, proj_.... A secret key works only in the project it belongs to.
Request body
application/json
TypeScript definitions
Use the request body type in TypeScript.
The VoidQL SELECT to explain, up to 50,000 characters.
1 <= length <= 50000Examples
curl -X POST "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/analytics/voidql/explain" \ -H "Authorization: Bearer vh_sk_..." \ -H "Content-Type: application/json" \ -d '{ "query": "SELECT store, count() AS active FROM subscriptions WHERE is_active GROUP BY store" }'{ "columns": [ { "name": "store", "type": "String", "isNullable": false }, { "name": "active", "type": "UInt64", "isNullable": false } ], "relations": [ { "name": "subscriptions", "reads": 1 } ], "projectIds": [ "proj_tz4a98xxat96iws9zmbrgj3a" ], "hasPersonalData": false, "estimate": { "rows": 2152, "parts": 1, "marks": 1 }, "limits": { "maxExecutionSeconds": 20, "maxResultRows": 100000 }}{ "error": { "type": "invalid_request", "code": "invalid_body", "message": "The request body is invalid: Missing key\n at [\"query\"]" }}{ "error": { "type": "unauthenticated", "code": "invalid_api_key", "message": "This secret key is not valid." }}{ "error": { "type": "permission_denied", "code": "permission_denied", "message": "Insufficient permissions." }}{ "error": { "type": "not_found", "code": "project_not_found", "message": "There is no project proj_tz4a98xxat96iws9zmbrgj3a, or this credential cannot use it.", "param": "projectId" }}{ "error": { "type": "rate_limited", "code": "string", "message": "string", "param": "string" }}{ "error": { "type": "internal", "code": "internal_error", "message": "Something went wrong on our side. Try again, and contact support with the Request-Id header if it keeps failing." }}{ "error": { "type": "unavailable", "code": "string", "message": "string", "param": "string" }}Response body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
Errors
This operation adds no error codes of its own. It can fail with the errors every operation shares, such as unauthenticated; see Errors.
More in VoidQL
Something wrong or missing on this page? Tell us by email or on Discord.