Skip to content

armgit / dbx

Public Imported from GitHub
0

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。

fix(sqlserver): filter comment reads by extended property class

Jeff19c2d6d0544b
diff --git a/crates/dbx-driver-sqlserver/src/sqlserver.rs b/crates/dbx-driver-sqlserver/src/sqlserver.rs
index ff0805e4e0..178fdb6cb7 100644
--- a/crates/dbx-driver-sqlserver/src/sqlserver.rs
+++ b/crates/dbx-driver-sqlserver/src/sqlserver.rs
@@ -2646,7 +2646,7 @@ fn sqlserver_completion_assistant_sql(request: &crate::types::CompletionAssistan
CAST(NULL AS NVARCHAR(128)) AS parent_schema, CAST(NULL AS NVARCHAR(128)) AS parent_name, ep.value AS object_comment, {data_type} AS data_type \
FROM sys.objects o \
JOIN sys.schemas s ON s.schema_id = o.schema_id \
- OUTER APPLY (SELECT CAST(ep.value AS NVARCHAR(MAX)) AS value FROM sys.extended_properties ep WHERE ep.major_id = o.object_id AND ep.minor_id = 0 AND ep.name = N'MS_Description') ep \
+ OUTER APPLY (SELECT CAST(ep.value AS NVARCHAR(MAX)) AS value FROM sys.extended_properties ep WHERE ep.class = 1 AND ep.major_id = o.object_id AND ep.minor_id = 0 AND ep.name = N'MS_Description') ep \
WHERE o.type IN ({}) AND {object_visibility} {schema_filter} {object_like}",
type_ids.join(",")
));
@@ -2762,7 +2762,7 @@ fn sqlserver_list_tables_sql_with_kind(
let base_from = "FROM sys.objects o \
JOIN sys.schemas s ON s.schema_id = o.schema_id \
OUTER APPLY (SELECT CAST(ep.value AS NVARCHAR(MAX)) AS value FROM sys.extended_properties ep \
- WHERE ep.major_id = o.object_id AND ep.minor_id = 0 AND ep.name = N'MS_Description') ep";
+ WHERE ep.class = 1 AND ep.major_id = o.object_id AND ep.minor_id = 0 AND ep.name = N'MS_Description') ep";
let object_visibility = sqlserver_visible_object_predicate();
let schema_filter = sqlserver_schema_name_predicate(schema, "s.name");
let object_type_predicate = if table_objects_only { "o.type = 'U'" } else { "o.type IN ('U','V')" };
@@ -2897,7 +2897,7 @@ fn sqlserver_list_objects_sql(schema: &str) -> String {
ep.value AS object_comment \
FROM sys.objects o \
JOIN sys.schemas s ON s.schema_id = o.schema_id \
- OUTER APPLY (SELECT CAST(ep.value AS NVARCHAR(MAX)) AS value FROM sys.extended_properties ep WHERE ep.major_id = o.object_id AND ep.minor_id = 0 AND ep.name = N'MS_Description') ep \
+ OUTER APPLY (SELECT CAST(ep.value AS NVARCHAR(MAX)) AS value FROM sys.extended_properties ep WHERE ep.class = 1 AND ep.major_id = o.object_id AND ep.minor_id = 0 AND ep.name = N'MS_Description') ep \
WHERE s.name = '{s}' \
AND o.type IN ('U','V','P','FN','IF','TF','FS','FT') \
AND {object_visibility} \
@@ -3181,7 +3181,7 @@ fn sqlserver_columns_sql(schema: &str, table: &str) -> String {
JOIN sys.index_columns ic ON ic.object_id = i.object_id AND ic.index_id = i.index_id \
WHERE i.is_primary_key = 1 \
) pk ON pk.object_id = c.object_id AND pk.column_id = c.column_id \
- OUTER APPLY (SELECT CAST(ep.value AS NVARCHAR(MAX)) AS value FROM sys.extended_properties ep WHERE ep.major_id = c.object_id AND ep.minor_id = c.column_id AND ep.name = N'MS_Description') ep \
+ OUTER APPLY (SELECT CAST(ep.value AS NVARCHAR(MAX)) AS value FROM sys.extended_properties ep WHERE ep.class = 1 AND ep.major_id = c.object_id AND ep.minor_id = c.column_id AND ep.name = N'MS_Description') ep \
WHERE {schema_filter} AND o.name = '{t}' AND o.type IN ('U','V') \
ORDER BY c.column_id"
)
@@ -3371,7 +3371,8 @@ pub fn sqlserver_table_comment_sql(schema: &str, table: &str) -> String {
format!(
"SELECT CAST(ep.value AS NVARCHAR(MAX)) \
FROM sys.extended_properties ep \
- WHERE ep.major_id = OBJECT_ID(QUOTENAME('{s}') + '.' + QUOTENAME('{t}')) \
+ WHERE ep.class = 1 \
+ AND ep.major_id = OBJECT_ID(QUOTENAME('{s}') + '.' + QUOTENAME('{t}')) \
AND ep.minor_id = 0 \
AND ep.name = N'MS_Description'"
)
@@ -5172,7 +5173,7 @@ mod tests {
assert!(sql.contains("FROM sys.objects o"));
assert!(sql.contains("JOIN sys.columns c ON c.object_id = o.object_id"));
assert!(sql.contains("sys.extended_properties ep"));
- assert!(sql.contains("ep.major_id = c.object_id"));
+ assert!(sql.contains("ep.class = 1 AND ep.major_id = c.object_id"));
assert!(sql.contains("ep.minor_id = c.column_id"));
assert!(sql.contains("MS_Description"));
assert!(sql.contains("c.is_computed = 1 THEN 'computed'"));
@@ -5221,6 +5222,7 @@ mod tests {
let sql = sqlserver_table_comment_sql("dbo", "users");
assert!(sql.contains("sys.extended_properties ep"));
+ assert!(sql.contains("ep.class = 1"));
assert!(sql.contains("ep.minor_id = 0"));
assert!(sql.contains("MS_Description"));
assert!(sql.contains("QUOTENAME('dbo')"));
diff --git a/crates/dbx-driver-sqlserver/tests/live_sqlserver_comment_class.rs b/crates/dbx-driver-sqlserver/tests/live_sqlserver_comment_class.rs
new file mode 100644
index 0000000000..14faa484f9
--- /dev/null
+++ b/crates/dbx-driver-sqlserver/tests/live_sqlserver_comment_class.rs
@@ -0,0 +1,56 @@
+//! Opt-in live regression for index comments leaking into column comments.
+//! An index `MS_Description` is stored with `class = 7` and `minor_id = index_id`,
+//! so a lookup that does not filter `class = 1` matches the column whose
+//! `column_id` equals that `index_id`.
+use dbx_driver_sqlserver as native;
+use std::time::Duration;
+
+#[tokio::test]
+#[ignore = "requires DBX_LIVE_SQLSERVER_HOST/PORT/USER/PASSWORD pointing at a writable SQL Server"]
+async fn live_sqlserver_index_comments_do_not_leak_into_column_or_table_comments() {
+ let host = std::env::var("DBX_LIVE_SQLSERVER_HOST").unwrap_or_else(|_| "127.0.0.1".to_string());
+ let port: u16 = std::env::var("DBX_LIVE_SQLSERVER_PORT").ok().and_then(|value| value.parse().ok()).unwrap_or(1433);
+ let username = std::env::var("DBX_LIVE_SQLSERVER_USER").unwrap_or_else(|_| "sa".to_string());
+ let password = std::env::var("DBX_LIVE_SQLSERVER_PASSWORD").expect("DBX_LIVE_SQLSERVER_PASSWORD");
+ let mut client = native::connect(&host, port, &username, &password, Some("tempdb"), None, Duration::from_secs(15))
+ .await
+ .expect("connect to SQL Server");
+
+ let suffix = uuid::Uuid::new_v4().simple().to_string();
+ let table = format!("dbx_eval_comment_class_{suffix}");
+ let setup = format!(
+ "CREATE TABLE dbo.[{table}] (id int NOT NULL CONSTRAINT [pk_{table}] PRIMARY KEY, name nvarchar(50), code int); \
+ CREATE INDEX [ix_{table}_code] ON dbo.[{table}](code); \
+ EXEC sys.sp_addextendedproperty N'MS_Description', N'pk index comment', N'SCHEMA', N'dbo', N'TABLE', N'{table}', N'INDEX', N'pk_{table}'; \
+ EXEC sys.sp_addextendedproperty N'MS_Description', N'code index comment', N'SCHEMA', N'dbo', N'TABLE', N'{table}', N'INDEX', N'ix_{table}_code'; \
+ EXEC sys.sp_addextendedproperty N'MS_Description', N'name column comment', N'SCHEMA', N'dbo', N'TABLE', N'{table}', N'COLUMN', N'name'; \
+ EXEC sys.sp_addextendedproperty N'MS_Description', N'table comment', N'SCHEMA', N'dbo', N'TABLE', N'{table}';"
+ );
+ native::execute_simple_batch_with_max_rows(&mut client, &setup, Some(1)).await.expect("create test table");
+
+ let columns = native::get_columns(&mut client, "dbo", &table).await;
+ let table_comment = native::get_table_comment(&mut client, "dbo", &table).await;
+ let tables = native::list_tables(&mut client, "dbo", Some(&table), None, None).await;
+ let objects = native::list_objects(&mut client, "dbo").await;
+
+ native::execute_simple_batch_with_max_rows(&mut client, &format!("DROP TABLE dbo.[{table}]"), Some(1))
+ .await
+ .expect("drop test table");
+
+ let columns: Vec<(String, Option<String>)> =
+ columns.expect("get_columns").into_iter().map(|column| (column.name, column.comment)).collect();
+ println!("columns: {columns:?}");
+ assert_eq!(
+ columns,
+ vec![
+ ("id".to_string(), None),
+ ("name".to_string(), Some("name column comment".to_string())),
+ ("code".to_string(), None),
+ ]
+ );
+ assert_eq!(table_comment.expect("get_table_comment").as_deref(), Some("table comment"));
+ let listed = tables.expect("list_tables").into_iter().find(|info| info.name == table).expect("table listed");
+ assert_eq!(listed.comment.as_deref(), Some("table comment"));
+ let object = objects.expect("list_objects").into_iter().find(|info| info.name == table).expect("object listed");
+ assert_eq!(object.comment.as_deref(), Some("table comment"));
+}