Fix missing table owner and omit empty tables (#22134)

* Fix missing table owner and omit empty tables

* Changelog

* Lint

* Fix toast_table

* Add snapshot tests

* Changelog

* Normalize schemas before compare

* Comment

* Normalize before using for list sort

* Sort keys

Author: sethsamuel

postgres/changelog.d/22134.fixed

@@ -0,0 +1,4 @@
+Fix missing table owner and toast table fields in Postgres schema collection.
+Omit empty tables from collection.
+Fix the missing description in Postgres schema databases.
+Add snapshot tests for Postgres schema collection.

postgres/datadog_checks/postgres/schemas.py

@@ -39,12 +39,7 @@ class DatabaseObject(TypedDict):
 SELECT c.oid                 AS table_id,
        c.relnamespace        AS schema_id,
        c.relname             AS table_name,
-       c.relhasindex         AS has_indexes,
-       c.relowner :: regrole AS owner,
-       ( CASE
-           WHEN c.relkind = 'p' THEN TRUE
-           ELSE FALSE
-         END )               AS has_partitions,
+       c.relowner :: regrole :: text AS table_owner,
        t.relname             AS toast_table
 FROM   pg_class c
        left join pg_class t
@@ -57,8 +52,7 @@ class DatabaseObject(TypedDict):
 SELECT c.oid                 AS table_id,
        c.relnamespace        AS schema_id,
        c.relname             AS table_name,
-       c.relhasindex         AS has_indexes,
-       c.relowner :: regrole AS owner,
+       c.relowner :: regrole :: text AS table_owner,
        t.relname             AS toast_table
 FROM   pg_class c
        left join pg_class t
@@ -176,10 +170,8 @@ class PostgresDatabaseObject(DatabaseObject):
        datname                       AS NAME,
        pg_encoding_to_char(encoding) AS encoding,
        rolname                       AS owner,
-       description
+       shobj_description(db.oid, 'pg_database') AS description
 FROM   pg_catalog.pg_database db
-       LEFT JOIN pg_catalog.pg_description dc
-              ON dc.objoid = db.oid
        JOIN pg_roles a
          ON datdba = a.oid
         WHERE datname NOT LIKE 'template%'
@@ -328,7 +320,7 @@ def get_rows_query(self):
             ),
             schema_tables AS (
                 SELECT schemas.schema_id, schemas.schema_name, schemas.schema_owner,
-                tables.table_id, tables.table_name
+                tables.table_id, tables.table_name, tables.table_owner, tables.toast_table
                 FROM schemas
                 LEFT JOIN tables ON schemas.schema_id = tables.schema_id
                 ORDER BY schemas.schema_name, tables.table_name
@@ -346,7 +338,7 @@ def get_rows_query(self):
             {partitions_ctes}
 
             SELECT schema_tables.schema_id, schema_tables.schema_name, schema_tables.schema_owner,
-            schema_tables.table_id, schema_tables.table_name,
+            schema_tables.table_id, schema_tables.table_name, schema_tables.table_owner, schema_tables.toast_table,
                 array_agg(row_to_json(columns.*)) FILTER (WHERE columns.name IS NOT NULL) as columns,
                 array_agg(row_to_json(indexes.*)) FILTER (WHERE indexes.name IS NOT NULL) as indexes,
                 array_agg(row_to_json(constraints.*)) FILTER (WHERE constraints.name IS NOT NULL)
@@ -358,7 +350,7 @@ def get_rows_query(self):
                 LEFT JOIN constraints ON schema_tables.table_id = constraints.table_id
                 {partition_joins}
             GROUP BY schema_tables.schema_id, schema_tables.schema_name, schema_tables.schema_owner,
-                schema_tables.table_id, schema_tables.table_name
+                schema_tables.table_id, schema_tables.table_name, schema_tables.table_owner, schema_tables.toast_table
             ;
         """
 
@@ -386,7 +378,7 @@ def _map_row(self, database: DatabaseInfo, cursor_row) -> DatabaseObject:
                             for k, v in {
                                 "id": str(cursor_row.get("table_id")),
                                 "name": cursor_row.get("table_name"),
-                                "owner": cursor_row.get("owner"),
+                                "owner": cursor_row.get("table_owner"),
                                 # The query can create duplicates of the joined tables
                                 "columns": list({v and v['name']: v for v in cursor_row.get("columns") or []}.values())[
                                     : self._config.max_columns
@@ -401,7 +393,9 @@ def _map_row(self, database: DatabaseInfo, cursor_row) -> DatabaseObject:
                             }.items()
                             if v is not None
                         }
-                    ],
+                    ]
+                    if cursor_row.get("table_name")
+                    else [],
                 }.items()
                 if v is not None
             }

postgres/tests/compose/resources/01_postgres.sql

@@ -13,6 +13,7 @@ GRANT SELECT ON pg_stat_database TO datadog;
 GRANT SELECT ON pg_stat_database TO datadog_no_catalog;
 GRANT SELECT ON ALL tables IN SCHEMA pg_catalog to datadog;
 CREATE DATABASE datadog_test;
+COMMENT ON DATABASE datadog_test IS 'Datadog test database';
 GRANT ALL PRIVILEGES ON DATABASE datadog_test TO datadog;
 CREATE DATABASE dogs;
 GRANT USAGE on SCHEMA public to bob;