fix(ddl): include table comments in generated DDL

This commit is contained in:
gggaiitx authored and GitHub committed 2026-07-13 21:06:08 +08:00
1 parent 5999fbf00c
commit 8a6640e184
12 files changed
+387 -17

No files matched your search

+81 -8
View File
@@ -5837,11 +5837,38 @@ mod ddl_tests {
display_name.comment = Some("User's display name".to_string());
let columns = vec![display_name];
let ddl = render_postgres_table_ddl("public", "users", &columns, &[], &[]);
let ddl = render_postgres_table_ddl("public", "users", &columns, &[], &[], None);
assert!(ddl.contains("COMMENT ON COLUMN \"public\".\"users\".\"display_name\" IS 'User''s display name';"));
}
#[test]
fn postgres_table_ddl_includes_table_comment() {
let columns = vec![column("id", "integer")];
let ddl = render_postgres_table_ddl("public", "users", &columns, &[], &[], Some("User table"));
assert!(ddl.contains("COMMENT ON TABLE \"public\".\"users\" IS 'User table';"));
}
#[test]
fn postgres_table_ddl_omits_table_comment_when_empty() {
let columns = vec![column("id", "integer")];
let ddl = render_postgres_table_ddl("public", "users", &columns, &[], &[], Some(""));
assert!(!ddl.contains("COMMENT ON TABLE"));
}
#[test]
fn postgres_table_ddl_preserves_table_comment_whitespace() {
let columns = vec![column("id", "integer")];
let ddl = render_postgres_table_ddl("public", "users", &columns, &[], &[], Some(" User table "));
assert!(ddl.contains("COMMENT ON TABLE \"public\".\"users\" IS ' User table ';"));
}
#[test]
fn postgres_table_ddl_includes_generated_identity() {
let mut id = column("id", "integer");
@@ -5849,7 +5876,7 @@ mod ddl_tests {
id.is_primary_key = true;
id.extra = Some("generated by default as identity".to_string());
let ddl = render_postgres_table_ddl("public", "users", &[id], &[], &[]);
let ddl = render_postgres_table_ddl("public", "users", &[id], &[], &[], None);
assert!(ddl.contains("\"id\" integer generated by default as identity NOT NULL"), "ddl: {ddl}");
}
@@ -5887,7 +5914,7 @@ mod ddl_tests {
},
];
let ddl = render_postgres_table_ddl("public", "aaa_1", &columns, &[], &foreign_keys);
let ddl = render_postgres_table_ddl("public", "aaa_1", &columns, &[], &foreign_keys, None);
assert!(ddl.contains(
"CONSTRAINT \"aaa_1\" FOREIGN KEY (\"a\", \"b\", \"c\") REFERENCES \"aaa_2\"(\"a\", \"b\", \"c\")"
@@ -5901,7 +5928,7 @@ mod ddl_tests {
display_name.comment = Some("User's display name".to_string());
let columns = vec![display_name];
let ddl = render_sqlserver_table_ddl("dbo", "users", &columns, &[], &[]);
let ddl = render_sqlserver_table_ddl("dbo", "users", &columns, &[], &[], None);
assert!(ddl.contains("CREATE TABLE [dbo].[users] (\n [display]]name] nvarchar(100)\n);"));
assert!(ddl.contains(
@@ -5909,6 +5936,35 @@ mod ddl_tests {
));
}
#[test]
fn sqlserver_table_ddl_includes_table_comment() {
let columns = vec![column("id", "int")];
let ddl = render_sqlserver_table_ddl("dbo", "users", &columns, &[], &[], Some("User table"));
assert!(ddl.contains(
"EXEC sys.sp_addextendedproperty @name=N'MS_Description', @value=N'User table', @level0type=N'SCHEMA', @level0name=N'dbo', @level1type=N'TABLE', @level1name=N'users';"
));
}
#[test]
fn sqlserver_table_ddl_omits_table_comment_when_empty() {
let columns = vec![column("id", "int")];
let ddl = render_sqlserver_table_ddl("dbo", "users", &columns, &[], &[], Some(""));
assert!(!ddl.contains("MS_Description"));
}
#[test]
fn sqlserver_table_ddl_preserves_table_comment_whitespace() {
let columns = vec![column("id", "int")];
let ddl = render_sqlserver_table_ddl("dbo", "users", &columns, &[], &[], Some(" User table "));
assert!(ddl.contains("@value=N' User table '"));
}
#[test]
fn sqlserver_table_ddl_includes_identity_clause() {
let mut id = column("FIDS", "int");
@@ -5916,7 +5972,7 @@ mod ddl_tests {
id.is_primary_key = true;
id.extra = Some("identity(1,1)".to_string());
let ddl = render_sqlserver_table_ddl("dbo", "ZHLSBS", &[id], &[], &[]);
let ddl = render_sqlserver_table_ddl("dbo", "ZHLSBS", &[id], &[], &[], None);
assert!(ddl.contains("[FIDS] int IDENTITY(1,1) NOT NULL"), "ddl: {ddl}");
}
@@ -6007,13 +6063,14 @@ pub fn opengauss_table_ddl_sql(schema: &str, table: &str) -> String {
}
pub async fn pg_ddl(pool: &deadpool_postgres::Pool, schema: &str, table: &str) -> Result<String, String> {
let (columns, indexes, fkeys) = tokio::try_join!(
let (columns, indexes, fkeys, table_comment) = tokio::try_join!(
db::postgres::get_columns(pool, schema, table),
db::postgres::list_indexes(pool, schema, table),
db::postgres::list_foreign_keys(pool, schema, table),
async { db::postgres::get_table_comment(pool, schema, table).await },
)?;
Ok(render_postgres_table_ddl(schema, table, &columns, &indexes, &fkeys))
Ok(render_postgres_table_ddl(schema, table, &columns, &indexes, &fkeys, table_comment.as_deref()))
}
pub fn render_postgres_table_ddl(
@@ -6022,6 +6079,7 @@ pub fn render_postgres_table_ddl(
columns: &[db::ColumnInfo],
indexes: &[db::IndexInfo],
fkeys: &[db::ForeignKeyInfo],
table_comment: Option<&str>,
) -> String {
let table_name = format!("{}.{}", pg_ident(schema), pg_ident(table));
let mut ddl = format!("CREATE TABLE {table_name} (\n");
@@ -6070,6 +6128,10 @@ pub fn render_postgres_table_ddl(
}
ddl.push_str("\n);\n");
if let Some(comment) = table_comment.filter(|comment| !comment.trim().is_empty()) {
ddl.push_str(&format!("\nCOMMENT ON TABLE {table_name} IS {};", sql_string(comment)));
}
for col in columns {
if let Some(comment) = col.comment.as_deref().filter(|comment| !comment.is_empty()) {
ddl.push_str(&format!(
@@ -6147,8 +6209,9 @@ pub async fn build_sqlserver_ddl(
let columns = db::sqlserver::get_columns(client, schema, table).await?;
let indexes = db::sqlserver::list_indexes(client, schema, table).await?;
let fkeys = db::sqlserver::list_foreign_keys(client, schema, table).await?;
let table_comment = db::sqlserver::get_table_comment(client, schema, table).await?;
Ok(render_sqlserver_table_ddl(schema, table, &columns, &indexes, &fkeys))
Ok(render_sqlserver_table_ddl(schema, table, &columns, &indexes, &fkeys, table_comment.as_deref()))
}
pub fn render_sqlserver_table_ddl(
@@ -6157,6 +6220,7 @@ pub fn render_sqlserver_table_ddl(
columns: &[db::ColumnInfo],
indexes: &[db::IndexInfo],
fkeys: &[db::ForeignKeyInfo],
table_comment: Option<&str>,
) -> String {
let table_name = format!("{}.{}", sqlserver_ident(schema), sqlserver_ident(table));
let mut ddl = format!("CREATE TABLE {table_name} (\n");
@@ -6196,6 +6260,15 @@ pub fn render_sqlserver_table_ddl(
}
ddl.push_str("\n);\n");
if let Some(comment) = table_comment.filter(|comment| !comment.trim().is_empty()) {
ddl.push_str(&format!(
"\nEXEC sys.sp_addextendedproperty @name=N'MS_Description', @value={}, @level0type=N'SCHEMA', @level0name={}, @level1type=N'TABLE', @level1name={};",
sqlserver_n_string(comment),
sqlserver_n_string(schema),
sqlserver_n_string(table)
));
}
for column in columns {
if let Some(comment) = column.comment.as_deref().map(str::trim).filter(|comment| !comment.is_empty()) {
ddl.push_str(&format!(
+1 -1
View File
@@ -5793,7 +5793,7 @@ mod tests {
..Default::default()
},
];
let source_ddl = crate::schema::render_postgres_table_ddl("public", "it_quick_entry", &columns, &[], &[]);
let source_ddl = crate::schema::render_postgres_table_ddl("public", "it_quick_entry", &columns, &[], &[], None);
let rewritten = rewrite_transfer_source_table_ddl(
&source_ddl,
"public",