Merge pull request #34332 from teskje/mz_replacements

catalog: add mz_replacements system relation

Author: teskje

doc/user/content/sql/system-catalog/mz_internal.md

@@ -1344,6 +1344,7 @@ The `mz_webhook_sources` table contains a row for each webhook source in the sys
 <!-- RELATION_SPEC_UNDOCUMENTED mz_internal.mz_prepared_statement_history -->
 <!-- RELATION_SPEC_UNDOCUMENTED mz_internal.mz_recent_sql_text -->
 <!-- RELATION_SPEC_UNDOCUMENTED mz_internal.mz_recent_sql_text_redacted -->
+<!-- RELATION_SPEC_UNDOCUMENTED mz_internal.mz_replacements -->
 <!-- RELATION_SPEC_UNDOCUMENTED mz_internal.mz_show_all_objects -->
 <!-- RELATION_SPEC_UNDOCUMENTED mz_internal.mz_show_clusters -->
 <!-- RELATION_SPEC_UNDOCUMENTED mz_internal.mz_show_cluster_replicas -->

src/adapter/src/catalog/builtin_table_updates.rs

@@ -26,8 +26,8 @@ use mz_catalog::builtin::{
     MZ_MATERIALIZED_VIEW_REFRESH_STRATEGIES, MZ_MATERIALIZED_VIEWS, MZ_MYSQL_SOURCE_TABLES,
     MZ_NETWORK_POLICIES, MZ_NETWORK_POLICY_RULES, MZ_OBJECT_DEPENDENCIES, MZ_OBJECT_GLOBAL_IDS,
     MZ_OPERATORS, MZ_PENDING_CLUSTER_REPLICAS, MZ_POSTGRES_SOURCE_TABLES, MZ_POSTGRES_SOURCES,
-    MZ_PSEUDO_TYPES, MZ_ROLE_AUTH, MZ_ROLE_MEMBERS, MZ_ROLE_PARAMETERS, MZ_ROLES, MZ_SCHEMAS,
-    MZ_SECRETS, MZ_SESSIONS, MZ_SINKS, MZ_SOURCE_REFERENCES, MZ_SOURCES,
+    MZ_PSEUDO_TYPES, MZ_REPLACEMENTS, MZ_ROLE_AUTH, MZ_ROLE_MEMBERS, MZ_ROLE_PARAMETERS, MZ_ROLES,
+    MZ_SCHEMAS, MZ_SECRETS, MZ_SESSIONS, MZ_SINKS, MZ_SOURCE_REFERENCES, MZ_SOURCES,
     MZ_SQL_SERVER_SOURCE_TABLES, MZ_SSH_TUNNEL_CONNECTIONS, MZ_STORAGE_USAGE_BY_SHARD,
     MZ_SUBSCRIPTIONS, MZ_SYSTEM_PRIVILEGES, MZ_TABLES, MZ_TYPE_PG_METADATA, MZ_TYPES, MZ_VIEWS,
     MZ_WEBHOOKS_SOURCES,
@@ -1537,6 +1537,17 @@ impl CatalogState {
             ));
         }
 
+        if let Some(target_id) = mview.replacement_target {
+            updates.push(BuiltinTableUpdate::row(
+                &*MZ_REPLACEMENTS,
+                Row::pack_slice(&[
+                    Datum::String(&id.to_string()),
+                    Datum::String(&target_id.to_string()),
+                ]),
+                diff,
+            ));
+        }
+
         updates
     }
 

src/catalog/src/builtin.rs

@@ -5545,6 +5545,28 @@ pub static MZ_LICENSE_KEYS: LazyLock<BuiltinTable> = LazyLock::new(|| BuiltinTab
     access: vec![PUBLIC_SELECT],
 });
 
