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(gaussdb): hide system columns from index metadata

Andrew7510e91d9ac3
diff --git a/crates/dbx-core/src/schema/mod.rs b/crates/dbx-core/src/schema/mod.rs
index 116d9b456b..3a0b51fb55 100644
--- a/crates/dbx-core/src/schema/mod.rs
+++ b/crates/dbx-core/src/schema/mod.rs
@@ -3182,22 +3182,22 @@ mod tests {
deduplicate_column_infos, ephemeral_agent_metadata_session_id, external_driver_statistics_dialect,
external_driver_statistics_query_plan, external_driver_uses_generic_ddl, external_driver_uses_mysql_ddl,
filter_mongodb_agent_collections, filter_mysql_system_databases_for_config, filter_object_infos,
- filter_table_infos, filter_visible_schema_names, finalize_object_source, gaussdb_m_view_object_source_sql,
- gbase8a_object_statistics_sql, is_agent_postgres_metadata_fallback_config, is_mysql_external_driver_config,
- is_oracle_external_driver_config, is_retryable_metadata_error, metadata_error_action,
- metadata_name_or_comment_matches, mysql_auto_increment_from_query_result, mysql_auto_increment_metadata_sql,
- mysql_database_list_timeout, mysql_external_driver_ddl_from_query_result, mysql_external_driver_ddl_sql,
- mysql_object_source_ddl_column_index, mysql_object_source_sql, mysql_table_list_source_for_config,
- mysql_table_metadata_catalog, normalize_information_schema_table_type, oracle_columns_from_query_result,
- oracle_columns_sql, oracle_columns_sql_for_resolved_owner, oracle_completion_synonyms_sql,
- oracle_current_schema_from_query_result, 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_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,
+ filter_table_infos, filter_visible_schema_names, finalize_object_source, gaussdb_m_indexes_sql,
+ gaussdb_m_view_object_source_sql, gbase8a_object_statistics_sql, is_agent_postgres_metadata_fallback_config,
+ is_mysql_external_driver_config, is_oracle_external_driver_config, is_retryable_metadata_error,
+ metadata_error_action, metadata_name_or_comment_matches, mysql_auto_increment_from_query_result,
+ mysql_auto_increment_metadata_sql, mysql_database_list_timeout, mysql_external_driver_ddl_from_query_result,
+ mysql_external_driver_ddl_sql, mysql_object_source_ddl_column_index, mysql_object_source_sql,
+ mysql_table_list_source_for_config, mysql_table_metadata_catalog, normalize_information_schema_table_type,
+ oracle_columns_from_query_result, oracle_columns_sql, oracle_columns_sql_for_resolved_owner,
+ oracle_completion_synonyms_sql, oracle_current_schema_from_query_result,
+ 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_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,
@@ -4357,6 +4357,20 @@ done
);
}
+ #[test]
+ fn gaussdb_m_indexes_sql_excludes_system_attributes() {
+ let sql = gaussdb_m_indexes_sql("sec_acct", "main_sec_acct_info");
+ assert!(sql.contains("FROM information_schema.STATISTICS s"), "{sql}");
+ assert!(sql.contains("JOIN pg_catalog.pg_attribute a"), "{sql}");
+ assert!(sql.contains("a.attnum > 0"), "{sql}");
+ assert!(sql.contains("NOT a.attisdropped"), "{sql}");
+ assert!(sql.contains("s.TABLE_SCHEMA = 'sec_acct'"), "{sql}");
+ assert!(sql.contains("s.TABLE_NAME = 'main_sec_acct_info'"), "{sql}");
+ assert!(sql.contains("ORDER BY s.INDEX_NAME, s.SEQ_IN_INDEX"), "{sql}");
+ // Escaping still goes through `sql_string`.
+ assert!(gaussdb_m_indexes_sql("a'b", "c'd").contains("s.TABLE_SCHEMA = 'a''b'"));
+ }
+
#[test]
fn mysql_external_driver_ddl_sql_uses_catalog_and_escaped_identifiers() {
assert_eq!(
@@ -10234,20 +10248,7 @@ async fn external_driver_gaussdb_m_indexes(
schema: &str,
table: &str,
) -> Result<Vec<db::IndexInfo>, String> {
- // Query information_schema.STATISTICS row by row (one row per index column,
- // ordered by SEQ_IN_INDEX).
- // Docs: https://support.huaweicloud.com/intl/en-us/centralized-m-comp-devg-v8-gaussdb/gaussdb-81-0134.html
- // The STATISTICS view has no EXPRESSION column in GaussDB M-mode. Expression
- // indexes are not supported via this path.
- let sql = format!(
- "SELECT INDEX_NAME, COLUMN_NAME, SEQ_IN_INDEX, NON_UNIQUE, \
- INDEX_TYPE, INDEX_COMMENT, SUB_PART \
- FROM information_schema.STATISTICS \
- WHERE TABLE_SCHEMA = {} AND TABLE_NAME = {} \
- ORDER BY INDEX_NAME, SEQ_IN_INDEX",
- sql_string(schema),
- sql_string(table),
- );
+ let sql = gaussdb_m_indexes_sql(schema, table);
log::debug!("[gaussdb-m][list_indexes] sql={sql}");
let timeout = agent_metadata_timeout(Some(config));
@@ -10398,6 +10399,36 @@ async fn external_driver_gaussdb_m_indexes(
Ok(indexes)
}
+/// Index-list SQL for GaussDB M-mode (one row per index column, ordered by `SEQ_IN_INDEX`).
+///
+/// A GaussDB/openGauss GLOBAL index carries system attributes in `pg_index.indkey` as
+/// negative attnums (e.g. `tableoid` = -7, `oid` = -2). `information_schema.STATISTICS`
+/// reports those system attributes as ordinary key columns, even though `pg_get_indexdef`
+/// omits them, so the object browser showed a bogus `tableoid` key part. Requiring a matching
+/// `pg_attribute` row with `attnum > 0` drops the system attributes while keeping real columns
+/// (including a genuine user column that happens to be named `oid`/`tableoid`).
+///
+/// Docs: https://support.huaweicloud.com/intl/en-us/centralized-m-comp-devg-v8-gaussdb/gaussdb-81-0134.html
+/// The STATISTICS view has no EXPRESSION column in GaussDB M-mode, so expression indexes are
+/// not represented via this path.
+fn gaussdb_m_indexes_sql(schema: &str, table: &str) -> String {
+ format!(
+ "SELECT s.INDEX_NAME, s.COLUMN_NAME, s.SEQ_IN_INDEX, s.NON_UNIQUE, \
+ s.INDEX_TYPE, s.INDEX_COMMENT, s.SUB_PART \
+ FROM information_schema.STATISTICS s \
+ JOIN pg_catalog.pg_class c \
+ ON c.relname = s.TABLE_NAME \
+ JOIN pg_catalog.pg_namespace n \
+ ON n.oid = c.relnamespace AND n.nspname = s.TABLE_SCHEMA \
+ JOIN pg_catalog.pg_attribute a \
+ ON a.attrelid = c.oid AND a.attname = s.COLUMN_NAME AND a.attnum > 0 AND NOT a.attisdropped \
+ WHERE s.TABLE_SCHEMA = {} AND s.TABLE_NAME = {} \
+ ORDER BY s.INDEX_NAME, s.SEQ_IN_INDEX",
+ sql_string(schema),
+ sql_string(table),
+ )
+}
+
fn gaussdb_m_view_object_source_sql(
config: &ConnectionConfig,
_database: &str,
diff --git a/crates/dbx-driver-postgres/src/postgres.rs b/crates/dbx-driver-postgres/src/postgres.rs
index 4f268136f5..f0eeebc96c 100644
--- a/crates/dbx-driver-postgres/src/postgres.rs
+++ b/crates/dbx-driver-postgres/src/postgres.rs
@@ -5414,6 +5414,7 @@ fn postgres_indexes_for_relations_sql() -> &'static str {
LEFT JOIN pg_opclass oc ON oc.oid = k.class_oid \
LEFT JOIN pg_namespace opcns ON opcns.oid = oc.opcnamespace \
WHERE t.oid = ANY($1::bigint[]) \
+ AND k.attnum >= 0 \
GROUP BY t.oid, i.relname, i.oid, ix.indisunique, ix.indisvalid, ix.indisprimary, ix.indpred, ix.indrelid, am.amname, ix.indnkeyatts, ix.indkey \
ORDER BY t.oid, i.relname"
}
@@ -5429,6 +5430,7 @@ fn postgres_indexes_for_relations_compat_sql() -> &'static str {
ON a.attrelid = t.oid \
AND a.attnum = (string_to_array(ix.indkey::text, ' '))[pos.n]::int2 \
AND a.attnum > 0 \
+ WHERE (string_to_array(ix.indkey::text, ' '))[pos.n]::int2 >= 0 \
ORDER BY pos.n \
) AS columns, \
ARRAY( \
@@ -5440,6 +5442,7 @@ fn postgres_indexes_for_relations_compat_sql() -> &'static str {
ON a.attrelid = t.oid \
AND a.attnum = (string_to_array(ix.indkey::text, ' '))[pos.n]::int2 \
AND a.attnum > 0 \
+ WHERE (string_to_array(ix.indkey::text, ' '))[pos.n]::int2 >= 0 \
LEFT JOIN pg_opclass oc \
ON oc.oid = (string_to_array(ix.indclass::text, ' '))[pos.n]::oid \
ORDER BY pos.n \
@@ -5458,6 +5461,7 @@ fn postgres_indexes_for_relations_compat_sql() -> &'static str {
ON a.attrelid = t.oid \
AND a.attnum = (string_to_array(ix.indkey::text, ' '))[pos.n]::int2 \
AND a.attnum > 0 \
+ WHERE (string_to_array(ix.indkey::text, ' '))[pos.n]::int2 >= 0 \
ORDER BY pos.n \
) AS key_is_expression, \
string_to_array(ix.indoption::text, ' ')::smallint[] AS key_options, \
@@ -9677,6 +9681,13 @@ pub async fn execute_query_on_client_unnamed(
// relation: a FOREIGN KEY stores the referenced table's unique index in
// `conindid`, so matching on `conindid` alone marked that standalone index as
// constraint-backed and dropped it from generated DDL (#10484).
+//
+// `AND k.attnum >= 0` skips system attributes (negative `indkey` entries such as
+// `tableoid`) that openGauss / GaussDB can carry in `pg_index.indkey`: because the
+// `pg_attribute` join is restricted to `attnum > 0`, `pg_get_indexdef` would
+// otherwise render the raw system-column name as a key part and the UI would show
+// a bogus `tableoid` column. Only non-negative attnums (0 = expression, positive =
+// user column) are real, displayable index key parts.
const POSTGRES_INDEXES_SQL: &str = "SELECT i.relname AS index_name, \
array_agg(COALESCE(a.attname::text, pg_get_indexdef(ix.indexrelid, k.n::int, false)) ORDER BY k.n) AS columns, \
array_agg(CASE WHEN oc.opcdefault THEN NULL ELSE quote_ident(opcns.nspname) || '.' || quote_ident(oc.opcname) END ORDER BY k.n) AS column_opclasses, \
@@ -9700,6 +9711,7 @@ const POSTGRES_INDEXES_SQL: &str = "SELECT i.relname AS index_name, \
LEFT JOIN pg_opclass oc ON oc.oid = k.class_oid \
LEFT JOIN pg_namespace opcns ON opcns.oid = oc.opcnamespace \
WHERE t.oid = (CASE WHEN coalesce(length($1), 0) = 0 THEN quote_ident($2) ELSE quote_ident($1) || '.' || quote_ident($2) END)::regclass \
+ AND k.attnum >= 0 \
GROUP BY i.relname, i.oid, ix.indisunique, ix.indisvalid, ix.indisprimary, ix.indpred, ix.indrelid, am.amname, ix.indnkeyatts, ix.indkey \
ORDER BY i.relname";
@@ -9713,6 +9725,7 @@ const POSTGRES_INDEXES_COMPAT_SQL: &str = "SELECT i.relname AS index_name, \
ON a.attrelid = t.oid \
AND a.attnum = (string_to_array(ix.indkey::text, ' '))[pos.n]::int2 \
AND a.attnum > 0 \
+ WHERE (string_to_array(ix.indkey::text, ' '))[pos.n]::int2 >= 0 \
ORDER BY pos.n \
) AS columns, \
ARRAY( \
@@ -9724,6 +9737,7 @@ const POSTGRES_INDEXES_COMPAT_SQL: &str = "SELECT i.relname AS index_name, \
ON a.attrelid = t.oid \
AND a.attnum = (string_to_array(ix.indkey::text, ' '))[pos.n]::int2 \
AND a.attnum > 0 \
+ WHERE (string_to_array(ix.indkey::text, ' '))[pos.n]::int2 >= 0 \
LEFT JOIN pg_opclass oc \
ON oc.oid = (string_to_array(ix.indclass::text, ' '))[pos.n]::oid \
ORDER BY pos.n \
@@ -9742,6 +9756,7 @@ const POSTGRES_INDEXES_COMPAT_SQL: &str = "SELECT i.relname AS index_name, \
ON a.attrelid = t.oid \
AND a.attnum = (string_to_array(ix.indkey::text, ' '))[pos.n]::int2 \
AND a.attnum > 0 \
+ WHERE (string_to_array(ix.indkey::text, ' '))[pos.n]::int2 >= 0 \
ORDER BY pos.n \
) AS key_is_expression, \
string_to_array(ix.indoption::text, ' ')::smallint[] AS key_options, \
@@ -15440,6 +15455,23 @@ mod tests {
assert!(POSTGRES_INDEXES_COMPAT_SQL.contains("AS key_is_expression"));
}
+ #[test]
+ fn postgres_index_metadata_skips_system_columns() {
+ // openGauss / GaussDB can carry system attributes (negative `indkey` entries such as
+ // `tableoid`) inside `pg_index.indkey`. The `pg_attribute` join only matches `attnum > 0`,
+ // so without an explicit attnum guard `pg_get_indexdef` renders the raw system-column
+ // name and the object browser shows a bogus `tableoid` key part.
+ for sql in [POSTGRES_INDEXES_SQL, postgres_indexes_for_relations_sql()] {
+ assert!(sql.contains("AND k.attnum >= 0"), "expected system-column guard in {sql}");
+ }
+ for sql in [POSTGRES_INDEXES_COMPAT_SQL, postgres_indexes_for_relations_compat_sql()] {
+ assert!(
+ sql.contains("WHERE (string_to_array(ix.indkey::text, ' '))[pos.n]::int2 >= 0"),
+ "expected system-column guard in {sql}"
+ );
+ }
+ }
+
#[test]
fn postgres_index_metadata_tracks_per_key_ordering_without_include_columns() {
for sql in [POSTGRES_INDEXES_SQL, postgres_indexes_for_relations_sql()] {