techdocsmith commented on code in PR #16001:
URL: https://github.com/apache/druid/pull/16001#discussion_r1515079012
##########
docs/api-reference/sql-api.md:
##########
@@ -53,11 +53,25 @@ The request body takes the following properties:
* `query`: SQL query string.
* `resultFormat`: String that indicates the format to return query results.
Select one of the following formats:
- * `object`: Returns a JSON array of JSON objects with the HTTP response
header `Content-Type: application/json`.
- * `array`: Returns a JSON array of JSON arrays with the HTTP response header
`Content-Type: application/json`.
- * `objectLines`: Returns newline-delimited JSON objects with a trailing
blank line. Returns the HTTP response header `Content-Type: text/plain`.
- * `arrayLines`: Returns newline-delimited JSON arrays with a trailing blank
line. Returns the HTTP response header `Content-Type: text/plain`.
- * `csv`: Returns a comma-separated values with one row per line and a
trailing blank line. Returns the HTTP response header `Content-Type: text/csv`.
+ * `object`: Returns a JSON array of JSON objects with the HTTP response
header `Content-Type: application/json`.
+ Each object's field names match the columns returned by the SQL query,
and are provided in the same order as the SQL query.
+
+ * `array`: Returns a JSON array of JSON arrays with the HTTP response header
`Content-Type: application/json`.
+ Each inner array has elements matching the columns returned by the SQL
query, in order.
+
+ * `objectLines`: Returns newline-delimited JSON objects with the HTTP
response header `Content-Type: text/plain`.
+ Newline separation can make it easier to parse the entire response set as
a stream if you don't have a streaming JSON parser.
+ To make it possible to detect a truncated response, this format includes
a trailer of one blank newline character.
+
+ * `arrayLines`: Returns newline-delimited JSON arrays with the HTTP response
header `Content-Type: text/plain`.
+ Newline separation can make it easier to parse the entire response set as
a stream if you don't have a streaming JSON parser.
+ To make it possible to detect a truncated response, this format includes
a trailer of one blank newline character.
Review Comment:
```suggestion
This format includes a trailer of one blank newline character so you can
detect a truncated response.
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