+pub static MZ_REPLACEMENTS: LazyLock<BuiltinTable> = LazyLock::new(|| BuiltinTable {
+    name: "mz_replacements",
+    schema: MZ_INTERNAL_SCHEMA,
+    oid: oid::TABLE_MZ_REPLACEMENTS_OID,
+    desc: RelationDesc::builder()
+        .with_column("id", SqlScalarType::String.nullable(false))
+        .with_column("target_id", SqlScalarType::String.nullable(false))
+        .finish(),
+    column_comments: BTreeMap::from_iter([
+        (
+            "id",
+            "The ID of the replacement object. Corresponds to `mz_objects.id`.",
+        ),
+        (
+            "target_id",
+            "The ID of the replacement target. Corresponds to `mz_objects.id`.",
+        ),
+    ]),
+    is_retained_metrics_object: false,
+    access: vec![PUBLIC_SELECT],
+});
+
 // These will be replaced with per-replica tables once source/sink multiplexing on
 // a single cluster is supported.
 pub static MZ_SOURCE_STATISTICS_RAW: LazyLock<BuiltinSource> = LazyLock::new(|| BuiltinSource {
@@ -11105,25 +11127,34 @@ pub static MZ_SHOW_MATERIALIZED_VIEWS: LazyLock<BuiltinView> = LazyLock::new(||
         .with_column("schema_id", SqlScalarType::String.nullable(false))
         .with_column("cluster_id", SqlScalarType::String.nullable(false))
         .with_column("comment", SqlScalarType::String.nullable(false))
+        .with_column("replacing", SqlScalarType::String.nullable(true))
         .finish(),
     column_comments: BTreeMap::new(),
     sql: "
-WITH comments AS (
-    SELECT id, comment
-    FROM mz_internal.mz_comments
-    WHERE object_type = 'materialized-view' AND object_sub_id IS NULL
-)
+WITH
+    comments AS (
+        SELECT id, comment
+        FROM mz_internal.mz_comments
+        WHERE object_type = 'materialized-view' AND object_sub_id IS NULL
+    ),
+    replacements AS (
+        SELECT r.id, mv.name AS target_name
+        FROM mz_internal.mz_replacements r
+        JOIN mz_materialized_views mv ON r.target_id = mv.id
+    )
 SELECT
     mviews.id as id,
     mviews.name,
     clusters.name AS cluster,
     schema_id,
     cluster_id,
-    COALESCE(comments.comment, '') as comment
+    COALESCE(comments.comment, '') as comment,
+    replacements.target_name as replacing
 FROM
     mz_catalog.mz_materialized_views AS mviews
     JOIN mz_catalog.mz_clusters AS clusters ON clusters.id = mviews.cluster_id
-    LEFT JOIN comments ON mviews.id = comments.id",
+    LEFT JOIN comments ON mviews.id = comments.id
+    LEFT JOIN replacements ON mviews.id = replacements.id",
     access: vec![PUBLIC_SELECT],
 });
 
@@ -13839,6 +13870,7 @@ pub static BUILTINS_STATIC: LazyLock<Vec<Builtin<NameReference>>> = LazyLock::ne
         Builtin::Table(&MZ_NETWORK_POLICIES),
         Builtin::Table(&MZ_NETWORK_POLICY_RULES),
         Builtin::Table(&MZ_LICENSE_KEYS),
+        Builtin::Table(&MZ_REPLACEMENTS),
         Builtin::View(&MZ_RELATIONS),
         Builtin::View(&MZ_OBJECT_OID_ALIAS),
         Builtin::View(&MZ_OBJECTS),

src/environmentd/tests/testdata/http/ws

@@ -497,7 +497,6 @@ pub const VIEW_MZ_STORAGE_USAGE_OID: u32 = 16771;
 pub const VIEW_MZ_RELATIONS_OID: u32 = 16772;
 pub const VIEW_MZ_OBJECT_OID_ALIAS_OID: u32 = 16773;
 pub const VIEW_MZ_OBJECTS_OID: u32 = 16774;
-pub const VIEW_MZ_OBJECT_GLOBAL_IDS_OID: u32 = 17061;
 pub const VIEW_MZ_OBJECT_FULLY_QUALIFIED_NAMES_OID: u32 = 16775;
 pub const VIEW_MZ_OBJECT_LIFETIMES_OID: u32 = 16776;
 pub const VIEW_MZ_DATAFLOWS_PER_WORKER_OID: u32 = 16777;
@@ -782,3 +781,5 @@ pub const TABLE_MZ_SQL_SERVER_SOURCE_TABLES_OID: u32 = 17057;
 pub const TABLE_MZ_LICENSE_KEYS_OID: u32 = 17058;
 pub const TABLE_MZ_ROLE_AUTH_OID: u32 = 17059;
 pub const TABLE_MZ_ICEBERG_SINKS_OID: u32 = 17060;
+pub const VIEW_MZ_OBJECT_GLOBAL_IDS_OID: u32 = 17061;
+pub const TABLE_MZ_REPLACEMENTS_OID: u32 = 17062;

src/pgrepr-consts/src/oid.rs

@@ -47,6 +47,7 @@ use crate::plan::statement::{StatementContext, StatementDesc, dml};
 use crate::plan::{
     HirRelationExpr, Params, Plan, PlanError, ShowColumnsPlan, ShowCreatePlan, query, transform_ast,
 };
+use crate::session::vars::ENABLE_REPLACEMENT_MATERIALIZED_VIEWS;
 
 pub fn describe_show_create_view(
     _: &StatementContext,
@@ -576,18 +577,17 @@ fn show_materialized_views<'a>(
     }
 
     let query = format!(
-        "SELECT name, cluster, comment
-        FROM mz_internal.mz_show_materialized_views
-        WHERE {where_clause}"
+        "SELECT name, cluster, comment, replacing
+            FROM mz_internal.mz_show_materialized_views
+            WHERE {where_clause}"
     );
 
-    ShowSelect::new(
-        scx,
-        query,
-        filter,
-        None,
-        Some(&["name", "cluster", "comment"]),
-    )
+    let mut projection = vec!["name", "cluster", "comment"];
+    if scx.is_feature_flag_enabled(&ENABLE_REPLACEMENT_MATERIALIZED_VIEWS) {
+        projection.push("replacing");
+    }
+
+    ShowSelect::new(scx, query, filter, None, Some(&projection))
 }
 
 fn show_sinks<'a>(

