SQL: Add type headers to response formats. #11914
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This allows clients to interpret the results of SQL queries without having to guess types.
|
I reviewed the docs and also tried out locally all the combinations of results format and type headers. Looks great to me!
|
kfaraz
reviewed
Nov 12, 2021
docs/querying/sql.md
Outdated
| @@ -879,6 +879,8 @@ Submit your query as the value of a "query" field in the JSON object within the | |||
| |`query`|SQL query string.| none (required)| | |||
| |`resultFormat`|Format of query results. See [Responses](#responses) for details.|`"object"`| | |||
| |`header`|Whether or not to include a header row for the query result. See [Responses](#responses) for details.|`false`| | |||
| |`typesHeader`|Whether or not to include type information in the header. Only applicable when `header` is `true`. See [Responses](#responses) for details.|`false`| | |||
| |`sqlTypesHeader`|Whether or not to include type information in the header. Only applicable when `header` is `true`. See [Responses](#responses) for details.|`false`| | |||
There was a problem hiding this comment.
Suggested change
| |`sqlTypesHeader`|Whether or not to include type information in the header. Only applicable when `header` is `true`. See [Responses](#responses) for details.|`false`| | |
| |`sqlTypesHeader`|Whether or not to include SQL type information in the header. Only applicable when `header` is `true`. See [Responses](#responses) for details.|`false`| |
There was a problem hiding this comment.
Whoops, missed that. Fixed.
| @@ -93,4 +96,44 @@ public void close() throws IOException | |||
| { | |||
| jsonGenerator.close(); | |||
| } | |||
|
|
|||
| static void writeHeader( | |||
There was a problem hiding this comment.
Do we need to keep these new methods static?
If it's for testing, we could test these by calling the writeHeader method provided by the interface ResultFormat.Writer.
Same comment in other writer implementations too.
There was a problem hiding this comment.
ObjectWriter.writeHeader is static because ObjectLinesWriter also uses it; same for ArrayWriter.writeHeader and ArrayLinesWriter.
docs/querying/sql.md
Outdated
Comment on lines
969
to
971
| `X-Druid-SQL-Header-Included: yes` if `header` was set to true and if the version of Druid you are talking to | ||
| understands the `typesHeader` and `sqlTypesHeader` parameters. This happens even if you do not set `typesHeader` | ||
| or `sqlTypesHeader`. |
There was a problem hiding this comment.
Suggested change
| `X-Druid-SQL-Header-Included: yes` if `header` was set to true and if the version of Druid you are talking to | |
| understands the `typesHeader` and `sqlTypesHeader` parameters. This happens even if you do not set `typesHeader` | |
| or `sqlTypesHeader`. | |
| `X-Druid-SQL-Header-Included: yes` if `header` was set to true and if the version of Druid the client is connected to | |
| understands the `typesHeader` and `sqlTypesHeader` parameters. Note that this header is set irrespective of whether `typesHeader` | |
| or `sqlTypesHeader` are set or not. |
There was a problem hiding this comment.
I adopted similar language. Thanks for the suggestion.
abhishekagarwal87
approved these changes
Nov 13, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This allows clients to interpret the results of SQL queries without having to guess types.