execute
Executes a SQL statement and returns the results. Supports requests for both regular and streaming responses.
With streaming, results return as they become available using the HTTP chunked transfer encoding. Each chunk contains a valid JSON object that you can parse independently.
For details on streaming, including large-response configuration, see the header parameters.
You can specify the database in the request body. If you do not specify the database, the Ocient System defaults to the database specified in the authentication token or system settings. If you specify a database in the request, this value overrides any alternate database value specified as a body parameter.
Documentation Index
Fetch the complete documentation index at: https://docs.ocient.com/llms.txt
Use this file to discover all available pages before exploring further.
Headers
An access token to connect to your Ocient System.
To receive an access token, you must provide your username and password using the login endpoint.
The system passes the credentials using the Authorization HTTP header using Base64-encoded Basic Authentication.
Specifies the request body format. Options include:
application/json
Description: The standard option for submitting queries and receiving responses as a single JSON object or array. Use when submitting queries with relatively small or moderate result sets or when you want the entire result set in one response.
application/stream+json
Description: Enables streaming of multiple JSON objects, allowing the API to send results as they become available. Use when querying large tables or expecting a large volume of results or when you want to process each row or result as soon as it is received, without waiting for the full response.
Supported compression algorithms for responses. You can specify multiple algorithms as a comma-separated list.
Supported values are: "gzip" "deflate" "be" (Brotli) or combinations like: "gzip, be".
Note: For large result sets, compression can impact performance. Without compression, the result sets can be chunks of rows processed in a streaming fashion. With compression, the entire result set must be compressed before it is returned to the client. The client side must decompress the entire result set before processing any rows.
Supported response media types. Regardless of the Accept header, the API returns large query results using chunked encoding. Also, see the note about compression in the accept-encoding parameter.
Supported values are:
"application/json" (default) "application/stream+json"
Indicates the preferred encoding type from those specified in the accept-encoding parameter. This header provides fine-grained control when the accept-encoding parameter contains multiple values, allowing the client to specify which encoding is preferred for this specific request explicitly.
Supported values are:
"gzip" "br"
Specifies the chosen compression level for the selected encoding algorithm. Values range from 1 (fastest, least compression) to 9 (slowest, maximum compression). The exact behavior depends on the specific compression algorithm.
Path Parameters
The specific database in your system for the API call.
If you do not specify the database, the executed query defaults to the database from the authentication token or system settings.
If you include a database in the path, this value overrides any alternate database value specified as a body parameter.
Query Parameters
Sets the format for the requested data.
Note: This parameter applies only when using Content-Type: text/plain. When using Content-Type: application/json, specify the format in the request body.
Supported values are:
"array" — Returns schema and data as arrays (more efficient for large data sets). (default) "collection" — Returns data as JSON objects (more convenient for client processing).
Example: format=collection
The schema to use for the SQL statement.
Example: schema=mydata
Note: This parameter applies only when using Content-Type: text/plain. When using Content-Type: application/json, specify the schema in the request body.
Body
A valid SQL statement to execute.
Example: statement=SELECT * FROM customers LIMIT 10;
You can include parameters to substitute in the SQL statement by including them in the params body parameter.
A specific database in your system for the API call.
If you do not specify this parameter, the executed query defaults to the database from the authentication token or system settings.
Sets the output format of the query result data.
Supported values are:
"array" — Returns the schema and data as arrays (more efficient for large data sets). (default) "collection" — Returns data as JSON objects (more convenient for client processing).
Parameters to substitute in the SQL statement for values enclosed in braces. The keys should match the parameter names in the statement (without the enclosing braces). Wrap string values in single quotes. All other data types do not use quotes.
Example: If your SQL statement is SELECT * FROM orders WHERE order_date > {start_date}, then your API request should include values in the params body parameter, such as {'start_date': '2023-01-01'}.
The number of rows to return in each chunk for streaming responses. This value must be 0 or greater. A value of 0 (default) means the database determines how many rows to return.
Use smaller values for interactive applications (100-1000 rows). For batch processing, use larger values (5000-10000 rows).
The maximum number of rows to return. The default value is 9223372036854776000.
Note: Adding a LIMIT clause to a SQL query is generally a better method to restrict the number of rows, as the query engine still generates the total number of rows, but only returns this value to the client.