This endpoint is in preview and may be modified or removed at any time.
To use this endpoint, add preview=true to the request query parameters.
Executes a new query. Only the user that invoked the query can operate on the query. The size of query results are limited by default to 1 million rows. Contact your Palantir representative to discuss limit increases.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:sql-queries-execute.
objectstringThe SQL query to execute. Queries should confirm to the Spark SQL dialect. This supports SELECT queries only. Refer the following documentation on the supported syntax for referencing datasets in SQL queries.
list<BranchName>The list of branch ids to use as fallbacks if the query fails to execute on the primary branch. If a
is not explicitly provided in the SQL query, the resource will be queried on the first fallback branch
provided that exists. If no fallback branches are provided the default branch is used. This is
master for most enrollments.
unionobjectobjectobjectobject1
2
3
4
5
curl -X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/sqlQueries/execute?preview=true" \
-d '{"fallbackBranchIds":["master"],"query":"SELECT * FROM `/Path/To/Dataset`"}'| Error Name | ||
|---|---|---|
Read | Error Code | PERMISSION_DENIED |
| Status Code | 403 | |
| Description | The provided token does not have permission to access the inputs to the query. | |
| Parameters | rids | |
Query | Error Code | INVALID_ARGUMENT |
| Status Code | 400 | |
| Description | The query cannot be parsed. | |
| Parameters | errorMessage | |
Query | Error Code | INVALID_ARGUMENT |
| Status Code | 400 | |
| Description | The query was canceled. | |
| Parameters | queryId | |
Query | Error Code | PERMISSION_DENIED |
| Status Code | 403 | |
| Description | The provided token does not have permission to access the given query. | |
| Parameters | queryId | |
Query | Error Code | INTERNAL |
| Status Code | 500 | |
| Description | The query failed. | |
| Parameters | queryId, errorMessage | |
Query | Error Code | INVALID_ARGUMENT |
| Status Code | 400 | |
| Description | The query is running. | |
| Parameters | queryId | |
Execute | Error Code | PERMISSION_DENIED |
| Status Code | 403 | |
| Description | Could not execute the SqlQuery. | |
| Parameters | | |
See Errors for a general overview of errors in the platform.