You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@druid.apache.org by "adarshsanjeev (via GitHub)" <gi...@apache.org> on 2024/03/04 05:22:28 UTC
[PR] Update docs to document breaking change in explain attributes (druid)
adarshsanjeev opened a new pull request, #16031:
URL: https://github.com/apache/druid/pull/16031
Updates the docs to include a breaking change made regarding the attributes returned by an explain query. The return type of the field `targetDataSource` was 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: https://github.com/apache/druid/pull/16004
--
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: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org
Re: [PR] Update docs to document breaking change in explain attributes (druid)
Posted by "adarshsanjeev (via GitHub)" <gi...@apache.org>.
adarshsanjeev commented on code in PR #16031:
URL: https://github.com/apache/druid/pull/16031#discussion_r1513087732
##########
docs/release-info/release-notes.md:
##########
@@ -57,6 +57,12 @@ For tips about how to write a good release note, see [Release notes](https://git
This section contains important information about new and existing features.
+### 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.
Review Comment:
Moved to the upgrade section
--
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: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org
Re: [PR] Update docs to document breaking change in explain attributes (druid)
Posted by "cryptoe (via GitHub)" <gi...@apache.org>.
cryptoe commented on code in PR #16031:
URL: https://github.com/apache/druid/pull/16031#discussion_r1512992585
##########
docs/release-info/release-notes.md:
##########
@@ -57,6 +57,35 @@ For tips about how to write a good release note, see [Release notes](https://git
This section contains important information about new and existing features.
+### Breaking change
Review Comment:
```suggestion
### Changes in `targetDataSource` payload present in the explain plan for MSQ queries
```
--
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: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org
Re: [PR] Update docs to document breaking change in explain attributes (druid)
Posted by "cryptoe (via GitHub)" <gi...@apache.org>.
cryptoe commented on code in PR #16031:
URL: https://github.com/apache/druid/pull/16031#discussion_r1512991550
##########
docs/release-info/upgrade-notes.md:
##########
@@ -30,6 +30,10 @@ For the full release notes for a specific version, see the [releases page](https
### Upgrade notes
+### Breaking change
Review Comment:
```suggestion
### Changes in `targetDataSource` payload present in the explain plan for MSQ queries
```
--
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: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org
Re: [PR] Update docs to document breaking change in explain attributes (druid)
Posted by "adarshsanjeev (via GitHub)" <gi...@apache.org>.
adarshsanjeev commented on PR #16031:
URL: https://github.com/apache/druid/pull/16031#issuecomment-1982318343
@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?
--
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: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org
Re: [PR] Update docs to document breaking change in explain attributes (druid)
Posted by "abhishekrb19 (via GitHub)" <gi...@apache.org>.
abhishekrb19 commented on code in PR #16031:
URL: https://github.com/apache/druid/pull/16031#discussion_r1511091259
##########
docs/querying/sql-translation.md:
##########
@@ -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.
Review Comment:
```suggestion
- `targetDataSource`: a JSON object representing the target datasource in an INSERT or REPLACE statement
```
##########
docs/querying/sql-translation.md:
##########
@@ -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
Review Comment:
For 29.0.0, could you also please update `targetDataSource` format in this doc to the JSON object in these example `EXPLAIN PLAN` outputs [here](https://github.com/apache/druid/blob/master/docs/querying/sql-translation.md?plain=1#L447) and [here](https://github.com/apache/druid/blob/master/docs/querying/sql-translation.md?plain=1#L668)?
--
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: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org
Re: [PR] Update docs to document breaking change in explain attributes (druid)
Posted by "317brian (via GitHub)" <gi...@apache.org>.
317brian commented on PR #16031:
URL: https://github.com/apache/druid/pull/16031#issuecomment-1981490490
@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
--
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: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org
Re: [PR] Update docs to document breaking change in explain attributes (druid)
Posted by "cryptoe (via GitHub)" <gi...@apache.org>.
cryptoe commented on code in PR #16031:
URL: https://github.com/apache/druid/pull/16031#discussion_r1511006201
##########
docs/release-info/release-notes.md:
##########
@@ -57,6 +57,12 @@ For tips about how to write a good release note, see [Release notes](https://git
This section contains important information about new and existing features.
+### 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.
Review Comment:
Could you add more details like it impacts only MSQ queries and give an example of the new json object.
--
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: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org
Re: [PR] Update docs to document breaking change in explain attributes (druid)
Posted by "adarshsanjeev (via GitHub)" <gi...@apache.org>.
adarshsanjeev commented on code in PR #16031:
URL: https://github.com/apache/druid/pull/16031#discussion_r1513047191
##########
docs/querying/sql-translation.md:
##########
@@ -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
Review Comment:
Changed
--
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: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org
Re: [PR] Update docs to document breaking change in explain attributes (druid)
Posted by "cryptoe (via GitHub)" <gi...@apache.org>.
cryptoe commented on code in PR #16031:
URL: https://github.com/apache/druid/pull/16031#discussion_r1512988258
##########
docs/release-info/release-notes.md:
##########
@@ -57,6 +57,12 @@ For tips about how to write a good release note, see [Release notes](https://git
This section contains important information about new and existing features.
+### 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.
Review 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.
--
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: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org
Re: [PR] Update docs to document breaking change in explain attributes (druid)
Posted by "cryptoe (via GitHub)" <gi...@apache.org>.
cryptoe merged PR #16031:
URL: https://github.com/apache/druid/pull/16031
--
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: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org
Re: [PR] Update docs to document breaking change in explain attributes (druid)
Posted by "317brian (via GitHub)" <gi...@apache.org>.
317brian commented on PR #16031:
URL: https://github.com/apache/druid/pull/16031#issuecomment-1984091113
Oh ok. It's not needed then. It was little unclear to me cause `29` can be read as all versions of 29 rather than `29.0.0` specifically.
--
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: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org