feat: add comment on clause support

[jetjinser]

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

What's changed and what's your intention?

resolve #12663.

Support comment on clause:

• table
• column

New description field in TableCatalog and ColumnDesc.

new rw_catalog.rw_description:

• objoid: table_id, view_id, function_id, etc.
• classoid: rw_tables, rw_views, rw_functions, etc.
• objsubid: When it is not None, it means column number. In this case, objoid should be table_id currently.
• description: description set in comment on <object_type> is <description>;

Checklist

• I have written necessary rustdoc comments
• I have added necessary unit tests and integration tests
• I have added fuzzing tests or opened an issue to track them. (Optional, recommended for new SQL features Sqlsmith: Sql feature generation #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

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

Release note

new clause comment on <object_type> is <description>.
object_type := table|column

TODO

• how to bind column in better way.
• is all catalog need description?
• default description for builtin tables, functions, etc. in future pr
• show description in describe returned
• emulate pg_description and pg_shdescription in future pr
• impl obj_description, col_description and obj_shdescription in future pr
• Is the id of rw unique across tables, schemas, etc.
• do we need rw_description or rw_shdescription
• is database shared in cluster in rw?

[github-actions]

license-eye has totally checked 4261 files.

Valid	Invalid	Ignored	Fixed
1891	2	2368	0

Click to see the invalid file list

• src/frontend/src/catalog/system_catalog/rw_catalog/rw_description.rs
• src/frontend/src/handler/comment.rs

[jetjinser]

@stdrc plz help me 😿.

[neverchanje]

@jetjinser You can focus on the column comment in this PR to reduce the impact radius, the required tests and docs. I suggest adding the supports for other database objects in future PRs.

[stdrc]

It seems that None and Some("") are different? How to distinguish them here?

[jetjinser]

The former is NULL and the latter is just an empty string, which should look the same in the frontend, but should be different when e2e test and interact with other programs.
In addition, comment on ... is NULL and comment on ... '' are both reasonable queries.

[stdrc]

Is this method expected to be used by other callers? It not, then it's just part of the logic of read_rw_description, rather than a public interface of Catalog. I guess it's OK to just filter the result at the caller side.

[stdrc]

Seems better to assign to a variable outside flatmap as it's duplicated below.

[stdrc]

Suggested change

	fn fmt_col_project<T, C>(columns: &[ColumnDesc], cb: C) -> String
	where
	T: Display + ?Sized,
	C: FnMut(&ColumnDesc) -> &T,
	{
	format!(
	"{}",
	display_comma_separated(&columns.iter().map(cb).collect::<Vec<_>>())
	)
	}
	// Convert primary key to rows
	if !pk_columns.is_empty() {
	rows.push(Row::new(vec![
	Some("primary key".into()),
	Some(
	format!(
	"{}",
	display_comma_separated(&pk_columns.into_iter().map(|x| x.name).collect_vec()),
	)
	.into(),
	),
	None,
	Some(fmt_col_project(&pk_columns, |x| &x.name).into()),
	None, // Is Hidden
	None, // Description
	]));
	}
	// Convert distribution keys to rows
	if !dist_columns.is_empty() {
	rows.push(Row::new(vec![
	Some("distribution key".into()),
	Some(
	display_comma_separated(
	&dist_columns.into_iter().map(|col| col.name).collect_vec(),
	)
	.to_string()
	.into(),
	),
	None,
	Some(fmt_col_project(&dist_columns, |x| &x.name).into()),
	None, // Is Hidden
	None, // Description
	]));
	}
	fn concat<T>(display_elems: impl IntoIterator<Item = T>) -> String
	where
	T: Display,
	{
	format!(
	"{}",
	display_comma_separated(&display_elems.into_iter().collect::<Vec<_>>())
	)
	}
	// Convert primary key to rows
	if !pk_columns.is_empty() {
	rows.push(Row::new(vec![
	Some("primary key".into()),
	Some(concat(pk_columns.iter().map(|x| &x.name)).into()),
	None, // Is Hidden
	None, // Description
	]));
	}
	// Convert distribution keys to rows
	if !dist_columns.is_empty() {
	rows.push(Row::new(vec![
	Some("distribution key".into()),
	Some(concat(dist_columns.iter().map(|x| &x.name)).into()),
	None, // Is Hidden
	None, // Description
	]));
	}

[codecov]

Codecov Report

Merging #12849 (b41c9c6) into main (39f71a1) will decrease coverage by 0.06%.
Report is 1 commits behind head on main.
The diff coverage is 37.27%.

@@            Coverage Diff             @@
##             main   #12849      +/-   ##
==========================================
- Coverage   68.56%   68.51%   -0.06%     
==========================================
  Files        1496     1498       +2     
  Lines      251440   251722     +282     
==========================================
+ Hits       172389   172455      +66     
- Misses      79051    79267     +216     

Flag	Coverage Δ
rust	68.51% <37.27%> (-0.06%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files	Coverage Δ
src/common/src/catalog/column.rs	80.42% <100.00%> (+0.50%)	⬆️
src/common/src/catalog/test_utils.rs	100.00% <100.00%> (ø)
src/connector/src/parser/protobuf/parser.rs	86.20% <100.00%> (+0.02%)	⬆️
src/frontend/src/binder/expr/mod.rs	74.64% <100.00%> (+0.10%)	⬆️
src/frontend/src/catalog/system_catalog/mod.rs	93.30% <100.00%> (+0.05%)	⬆️
...atalog/system_catalog/pg_catalog/pg_description.rs	100.00% <100.00%> (ø)
src/frontend/src/catalog/table_catalog.rs	94.06% <100.00%> (+0.07%)	⬆️
src/frontend/src/handler/create_table.rs	84.29% <100.00%> (+0.02%)	⬆️
src/frontend/src/handler/util.rs	88.56% <100.00%> (+0.03%)	⬆️
...tend/src/optimizer/plan_node/stream_materialize.rs	97.44% <100.00%> (+0.01%)	⬆️
... and 20 more

... and 2 files with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[gitguardian]

⚠️ GitGuardian has uncovered 1 secret following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

🔎 Detected hardcoded secret in your pull request

GitGuardian id	Secret	Commit	Filename
7648795	Generic CLI Secret	b41c9c6	integration_tests/iceberg-cdc/run_test.sh	View secret

🛠 Guidelines to remediate hardcoded secrets

1. Understand the implications of revoking this secret by investigating where it is used in your code.
2. Replace and store your secret safely. Learn here the best practices.
3. Revoke and rotate this secret.
4. If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.

To avoid such incidents in the future consider

• following these best practices for managing and storing secrets including API keys and other credentials
• install secret detection on pre-commit to catch secret before it leaves your machine and ease remediation.

---

<sup>🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.

Our GitHub checks need improvements? Share your feedbacks!</sup>

[yezizp2012]

LGTM! Good job!