feat(frontend): support xml, yaml format in explain output

lyang24 commented 1 week ago

I hereby agree to the terms of the RisingWave Labs, Inc. Contributor License Agreement.

What's changed and what's your intention?

Please do not leave this empty!

Please explain IN DETAIL what the changes are in this PR and why they are needed:

Summarize your change (mandatory) support xml yaml output formats in explain
How does this PR work? Need a brief introduction for the changed logic (optional) adding two keywords and two methods to serialize plan output
Describe clearly one logical change and avoid lazy messages (optional)
Describe any limitations of the current code (optional)
Refer to a related PR or issue link (optional) https://github.com/risingwavelabs/risingwave/issues/19123

Checklist

[ ] I have written necessary rustdoc comments
[ ] I have added necessary unit tests and integration tests
[ ] I have added test labels as necessary. See details.
[ ] I have added fuzzing tests or opened an issue to track them. (Optional, recommended for new SQL features #7934).
[ ] My PR contains breaking changes. (If it deprecates some features, please create a tracking issue to remove them in the future).
[ ] All checks passed in ./risedev check (or alias, ./risedev c)
[ ] My PR changes performance-critical code. (Please run macro/micro-benchmarks and show the results.)
[ ] My PR contains critical fixes that are necessary to be merged into the latest release. (Please check out the details)

Documentation

[x] My PR needs documentation updates. (Please use the Release note section below to summarize the impact on users)

Release note

If this PR includes changes that directly affect users or other significant modifications relevant to the community, kindly draft a release note to provide a concise summary of these changes. Please prioritize highlighting the impact these changes will have on users.

Release note Public Preview: Do note that the structure and format of EXPLAIN FORMAT YAML, XML is considered unstable, and may change overtime.

After this PR, two new explain option are supported FORMAT (XML | YAML) For FORMAT XML, it will output xml for logical and physical plans. For FORMAT YAML, it will output xml for logical and physical plans. examples: YAML

CREATE TABLE t (v1 int);
    explain (physical, format yaml) create materialized view m1 as SELECT approx_percentile(0.5) WITHIN GROUP (order by v1) from t;

YAML result

    name: StreamMaterialize
    fields:
      columns:
      - approx_percentile
      pk_columns: []
      pk_conflict: NoCheck
      stream_key: []
    children:
    - name: StreamGlobalApproxPercentile
      fields:
        quantile: 0.5:Float64
        relative_error: 0.01:Float64
      children:
      - name: StreamExchange
        fields:
          dist: Single
        children:
        - name: StreamLocalApproxPercentile
          fields:
            percentile_col: $expr1
            quantile: 0.5:Float64
            relative_error: 0.01:Float64
          children:
          - name: StreamProject
            fields:
              exprs:
              - t.v1::Float64 as $expr1
              - t._row_id
            children:
            - name: StreamTableScan
              fields:
                columns:
                - v1
                - _row_id
                table: t
              children: []

XML

  CREATE TABLE t (v1 int);
    explain (physical, format xml) create materialized view m1 as SELECT approx_percentile(0.5) WITHIN GROUP (order by v1) from t;

XML RESULT

 <XmlNode><name>StreamMaterialize</name><fields><columns>approx_percentile</columns><pk_conflict>NoCheck</pk_conflict></fields><children><name>StreamGlobalApproxPercentile</name><fields><quantile>0.5:Float64</quantile><relative_error>0.01:Float64</relative_error></fields><children><name>StreamExchange</name><fields><dist>Single</dist></fields><children><name>StreamLocalApproxPercentile</name><fields><percentile_col>$expr1</percentile_col><quantile>0.5:Float64</quantile><relative_error>0.01:Float64</relative_error></fields><children><name>StreamProject</name><fields><exprs>t.v1::Float64 as $expr1</exprs><exprs>t._row_id</exprs></fields><children><name>StreamTableScan</name><fields><columns>v1</columns><columns>_row_id</columns><table>t</table></fields></children></children></children></children></children></XmlNode>

kwannoel commented 1 week ago

Thanks for your contribution!

There are more related issues for EXPLAIN: https://github.com/risingwavelabs/risingwave/issues/19361. If you're interested, feel free to contribute for these as well.

kwannoel commented 1 week ago

Could you also add a Release Note, since this is a new feature. You can copy the Release Note from https://github.com/risingwavelabs/risingwave/pull/19041, and adapt it for yaml and xml formats.

lyang24 commented 1 week ago

Could you also add a Release Note, since this is a new feature. You can copy the Release Note from #19041, and adapt it for yaml and xml formats.

Yes i mirrored the release note with the example pr, do we also need the release note in commit msg?

kwannoel commented 1 week ago

Could you also add a Release Note, since this is a new feature. You can copy the Release Note from #19041, and adapt it for yaml and xml formats.

Yes i mirrored the release note with the example pr, do we also need the release note in commit msg?

No just PR description is fine.

risingwavelabs / risingwave