25 MB lightweight cross-platform database client for 100+ databases, including MySQL, PostgreSQL, SQLite, Redis, MongoDB, DuckDB, SQL Server, and Dameng. Built-in AI, MCP Server, CLI, desktop and Docker. | 轻量级跨平台数据库管理工具,支持 MySQL、PostgreSQL、SQLite、Redis、MongoDB、达梦等 100+ 数据库,提供桌面端、Docker、CLI、内置 AI 助手和 MCP。
TypeScript aicliclickhousedatabasedatabase-clientdatabase-managementdockerguimcpmongodbmysqlpostgresqlredisrustsql-serversqlitetaurivue
fix(sqlserver): read and write comments via the legacy driver
Jeffe7787b8bb8ad
diff --git a/agents/drivers/sqlserver-legacy/src/main/java/com/dbx/agent/sqlserverlegacy/SqlServerLegacyAgent.java b/agents/drivers/sqlserver-legacy/src/main/java/com/dbx/agent/sqlserverlegacy/SqlServerLegacyAgent.javaindex 6cced472c5..37c4a6e005 100644--- a/agents/drivers/sqlserver-legacy/src/main/java/com/dbx/agent/sqlserverlegacy/SqlServerLegacyAgent.java+++ b/agents/drivers/sqlserver-legacy/src/main/java/com/dbx/agent/sqlserverlegacy/SqlServerLegacyAgent.java@@ -468,13 +468,17 @@ public final class SqlServerLegacyAgent extends ConfiguredJdbcAgent {public List<ColumnInfo> getColumns(String schema, String table) {String resolvedSchema = metadataSchema(schema, table);List<ColumnInfo> columns = super.getColumns(resolvedSchema, table);- if (!sqlServer2000Mode || columns.isEmpty()) {+ if (columns.isEmpty()) {return columns;}try {+ // JDBC REMARKS from sp_columns is always NULL on SQL Server, so the+ // MS_Description comments must be read from the catalog directly.return mergeSqlServer2000ColumnComments(columns,- readSqlServer2000ColumnComments(resolvedSchema, table)+ sqlServer2000Mode+ ? readSqlServer2000ColumnComments(resolvedSchema, table)+ : readColumnCommentsFromQuery(columnCommentsSql(), resolvedSchema, table));} catch (SQLException | RuntimeException error) {// Comments are optional metadata. Keep the table usable when the@@ -482,7 +486,7 @@ public final class SqlServerLegacyAgent extends ConfiguredJdbcAgent {// Legacy drivers can also throw runtime errors from their catalog// code, mirroring the RuntimeException guards in getTableDdl.System.err.println(- "[sqlserver-legacy] SQL Server 2000 column comments unavailable: "+ "[sqlserver-legacy] SQL Server column comments unavailable: "+ error.getClass().getName()+ ": "+ error.getMessage()@@ -547,6 +551,17 @@ public final class SqlServerLegacyAgent extends ConfiguredJdbcAgent {return columns;}+ static String columnCommentsSql() {+ return "SELECT c.name AS column_name, CAST(ep.value AS nvarchar(max)) AS column_comment, "+ + "ep.name AS property_name "+ + "FROM sys.columns c "+ + "JOIN sys.objects o ON o.object_id = c.object_id "+ + "JOIN sys.schemas s ON s.schema_id = o.schema_id "+ + "JOIN sys.extended_properties ep ON ep.class = 1 AND ep.major_id = c.object_id "+ + "AND ep.minor_id = c.column_id AND ep.name = N'MS_Description' "+ + "WHERE s.name = ? AND o.name = ? AND o.type IN ('U', 'V')";+ }+static String sqlServer2000ColumnCommentsSql() {return "SELECT c.name AS column_name, p.value AS column_comment, p.name AS property_name "+ "FROM sysobjects o JOIN sysusers u ON o.uid = u.uid "diff --git a/agents/drivers/sqlserver-legacy/src/test/java/com/dbx/agent/sqlserverlegacy/SqlServerLegacyAgentTest.java b/agents/drivers/sqlserver-legacy/src/test/java/com/dbx/agent/sqlserverlegacy/SqlServerLegacyAgentTest.javaindex 209e256dae..3b19d37258 100644--- a/agents/drivers/sqlserver-legacy/src/test/java/com/dbx/agent/sqlserverlegacy/SqlServerLegacyAgentTest.java+++ b/agents/drivers/sqlserver-legacy/src/test/java/com/dbx/agent/sqlserverlegacy/SqlServerLegacyAgentTest.java@@ -444,6 +444,27 @@ class SqlServerLegacyAgentTest {Assertions.assertEquals("JDBC remark", columns.get(2).getComment());}+ @Test+ void modernSqlServerColumnCommentsComeFromExtendedProperties() {+ SqlServerLegacyAgent agent = new SqlServerLegacyAgent();+ TestSupport.setPrivateConnection(agent, sqlServer2000CommentConnection(+ null,+ Arrays.asList(+ Arrays.asList("NAME", "Display name", "MS_Description")+ ),+ null+ ));+ setSqlServer2000Mode(agent, false);++ List<ColumnInfo> columns = agent.getColumns("dbo", "USERS");++ // mssql-jdbc reports NULL REMARKS for every SQL Server column, so the+ // MS_Description written by the structure editor must be merged in.+ Assertions.assertEquals("Display name", columns.get(1).getComment());+ Assertions.assertNull(columns.get(0).getComment());+ Assertions.assertEquals("JDBC remark", columns.get(2).getComment());+ }+@Testvoid sqlServer2000ColumnCommentsFailSoftWhenCatalogThrowsRuntimeError() {SqlServerLegacyAgent agent = new SqlServerLegacyAgent();@@ -727,6 +748,17 @@ class SqlServerLegacyAgentTest {Assertions.assertTrue(sql.contains("s.name = ? AND t.name = ?"));}+ @Test+ void columnCommentQueryReadsColumnExtendedPropertiesOnly() {+ String sql = SqlServerLegacyAgent.columnCommentsSql();++ Assertions.assertTrue(sql.contains("sys.extended_properties"));+ Assertions.assertTrue(sql.contains("ep.class = 1"), "index comments share major_id/minor_id with columns");+ Assertions.assertTrue(sql.contains("ep.minor_id = c.column_id"));+ Assertions.assertTrue(sql.contains("ep.name = N'MS_Description'"));+ Assertions.assertTrue(sql.contains("s.name = ? AND o.name = ?"));+ }+@Testvoid tableCommentDdlUsesExtendedPropertyAndPreservesWhitespace() {String ddl = SqlServerLegacyAgent.appendTableCommentDdl(diff --git a/crates/dbx-core/src/schema/agent_metadata_routing_tests.rs b/crates/dbx-core/src/schema/agent_metadata_routing_tests.rsindex 1beff64dbe..d7fc79a91c 100644--- a/crates/dbx-core/src/schema/agent_metadata_routing_tests.rs+++ b/crates/dbx-core/src/schema/agent_metadata_routing_tests.rs@@ -1,6 +1,6 @@use super::{- get_table_ddl_core, list_databases_core, list_object_statistics_core, AppState, ConnectionConfig, DatabaseType,- PoolKind,+ get_table_comment_core, get_table_ddl_core, list_databases_core, list_object_statistics_core, AppState,+ ConnectionConfig, DatabaseType, PoolKind,};use crate::db::agent_driver::{AgentDriverClient, PooledAgentClient};use serde_json::{json, Value};@@ -268,6 +268,24 @@ async fn enumeration_legacy_sqlserver_reuses_connection_metadata_across_databasefixture.shutdown().await;}+#[tokio::test]+async fn legacy_sqlserver_table_comment_reads_extended_property_through_agent_query() {+ let fixture = AgentFixture::new(DatabaseType::SqlServer).await;++ let comment = get_table_comment_core(&fixture.state, "conn", "sales", "dbo", "orders").await.unwrap();++ // The fixture answers every query with a first string cell of `EVENTS`.+ assert_eq!(comment.as_deref(), Some("EVENTS"));+ let queries = fixture.requests("execute_query");+ assert_eq!(queries.len(), 1);+ let sql = queries[0]["params"]["sql"].as_str().unwrap();+ assert!(sql.contains("sys.extended_properties"), "{sql}");+ assert!(sql.contains("N'MS_Description'"), "{sql}");+ assert!(sql.contains("QUOTENAME('dbo') + '.' + QUOTENAME('orders')"), "{sql}");+ assert_eq!(queries[0]["params"]["database"], "sales");+ fixture.shutdown().await;+}+#[tokio::test]async fn statistics_do_not_block_foreground_ddl_on_shared_runtime() {let fixture = AgentFixture::new(DatabaseType::Dameng).await;diff --git a/crates/dbx-core/src/schema/mod.rs b/crates/dbx-core/src/schema/mod.rsindex 476b19893a..9d02259bfb 100644--- a/crates/dbx-core/src/schema/mod.rs+++ b/crates/dbx-core/src/schema/mod.rs@@ -1223,7 +1223,26 @@ async fn get_table_comment_core_for_session(timeout,).await?;- return oracle_table_comment_from_query_result(result);+ return single_table_comment_from_query_result(result);+ }+ if db_config.as_ref().is_some_and(|config| config.db_type == DatabaseType::SqlServer) {+ // JDBC `REMARKS` is always NULL on SQL Server, so the legacy Agent's+ // table list cannot supply the `MS_Description` written by the editor.+ let sql = db::sqlserver::sqlserver_table_comment_sql(schema, table);+ let timeout = agent_metadata_timeout(db_config.as_ref());+ let mut client = client.lock().await;+ let result = client+ .execute_query_with_timeout::<db::QueryResult>(+ agent_execute_query_params(+ &sql,+ Some(database),+ Some(schema),+ QueryExecutionOptions { max_rows: Some(1), ..Default::default() },+ ),+ timeout,+ )+ .await?;+ return single_table_comment_from_query_result(result);}if db_config.as_ref().is_some_and(|config| config.db_type == DatabaseType::Kingbase) {let timeout = agent_metadata_timeout(db_config.as_ref());@@ -1246,7 +1265,7 @@ async fn get_table_comment_core_for_session(timeout,).await?;- return oracle_table_comment_from_query_result(result);+ return single_table_comment_from_query_result(result);}}}@@ -1327,7 +1346,7 @@ fn tdengine_table_comment_cache_key(database: &str, schema: &str, filter: &str)serde_json::json!([database, schema, filter.trim().to_lowercase()]).to_string()}-fn oracle_table_comment_from_query_result(result: db::QueryResult) -> Result<Option<String>, String> {+fn single_table_comment_from_query_result(result: db::QueryResult) -> Result<Option<String>, String> {Ok(result.rows.first()@@ -3122,16 +3141,16 @@ mod tests {oracle_object_statistics_dba_segments_sql, oracle_object_statistics_from_query_result,oracle_object_statistics_rows_only_sql, oracle_object_statistics_sql,oracle_object_statistics_user_segments_sql, oracle_synonym_target_from_query_result, oracle_synonym_target_sql,- oracle_table_comment_from_query_result, oracle_table_comment_sql, oracle_table_comments_sql,- presto_like_columns_from_query_result, presto_like_information_schema_columns_sql,- presto_like_information_schema_tables_sql, presto_like_tables_from_query_result,- reference_key_columns_from_indexes, reference_keys_from_indexes, replace_metadata_runtime,- should_append_oracle_style_comment_ddl, should_query_oracle_columns_via_sql_first,- table_comments_from_query_result, table_name_filter_matches, tdengine_table_comment_like_pattern,- tdengine_table_comment_sql, tdengine_table_comments_sql, uses_mongodb_agent_collection_listing,- visible_schema_filter, ExternalDriverStatisticsDialect, MetadataErrorAction, MysqlTableListSource,- OracleObjectRef, OracleSynonymResolver, ReferenceKeyInfo, TableNameFilter, ORACLE_CURRENT_SCHEMA_SQL,- ORACLE_SYNONYM_MAX_DEPTH, TDENGINE_COMMENT_SEARCH_TIMEOUT, TDENGINE_LIKE_PATTERN_MAX_BYTES,+ oracle_table_comment_sql, oracle_table_comments_sql, presto_like_columns_from_query_result,+ presto_like_information_schema_columns_sql, presto_like_information_schema_tables_sql,+ presto_like_tables_from_query_result, reference_key_columns_from_indexes, reference_keys_from_indexes,+ replace_metadata_runtime, should_append_oracle_style_comment_ddl, should_query_oracle_columns_via_sql_first,+ single_table_comment_from_query_result, table_comments_from_query_result, table_name_filter_matches,+ tdengine_table_comment_like_pattern, tdengine_table_comment_sql, tdengine_table_comments_sql,+ uses_mongodb_agent_collection_listing, visible_schema_filter, ExternalDriverStatisticsDialect,+ MetadataErrorAction, MysqlTableListSource, OracleObjectRef, OracleSynonymResolver, ReferenceKeyInfo,+ TableNameFilter, ORACLE_CURRENT_SCHEMA_SQL, ORACLE_SYNONYM_MAX_DEPTH, TDENGINE_COMMENT_SEARCH_TIMEOUT,+ TDENGINE_LIKE_PATTERN_MAX_BYTES,};use super::{list_databases_core, list_tables_core};use super::{@@ -5647,7 +5666,7 @@ for line in sys.stdin:}#[test]- fn oracle_table_comment_from_query_result_returns_optional_non_blank_comment() {+ fn single_table_comment_from_query_result_returns_optional_non_blank_comment() {let result = db::QueryResult {columns: vec!["COMMENTS".to_string()],column_types: Vec::new(),@@ -5666,7 +5685,7 @@ for line in sys.stdin:messages: Vec::new(),};- assert_eq!(oracle_table_comment_from_query_result(result).unwrap().as_deref(), Some("Customer table"));+ assert_eq!(single_table_comment_from_query_result(result).unwrap().as_deref(), Some("Customer table"));let empty = db::QueryResult {columns: vec!["COMMENTS".to_string()],@@ -5686,7 +5705,7 @@ for line in sys.stdin:messages: Vec::new(),};- assert_eq!(oracle_table_comment_from_query_result(empty).unwrap(), None);+ assert_eq!(single_table_comment_from_query_result(empty).unwrap(), None);}#[test]@@ -11464,7 +11483,7 @@ async fn external_driver_oracle_table_comment(agent_metadata_timeout(Some(config)),).await?;- oracle_table_comment_from_query_result(result)+ single_table_comment_from_query_result(result)}async fn db2_agent_table_ddl(diff --git a/crates/dbx-core/tests/live_sqlserver_legacy_comments.rs b/crates/dbx-core/tests/live_sqlserver_legacy_comments.rsnew file mode 100644index 0000000000..4eedd23b0c--- /dev/null+++ b/crates/dbx-core/tests/live_sqlserver_legacy_comments.rs@@ -0,0 +1,94 @@+//! Opt-in coverage for structure-editor comments through the rebuilt SQL Server Agent on a real server.+use dbx_core::connection::AppState;+use dbx_core::models::connection::ConnectionConfig;+use dbx_core::query::execute_statements;+use dbx_core::schema::{get_columns_core, get_table_comment_core};+use dbx_core::table_structure_sql::{build_table_structure_change_sql, TableStructureSqlOptions};+use serde_json::json;++const SCHEMA: &str = "dbx_live_comments";+const TABLE: &str = "legacy_comments";++#[tokio::test]+#[ignore = "requires DBX_TEST_SQLSERVER_HOST/PASSWORD, DBX_TEST_SQLSERVER_AGENT_JAR and DBX_TEST_SQLSERVER_JAVA"]+async fn sqlserver_legacy_comments_round_trip_on_non_dbo_schema() {+ let host = std::env::var("DBX_TEST_SQLSERVER_HOST").expect("SQL Server test host");+ let password = std::env::var("DBX_TEST_SQLSERVER_PASSWORD").expect("SQL Server test password");+ let database = std::env::var("DBX_TEST_SQLSERVER_DATABASE").unwrap_or_else(|_| "tempdb".into());+ let config: ConnectionConfig = serde_json::from_value(json!({+ "id":"legacy-comments-live", "name":"SQL Server legacy comments live test", "db_type":"sqlserver",+ "driver_profile":"sqlserver-legacy", "host":host,+ "port":std::env::var("DBX_TEST_SQLSERVER_PORT").ok().and_then(|p| p.parse::<u16>().ok()).unwrap_or(1433),+ "port_explicit":true, "username":std::env::var("DBX_TEST_SQLSERVER_USER").unwrap_or_else(|_| "sa".into()),+ "password":password, "database":database,+ "url_params":std::env::var("DBX_TEST_SQLSERVER_URL_PARAMS").ok(),+ "connect_timeout_secs":10, "query_timeout_secs":30, "keepalive_interval_secs":0+ }))+ .unwrap();+ let dir = tempfile::tempdir().unwrap();+ let storage = dbx_core::persistence::test_storage::open(&dir.path().join("state.db")).await.unwrap();+ let state = AppState::new_with_plugin_and_agent_dir_and_app_version(+ storage,+ dir.path().join("plugins"),+ dir.path().join("agents"),+ "0.6.38",+ );+ let jar = std::env::var("DBX_TEST_SQLSERVER_AGENT_JAR").expect("rebuilt SQL Server Agent JAR");+ dbx_core::agent_service::import_agent_jar(&state.agent_manager, "sqlserver-legacy", std::path::Path::new(&jar))+ .await+ .unwrap();+ state+ .agent_manager+ .mutate_state(|manager| {+ manager.java_runtime = dbx_core::agent_manager::JavaRuntimeConfig {+ mode: dbx_core::agent_manager::JavaRuntimeMode::Custom,+ custom_java_path: Some(std::env::var("DBX_TEST_SQLSERVER_JAVA").expect("Java 21 executable")),+ };+ })+ .unwrap();+ state.configs.write().await.insert(config.id.clone(), config.clone());++ // A schema without a same-named database user is what SQL Server 2005++ // rejects for the `USER` extended-property level (Msg 15135).+ let setup = [+ format!("IF SCHEMA_ID(N'{SCHEMA}') IS NULL EXEC (N'CREATE SCHEMA [{SCHEMA}] AUTHORIZATION dbo')"),+ format!("IF OBJECT_ID(N'[{SCHEMA}].[{TABLE}]') IS NOT NULL DROP TABLE [{SCHEMA}].[{TABLE}]"),+ format!("CREATE TABLE [{SCHEMA}].[{TABLE}] (id int NOT NULL, name nvarchar(50) NULL)"),+ ];+ execute_statements(&state, &config.id, &database, &setup, Some(SCHEMA), None).await.unwrap();++ for (column_comment, table_comment) in+ [("Customer's name", "Customers"), ("Display name", "Customer list"), ("", "")]+ {+ let columns = get_columns_core(&state, &config.id, &database, SCHEMA, TABLE).await.unwrap();+ let original_table_comment =+ get_table_comment_core(&state, &config.id, &database, SCHEMA, TABLE).await.unwrap().unwrap_or_default();+ let drafts = columns+ .iter()+ .map(|column| {+ let comment = if column.name == "name" { column_comment } else { "" };+ json!({+ "id": column.name, "name": column.name, "dataType": column.data_type,+ "isNullable": column.is_nullable, "comment": comment, "original": column,+ })+ })+ .collect::<Vec<_>>();+ let options: TableStructureSqlOptions = serde_json::from_value(json!({+ "databaseType": "sqlserver", "driverProfile": "sqlserver-legacy", "schema": SCHEMA, "tableName": TABLE,+ "columns": drafts, "tableComment": table_comment, "originalTableComment": original_table_comment,+ }))+ .unwrap();+ let change = build_table_structure_change_sql(options);+ assert!(change.warnings.is_empty(), "{:?}", change.warnings);+ execute_statements(&state, &config.id, &database, &change.statements, Some(SCHEMA), None).await.unwrap();++ let columns = get_columns_core(&state, &config.id, &database, SCHEMA, TABLE).await.unwrap();+ let name = columns.iter().find(|column| column.name == "name").unwrap();+ assert_eq!(name.comment.as_deref().unwrap_or(""), column_comment);+ let table = get_table_comment_core(&state, &config.id, &database, SCHEMA, TABLE).await.unwrap();+ assert_eq!(table.as_deref().unwrap_or(""), table_comment);+ }++ let cleanup = [format!("DROP TABLE [{SCHEMA}].[{TABLE}]"), format!("DROP SCHEMA [{SCHEMA}]")];+ execute_statements(&state, &config.id, &database, &cleanup, None, None).await.unwrap();+}diff --git a/crates/dbx-driver-sqlserver/src/sqlserver.rs b/crates/dbx-driver-sqlserver/src/sqlserver.rsindex ecea9dac9c..ff0805e4e0 100644--- a/crates/dbx-driver-sqlserver/src/sqlserver.rs+++ b/crates/dbx-driver-sqlserver/src/sqlserver.rs@@ -3365,7 +3365,7 @@ pub async fn get_table_comment(Ok(rows.first().and_then(|row| row.get::<&str, _>(0)).filter(|s| !s.is_empty()).map(|s| s.to_string()))}-fn sqlserver_table_comment_sql(schema: &str, table: &str) -> String {+pub fn sqlserver_table_comment_sql(schema: &str, table: &str) -> String {let s = schema.replace('\'', "''");let t = table.replace('\'', "''");format!(diff --git a/crates/dbx-sql-schema/src/table_structure_sql/comments.rs b/crates/dbx-sql-schema/src/table_structure_sql/comments.rsindex 2c22a8e05a..83d3e6c282 100644--- a/crates/dbx-sql-schema/src/table_structure_sql/comments.rs+++ b/crates/dbx-sql-schema/src/table_structure_sql/comments.rs@@ -103,29 +103,30 @@ pub fn build_sqlserver_table_comment_sql_for_profile(let escaped_qualified = qualified_table.replace('\'', "''");let escaped_schema = schema_name.replace('\'', "''");let escaped_table = table_name.replace('\'', "''");- let (exists, levels, procedure_prefix) = if is_sqlserver_legacy_profile(driver_profile) {- (- format!(- "EXISTS (SELECT 1 FROM ::fn_listextendedproperty(N'MS_Description', N'USER', N'{escaped_schema}', N'TABLE', N'{escaped_table}', NULL, NULL))"- ),- format!(- "@level0type=N'USER', @level0name=N'{escaped_schema}', @level1type=N'TABLE', @level1name=N'{escaped_table}'"- ),- "",- )- } else {- (- format!(- "EXISTS (SELECT 1 FROM sys.extended_properties AS ep WHERE ep.class = 1 AND ep.major_id = OBJECT_ID(N'{escaped_qualified}') AND ep.minor_id = 0 AND ep.name = N'MS_Description')"- ),- format!(- "@level0type=N'SCHEMA', @level0name=N'{escaped_schema}', @level1type=N'TABLE', @level1name=N'{escaped_table}'"- ),- "sys.",- )- };-- build_sqlserver_extended_property_comment_sql(&exists, &levels, new_comment, procedure_prefix)+ let modern = build_sqlserver_extended_property_comment_sql(+ &format!(+ "EXISTS (SELECT 1 FROM sys.extended_properties AS ep WHERE ep.class = 1 AND ep.major_id = OBJECT_ID(N'{escaped_qualified}') AND ep.minor_id = 0 AND ep.name = N'MS_Description')"+ ),+ &format!(+ "@level0type=N'SCHEMA', @level0name=N'{escaped_schema}', @level1type=N'TABLE', @level1name=N'{escaped_table}'"+ ),+ new_comment,+ "sys.",+ );+ if !is_sqlserver_legacy_profile(driver_profile) {+ return modern;+ }+ let sql2000 = build_sqlserver_extended_property_comment_sql(+ &format!(+ "EXISTS (SELECT 1 FROM ::fn_listextendedproperty(N'MS_Description', N'USER', N'{escaped_schema}', N'TABLE', N'{escaped_table}', NULL, NULL))"+ ),+ &format!(+ "@level0type=N'USER', @level0name=N'{escaped_schema}', @level1type=N'TABLE', @level1name=N'{escaped_table}'"+ ),+ new_comment,+ "",+ );+ sqlserver_version_switched_comment_sql(modern, sql2000)}pub(super) fn build_sqlserver_index_comment_sql_for_profile(@@ -141,29 +142,30 @@ pub(super) fn build_sqlserver_index_comment_sql_for_profile(let escaped_schema = schema_name.replace('\'', "''");let escaped_table = table_name.replace('\'', "''");let escaped_idx = index_name.replace('\'', "''");- let (exists, levels, procedure_prefix) = if is_sqlserver_legacy_profile(driver_profile) {- (- format!(- "EXISTS (SELECT 1 FROM ::fn_listextendedproperty(N'MS_Description', N'USER', N'{escaped_schema}', N'TABLE', N'{escaped_table}', N'INDEX', N'{escaped_idx}'))"- ),- format!(- "@level0type=N'USER', @level0name=N'{escaped_schema}', @level1type=N'TABLE', @level1name=N'{escaped_table}', @level2type=N'INDEX', @level2name=N'{escaped_idx}'"- ),- "",- )- } else {- (- format!(- "EXISTS (SELECT 1 FROM sys.extended_properties AS ep INNER JOIN sys.indexes AS i ON i.object_id = ep.major_id AND i.index_id = ep.minor_id WHERE ep.class = 7 AND ep.major_id = OBJECT_ID(N'{escaped_qualified}') AND i.name = N'{escaped_idx}' AND ep.name = N'MS_Description')"- ),- format!(- "@level0type=N'SCHEMA', @level0name=N'{escaped_schema}', @level1type=N'TABLE', @level1name=N'{escaped_table}', @level2type=N'INDEX', @level2name=N'{escaped_idx}'"- ),- "sys.",- )- };-- build_sqlserver_extended_property_comment_sql(&exists, &levels, new_comment, procedure_prefix)+ let modern = build_sqlserver_extended_property_comment_sql(+ &format!(+ "EXISTS (SELECT 1 FROM sys.extended_properties AS ep INNER JOIN sys.indexes AS i ON i.object_id = ep.major_id AND i.index_id = ep.minor_id WHERE ep.class = 7 AND ep.major_id = OBJECT_ID(N'{escaped_qualified}') AND i.name = N'{escaped_idx}' AND ep.name = N'MS_Description')"+ ),+ &format!(+ "@level0type=N'SCHEMA', @level0name=N'{escaped_schema}', @level1type=N'TABLE', @level1name=N'{escaped_table}', @level2type=N'INDEX', @level2name=N'{escaped_idx}'"+ ),+ new_comment,+ "sys.",+ );+ if !is_sqlserver_legacy_profile(driver_profile) {+ return modern;+ }+ let sql2000 = build_sqlserver_extended_property_comment_sql(+ &format!(+ "EXISTS (SELECT 1 FROM ::fn_listextendedproperty(N'MS_Description', N'USER', N'{escaped_schema}', N'TABLE', N'{escaped_table}', N'INDEX', N'{escaped_idx}'))"+ ),+ &format!(+ "@level0type=N'USER', @level0name=N'{escaped_schema}', @level1type=N'TABLE', @level1name=N'{escaped_table}', @level2type=N'INDEX', @level2name=N'{escaped_idx}'"+ ),+ new_comment,+ "",+ );+ sqlserver_version_switched_comment_sql(modern, sql2000)}pub fn build_sqlserver_column_comment_sql(@@ -189,29 +191,43 @@ pub fn build_sqlserver_column_comment_sql_for_profile(let escaped_schema = schema_name.replace('\'', "''");let escaped_table = table_name.replace('\'', "''");let escaped_col = column_name.replace('\'', "''");- let (exists, levels, procedure_prefix) = if is_sqlserver_legacy_profile(driver_profile) {- (- format!(- "EXISTS (SELECT 1 FROM ::fn_listextendedproperty(N'MS_Description', N'USER', N'{escaped_schema}', N'TABLE', N'{escaped_table}', N'COLUMN', N'{escaped_col}'))"- ),- format!(- "@level0type=N'USER', @level0name=N'{escaped_schema}', @level1type=N'TABLE', @level1name=N'{escaped_table}', @level2type=N'COLUMN', @level2name=N'{escaped_col}'"- ),- "",- )- } else {- (- format!(- "EXISTS (SELECT 1 FROM sys.extended_properties AS ep WHERE ep.class = 1 AND ep.major_id = OBJECT_ID(N'{escaped_qualified}') AND ep.minor_id = COLUMNPROPERTY(OBJECT_ID(N'{escaped_qualified}'), N'{escaped_col}', 'ColumnId') AND ep.name = N'MS_Description')"- ),- format!(- "@level0type=N'SCHEMA', @level0name=N'{escaped_schema}', @level1type=N'TABLE', @level1name=N'{escaped_table}', @level2type=N'COLUMN', @level2name=N'{escaped_col}'"- ),- "sys.",- )- };+ let modern = build_sqlserver_extended_property_comment_sql(+ &format!(+ "EXISTS (SELECT 1 FROM sys.extended_properties AS ep WHERE ep.class = 1 AND ep.major_id = OBJECT_ID(N'{escaped_qualified}') AND ep.minor_id = COLUMNPROPERTY(OBJECT_ID(N'{escaped_qualified}'), N'{escaped_col}', 'ColumnId') AND ep.name = N'MS_Description')"+ ),+ &format!(+ "@level0type=N'SCHEMA', @level0name=N'{escaped_schema}', @level1type=N'TABLE', @level1name=N'{escaped_table}', @level2type=N'COLUMN', @level2name=N'{escaped_col}'"+ ),+ new_comment,+ "sys.",+ );+ if !is_sqlserver_legacy_profile(driver_profile) {+ return modern;+ }+ let sql2000 = build_sqlserver_extended_property_comment_sql(+ &format!(+ "EXISTS (SELECT 1 FROM ::fn_listextendedproperty(N'MS_Description', N'USER', N'{escaped_schema}', N'TABLE', N'{escaped_table}', N'COLUMN', N'{escaped_col}'))"+ ),+ &format!(+ "@level0type=N'USER', @level0name=N'{escaped_schema}', @level1type=N'TABLE', @level1name=N'{escaped_table}', @level2type=N'COLUMN', @level2name=N'{escaped_col}'"+ ),+ new_comment,+ "",+ );+ sqlserver_version_switched_comment_sql(modern, sql2000)+}- build_sqlserver_extended_property_comment_sql(&exists, &levels, new_comment, procedure_prefix)+/// The legacy driver serves SQL Server 2000 through current releases. Since+/// SQL Server 2005, the `USER` level only resolves when a database user shares+/// the schema name, so non-`dbo` schemas fail with Msg 15135. Choose the level+/// on the server instead, and keep each branch in dynamic SQL so SQL Server+/// 2000 never compiles the `sys.` catalog references.+fn sqlserver_version_switched_comment_sql(modern: Vec<String>, sql2000: Vec<String>) -> Vec<String> {+ let dynamic = |statements: Vec<String>| {+ let sql = statements.concat();+ format!("EXEC (N'{}')", sql.trim_end_matches(';').replace('\'', "''"))+ };+ vec![format!("IF @@MICROSOFTVERSION / 16777216 >= 9 {} ELSE {};", dynamic(modern), dynamic(sql2000))]}fn is_sqlserver_legacy_profile(driver_profile: Option<&str>) -> bool {@@ -331,26 +347,37 @@ mod tests {}#[test]- fn sqlserver_legacy_column_comment_uses_sql_server_2000_compatibility_syntax() {+ fn sqlserver_legacy_column_comment_picks_extended_property_level_by_server_version() {let statements = build_sqlserver_column_comment_sql_for_profile(- "[dbo].[Categories]",- Some("dbo"),+ "[app].[Categories]",+ Some("app"),"Categories","CategoryID",- "test",+ "owner's test",Some("sqlserver-legacy"),);assert_eq!(statements.len(), 1);let sql = &statements[0];- assert!(sql.contains("::fn_listextendedproperty"), "legacy property lookup: {sql}");- assert!(sql.contains("@level0type=N'USER'"), "legacy hierarchy: {sql}");- assert!(sql.contains("EXEC sp_updateextendedproperty"), "legacy update procedure: {sql}");- assert!(sql.contains("ELSE EXEC sp_addextendedproperty"), "legacy add procedure: {sql}");- assert!(- !sql.contains("sys.extended_properties"),- "SQL Server 2005+ catalog view leaked into legacy SQL: {sql}"+ let (modern, sql2000) = sql+ .strip_prefix("IF @@MICROSOFTVERSION / 16777216 >= 9 EXEC (N'")+ .and_then(|rest| rest.split_once("') ELSE EXEC (N'"))+ .unwrap_or_else(|| panic!("version switch: {sql}"));+ assert!(modern.contains("sys.extended_properties"), "2005+ property lookup: {sql}");+ assert!(modern.contains("@level0type=N''SCHEMA'', @level0name=N''app''"), "2005+ hierarchy: {sql}");+ assert!(modern.contains("EXEC sys.sp_updateextendedproperty"), "2005+ update procedure: {sql}");+ assert!(!modern.contains("N''USER''"), "USER level fails for non-dbo schemas on 2005+: {sql}");+ assert!(sql2000.contains("::fn_listextendedproperty"), "legacy property lookup: {sql}");+ assert!(sql2000.contains("@level0type=N''USER''"), "legacy hierarchy: {sql}");+ assert!(sql2000.contains("ELSE EXEC sp_addextendedproperty"), "legacy add procedure: {sql}");+ assert!(!sql2000.contains("sys."), "SQL Server 2005+ catalog leaked into the 2000 branch: {sql}");+ assert!(sql.contains("@value=N''owner''''s test''"), "comment escaped for dynamic SQL: {sql}");+ assert!(sql.ends_with("');"), "{sql}");+ assert_eq!(+ crate::sql::split_sql_statements_for_database(sql, crate::models::connection::DatabaseType::SqlServer)+ .len(),+ 1,+ "version-switched comment upsert must remain one executable statement: {sql}");- assert!(!sql.contains("EXEC sys."), "SQL Server 2005+ procedure qualification leaked into legacy SQL: {sql}");}}diff --git a/crates/dbx-sql-schema/src/table_structure_sql/tests.rs b/crates/dbx-sql-schema/src/table_structure_sql/tests.rsindex 2854865c48..a5ed6e2713 100644--- a/crates/dbx-sql-schema/src/table_structure_sql/tests.rs+++ b/crates/dbx-sql-schema/src/table_structure_sql/tests.rs@@ -3898,9 +3898,10 @@ fn sqlserver_legacy_column_comment_change_uses_legacy_extended_properties() {assert_eq!(result.warnings, Vec::<String>::new());assert_eq!(result.statements.len(), 1);+ assert!(result.statements[0].starts_with("IF @@MICROSOFTVERSION / 16777216 >= 9 EXEC (N'"));assert!(result.statements[0].contains("::fn_listextendedproperty"));assert!(result.statements[0].contains("EXEC sp_addextendedproperty"));- assert!(!result.statements[0].contains("sys.extended_properties"));+ assert!(result.statements[0].contains("EXEC sys.sp_addextendedproperty"));}#[test]