Update docs to document breaking change in explain attributes #16031
Conversation
docs/release-info/release-notes.md
Outdated
| ### Breaking change | ||
|
|
||
| Druid 29 has a breaking change for EXPLAIN queries. | ||
| In the attribute field returned as part of the result for an explain query, the value of the key `targetDataSource` from a string to a JSON object. |
There was a problem hiding this comment.
Could you add more details like it impacts only MSQ queries and give an example of the new json object.
There was a problem hiding this comment.
This has been added on top of the release notes. Which kind of seem bad. This should be present in the upgrade section which is there near the end of the file.
There was a problem hiding this comment.
Moved to the upgrade section
| @@ -71,7 +71,7 @@ EXPLAIN PLAN statements return: | |||
| - a `RESOURCES` column that describes the resources used in the query | |||
| - an `ATTRIBUTES` column that describes the attributes of the query, including: | |||
| - `statementType`: the SQL statement type | |||
| - `targetDataSource`: the target datasource in an INSERT or REPLACE statement | |||
| - `targetDataSource`: a JSON object representing the target datasource in an INSERT or REPLACE statement. | |||
| - `partitionedBy`: the time-based partitioning granularity in an INSERT or REPLACE statement | |||
|
@adarshsanjeev The relevant changes will also need to go into the 29.0.1 branch so that it gets included in those docs and goes out with that release |
|
@317brian, the change should only be present in the 29.0, and was reverted in 29.0.1, so the documentation would not need to be updated, right? |
|
Oh ok. It's not needed then. It was little unclear to me cause |
Updates the docs to include a breaking change made regarding the attributes returned by an explain query. The return type of the field
targetDataSourcewas changed to an object instead of a string containing the data source name.This change is only present in Druid 29, and not in future versions, so it has been documented here. The change has been reverted in future versions here: #16004