Support the tck format for the output of EXPLAIN

[AntiTopQuark]

What type of PR is this?

• bug
• feature
• enhancement

What problem(s) does this PR solve?

Issue(s) number:

vesoft-inc/nebula#5274

Description:

Support the tck format for the output of EXPLAIN

How do you solve it?

In nebula-go,I have added a function called MakePlanByTck(), which is designed to return TCK-formatted result sets for the Nebula Console.

The MakePlanByTck() function will sequentially add columns for dependencies, profiling data, and empty operator info.

Since profiling data and operator info are also needed in the Row-formatted, the logic for generating profiling data and operator info have been separated into individual functions MakeProfilingData() and MakeOperatorInfo() for reusability.

Special notes for your reviewer, ex. impact of this fix, design document, etc:

related link:

• the pr link of nebula repo: Support the tck format for the output of EXPLAIN nebula#5414
• the pr link of nebula-console: Support the tck format for the output of EXPLAIN nebula-console#210
• the pr link of nebula nebula-go:Support the tck format for the output of EXPLAIN #265
• the pr link of nebula-doc:Support the tck format for the output of EXPLAIN nebula-docs#2017
• the pr link of nebula-doc-cn:Support the tck format for the output of EXPLAIN nebula-docs-cn#2664

[codecov-commenter]

Codecov Report

Patch coverage has no change and project coverage change: -1.03 ⚠️

Comparison is base (94abfb9) 62.29% compared to head (83adce1) 61.26%.

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #265      +/-   ##
==========================================
- Coverage   62.29%   61.26%   -1.03%     
==========================================
  Files           9        9              
  Lines        2270     2308      +38     
==========================================
  Hits         1414     1414              
- Misses        711      749      +38     
  Partials      145      145              

Impacted Files	Coverage Δ
result_set.go	59.09% <0.00%> (-2.48%)	⬇️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

[jievince]

Good job

[Aiee]

Could you add some tests to this PR? You could choose a test case from the .feature files from the Nebula repo and add it here.

[AntiTopQuark]

Could you add some tests to this PR? You could choose a test case from the .feature files from the Nebula repo and add it here.

Alright, I had considered adding some tests before. However, this feature only aims to specify the output format for explain/profile.

• couldn't find any tck test cases for explain format = "dot". Tck tests have their own format and don't check the output format. I'm not quite sure how to write a test case for format = "tck".
• Alternatively, should I write a unit test for MakePlanByTck()? Unit tests can only ensure the correctness of the function's output and can't test the output format of nebula-console.

[Aiee]

Makes sense.

[Aiee]

Makes sense.