src/sql/src/plan/statement/show.rs

@@ -179,9 +179,9 @@ INSERT INTO table_e VALUES (3, 'three');
 3
 4
 
-> SHOW MATERIALIZED VIEWS
-mv_e quickstart  ""
-mv_f quickstart  ""
+> SELECT name FROM mz_materialized_views
+mv_e
+mv_f
 
 # RESTRICT works
 ! DROP SOURCE table_e RESTRICT;
@@ -201,7 +201,7 @@ contains:cannot drop source "table_e": still depended upon by materialized view
 mz_source_progress    progress
 table_g               subsource
 
-> SHOW MATERIALIZED VIEWS
+> SELECT name FROM mz_materialized_views
 
 > DROP SOURCE table_g;
 

test/mysql-cdc-old-syntax/alter-source.td

@@ -189,9 +189,9 @@ INSERT INTO table_e VALUES (3, 'three');
 3
 4
 
-> SHOW MATERIALIZED VIEWS
-mv_e quickstart  ""
-mv_f quickstart  ""
+> SELECT name FROM mz_materialized_views
+mv_e
+mv_f
 
 # RESTRICT works
 ! DROP TABLE table_e RESTRICT;
@@ -208,7 +208,7 @@ contains:cannot drop table "table_e": still depended upon by materialized view "
 > SHOW TABLES
 table_g               ""
 
-> SHOW MATERIALIZED VIEWS
+> SELECT name FROM mz_materialized_views
 
 > DROP TABLE table_g;
 

test/mysql-cdc/alter-source.td

@@ -194,9 +194,9 @@ INSERT INTO table_e VALUES (3, 'three');
 3
 4
 
-> SHOW MATERIALIZED VIEWS
-mv_e quickstart ""
-mv_f quickstart ""
+> SELECT name FROM mz_materialized_views
+mv_e
+mv_f
 
 # RESTRICT works
 ! DROP SOURCE table_e RESTRICT;
@@ -216,7 +216,7 @@ contains:cannot drop source "table_e": still depended upon by materialized view
 mz_source_progress    progress
 table_g               subsource
 
-> SHOW MATERIALIZED VIEWS
+> SELECT name FROM mz_materialized_views
 
 > DROP SOURCE table_g;
 

test/pg-cdc-old-syntax/alter-source.td

@@ -203,9 +203,9 @@ INSERT INTO table_e VALUES (3, 'three');
 3
 4
 
-> SHOW MATERIALIZED VIEWS
-mv_e quickstart ""
-mv_f quickstart ""
+> SELECT name FROM mz_materialized_views
+mv_e
+mv_f
 
 # RESTRICT works
 ! DROP TABLE table_e RESTRICT;
@@ -226,7 +226,7 @@ contains:cannot drop table "table_e": still depended upon by materialized view "
 > SHOW TABLES
 table_g               ""
 
-> SHOW MATERIALIZED VIEWS
+> SELECT name FROM mz_materialized_views
 
 > DROP TABLE table_g;