Skip to content

catalog: convert mz_materialized_views into a view over the catalog #35819

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
teskje merged 3 commits into from
Apr 7, 2026
Merged

catalog: convert mz_materialized_views into a view over the catalog #35819

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8488959
catalog: builtin view exposing builtin materialized views
teskje Mar 31, 2026
18bd36d
sql,expr: add sqlfuncs to support mz_materialized_views conversion
teskje Mar 31, 2026
b37834f
catalog: convert mz_materialized_views into a view over the catalog
teskje Mar 31, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions doc/user/content/reference/system-catalog/mz_internal.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1386,6 +1386,7 @@ The `mz_webhook_sources` table contains a row for each webhook source in the sys
[`timestamp with time zone`]: /sql/types/timestamp

<!-- RELATION_SPEC_UNDOCUMENTED mz_internal.mz_activity_log_thinned -->
<!-- RELATION_SPEC_UNDOCUMENTED mz_internal.mz_builtin_materialized_views -->
<!-- RELATION_SPEC_UNDOCUMENTED mz_internal.mz_catalog_raw -->
<!-- RELATION_SPEC_UNDOCUMENTED mz_internal.mz_cluster_workload_classes -->
<!-- RELATION_SPEC_UNDOCUMENTED mz_internal.mz_compute_error_counts_raw_unified -->
Expand Down
61 changes: 9 additions & 52 deletions src/adapter/src/catalog/builtin_table_updates.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,12 @@ use mz_catalog::builtin::{
MZ_DEFAULT_PRIVILEGES, MZ_EGRESS_IPS, MZ_FUNCTIONS, MZ_HISTORY_RETENTION_STRATEGIES,
MZ_ICEBERG_SINKS, MZ_INDEX_COLUMNS, MZ_INDEXES, MZ_KAFKA_CONNECTIONS, MZ_KAFKA_SINKS,
MZ_KAFKA_SOURCE_TABLES, MZ_KAFKA_SOURCES, MZ_LICENSE_KEYS, MZ_LIST_TYPES, MZ_MAP_TYPES,
MZ_MATERIALIZED_VIEW_REFRESH_STRATEGIES, MZ_MATERIALIZED_VIEWS, MZ_MYSQL_SOURCE_TABLES,
MZ_OBJECT_DEPENDENCIES, MZ_OBJECT_GLOBAL_IDS, MZ_OPERATORS, MZ_POSTGRES_SOURCE_TABLES,
MZ_POSTGRES_SOURCES, MZ_PSEUDO_TYPES, MZ_REPLACEMENTS, MZ_ROLE_AUTH, MZ_ROLE_PARAMETERS,
MZ_ROLES, 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,
MZ_MATERIALIZED_VIEW_REFRESH_STRATEGIES, MZ_MYSQL_SOURCE_TABLES, MZ_OBJECT_DEPENDENCIES,
MZ_OBJECT_GLOBAL_IDS, MZ_OPERATORS, MZ_POSTGRES_SOURCE_TABLES, MZ_POSTGRES_SOURCES,
MZ_PSEUDO_TYPES, MZ_REPLACEMENTS, MZ_ROLE_AUTH, MZ_ROLE_PARAMETERS, MZ_ROLES, 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,
};
use mz_catalog::config::AwsPrincipalContext;
use mz_catalog::durable::SourceReferences;
Expand Down Expand Up @@ -636,9 +635,9 @@ impl CatalogState {
CatalogItem::View(view) => {
self.pack_view_update(id, oid, schema_id, name, owner_id, privileges, view, diff)
}
CatalogItem::MaterializedView(mview) => self.pack_materialized_view_update(
id, oid, schema_id, name, owner_id, privileges, mview, diff,
),
CatalogItem::MaterializedView(mview) => {
self.pack_materialized_view_update(id, mview, diff)
}
CatalogItem::Sink(sink) => {
self.pack_sink_update(id, oid, schema_id, name, owner_id, sink, diff)
}
Expand Down Expand Up @@ -1271,53 +1270,11 @@ impl CatalogState {
fn pack_materialized_view_update(
&self,
id: CatalogItemId,
oid: u32,
schema_id: &SchemaSpecifier,
name: &str,
owner_id: &RoleId,
privileges: Datum,
mview: &MaterializedView,
diff: Diff,
) -> Vec<BuiltinTableUpdate<&'static BuiltinTable>> {
let create_stmt = mz_sql::parse::parse(&mview.create_sql)
.unwrap_or_else(|e| {
panic!(
"create_sql cannot be invalid: `{}` --- error: `{}`",
mview.create_sql, e
)
})
.into_element()
.ast;
let query_string = match &create_stmt {
Statement::CreateMaterializedView(stmt) => {
let mut query_string = stmt.query.to_ast_string_stable();
// PostgreSQL appends a semicolon in `pg_matviews.definition`, we
// do the same for compatibility's sake.
query_string.push(';');
query_string
}
_ => unreachable!(),
};

let mut updates = Vec::new();

updates.push(BuiltinTableUpdate::row(
&*MZ_MATERIALIZED_VIEWS,
Row::pack_slice(&[
Datum::String(&id.to_string()),
Datum::UInt32(oid),
Datum::String(&schema_id.to_string()),
Datum::String(name),
Datum::String(&mview.cluster_id.to_string()),
Datum::String(&query_string),
Datum::String(&owner_id.to_string()),
privileges,
Datum::String(&mview.create_sql),
Datum::String(&create_stmt.to_ast_string_redacted()),
]),
diff,
));

if let Some(refresh_schedule) = &mview.refresh_schedule {
// This can't be `ON COMMIT`, because that is represented by a `None` instead of an
// empty `RefreshSchedule`.
Expand Down
6 changes: 6 additions & 0 deletions src/adapter/src/catalog/open/builtin_schema_migration.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,12 @@ static MIGRATIONS: LazyLock<Vec<MigrationStep>> = LazyLock::new(|| {
MZ_INTERNAL_SCHEMA,
"mz_pending_cluster_replicas",
),
MigrationStep::replacement(
"26.19.0-dev.0",
CatalogItemType::MaterializedView,
MZ_CATALOG_SCHEMA,
"mz_materialized_views",
),
]
});

Expand Down
213 changes: 147 additions & 66 deletions src/catalog/src/builtin.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
//! More information about builtin system tables and types can be found in
//! <https://materialize.com/docs/sql/system-catalog/>.

mod builtin;
pub mod notice;

use std::collections::BTreeMap;
Expand Down Expand Up @@ -2874,66 +2875,132 @@ pub static MZ_VIEWS: LazyLock<BuiltinTable> = LazyLock::new(|| BuiltinTable {
is_retained_metrics_object: false,
access: vec![PUBLIC_SELECT],
});
pub static MZ_MATERIALIZED_VIEWS: LazyLock<BuiltinTable> = LazyLock::new(|| BuiltinTable {
name: "mz_materialized_views",
schema: MZ_CATALOG_SCHEMA,
oid: oid::TABLE_MZ_MATERIALIZED_VIEWS_OID,
desc: RelationDesc::builder()
.with_column("id", SqlScalarType::String.nullable(false))
.with_column("oid", SqlScalarType::Oid.nullable(false))
.with_column("schema_id", SqlScalarType::String.nullable(false))
.with_column("name", SqlScalarType::String.nullable(false))
.with_column("cluster_id", SqlScalarType::String.nullable(false))
.with_column("definition", SqlScalarType::String.nullable(false))
.with_column("owner_id", SqlScalarType::String.nullable(false))
.with_column(
"privileges",
SqlScalarType::Array(Box::new(SqlScalarType::MzAclItem)).nullable(false),
)
.with_column("create_sql", SqlScalarType::String.nullable(false))
.with_column("redacted_create_sql", SqlScalarType::String.nullable(false))
.with_key(vec![0])
.with_key(vec![1])
.finish(),
column_comments: BTreeMap::from_iter([
("id", "Materialize's unique ID for the materialized view."),
(
"oid",
"A PostgreSQL-compatible OID for the materialized view.",
),
(
"schema_id",
"The ID of the schema to which the materialized view belongs. Corresponds to `mz_schemas.id`.",
),
("name", "The name of the materialized view."),
(
"cluster_id",
"The ID of the cluster maintaining the materialized view. Corresponds to `mz_clusters.id`.",
),
(
"definition",
"The materialized view definition (a `SELECT` query).",
),
(
"owner_id",
"The role ID of the owner of the materialized view. Corresponds to `mz_roles.id`.",
),
(
"privileges",
"The privileges belonging to the materialized view.",
),
(
"create_sql",
"The `CREATE` SQL statement for the materialized view.",
),
(
"redacted_create_sql",
"The redacted `CREATE` SQL statement for the materialized view.",
),
]),
is_retained_metrics_object: false,
access: vec![PUBLIC_SELECT],

pub static MZ_MATERIALIZED_VIEWS: LazyLock<BuiltinMaterializedView> = LazyLock::new(|| {
BuiltinMaterializedView {
name: "mz_materialized_views",
schema: MZ_CATALOG_SCHEMA,
oid: oid::MV_MZ_MATERIALIZED_VIEWS_OID,
desc: RelationDesc::builder()
.with_column("id", SqlScalarType::String.nullable(false))
.with_column("oid", SqlScalarType::Oid.nullable(false))
.with_column("schema_id", SqlScalarType::String.nullable(false))
.with_column("name", SqlScalarType::String.nullable(false))
.with_column("cluster_id", SqlScalarType::String.nullable(false))
.with_column("definition", SqlScalarType::String.nullable(false))
.with_column("owner_id", SqlScalarType::String.nullable(false))
.with_column(
"privileges",
SqlScalarType::Array(Box::new(SqlScalarType::MzAclItem)).nullable(false),
)
.with_column("create_sql", SqlScalarType::String.nullable(false))
.with_column("redacted_create_sql", SqlScalarType::String.nullable(false))
.with_key(vec![0])
.with_key(vec![1])
.finish(),
column_comments: BTreeMap::from_iter([
("id", "Materialize's unique ID for the materialized view."),
(
"oid",
"A PostgreSQL-compatible OID for the materialized view.",
),
(
"schema_id",
"The ID of the schema to which the materialized view belongs. Corresponds to `mz_schemas.id`.",
),
("name", "The name of the materialized view."),
(
"cluster_id",
"The ID of the cluster maintaining the materialized view. Corresponds to `mz_clusters.id`.",
),
(
"definition",
"The materialized view definition (a `SELECT` query).",
),
(
"owner_id",
"The role ID of the owner of the materialized view. Corresponds to `mz_roles.id`.",
),
(
"privileges",
"The privileges belonging to the materialized view.",
),
(
"create_sql",
"The `CREATE` SQL statement for the materialized view.",
),
(
"redacted_create_sql",
"The redacted `CREATE` SQL statement for the materialized view.",
),
]),
sql: Box::leak(format!("
IN CLUSTER mz_catalog_server
WITH (
ASSERT NOT NULL id,
ASSERT NOT NULL oid,
ASSERT NOT NULL schema_id,
ASSERT NOT NULL name,
ASSERT NOT NULL cluster_id,
ASSERT NOT NULL definition,
ASSERT NOT NULL owner_id,
ASSERT NOT NULL privileges,
ASSERT NOT NULL create_sql,
ASSERT NOT NULL redacted_create_sql
) AS
WITH
user_mvs AS (
SELECT
mz_internal.parse_catalog_id(data->'key'->'gid') AS id,
(data->'value'->>'oid')::oid AS oid,
mz_internal.parse_catalog_id(data->'value'->'schema_id') AS schema_id,
data->'value'->>'name' AS name,
mz_internal.parse_catalog_create_sql(data->'value'->'definition'->'V1'->>'create_sql')->>'cluster_id' AS cluster_id,
mz_internal.parse_catalog_create_sql(data->'value'->'definition'->'V1'->>'create_sql')->>'definition' AS definition,
mz_internal.parse_catalog_id(data->'value'->'owner_id') AS owner_id,
mz_internal.parse_catalog_privileges(data->'value'->'privileges') AS privileges,
data->'value'->'definition'->'V1'->>'create_sql' AS create_sql,
mz_internal.redact_sql(data->'value'->'definition'->'V1'->>'create_sql') AS redacted_create_sql
FROM mz_internal.mz_catalog_raw
WHERE
data->>'kind' = 'Item' AND
mz_internal.parse_catalog_create_sql(data->'value'->'definition'->'V1'->>'create_sql')->>'type' = 'materialized-view'
),
builtin_mappings AS (
SELECT
data->'key'->>'schema_name' AS schema_name,
data->'key'->>'object_name' AS name,
's' || (data->'value'->>'catalog_id') AS id
FROM mz_internal.mz_catalog_raw
WHERE
data->>'kind' = 'GidMapping' AND
data->'key'->>'object_type' = '5'
),
builtin_mvs AS (
SELECT
m.id,
mv.oid,
s.id AS schema_id,
mv.name,
c.id AS cluster_id,
mv.definition,
'{MZ_SYSTEM_ROLE_ID}' AS owner_id,
mv.privileges,
mv.create_sql,
mz_internal.redact_sql(mv.create_sql) AS redacted_create_sql
FROM mz_internal.mz_builtin_materialized_views mv
JOIN builtin_mappings m USING (schema_name, name)
JOIN mz_schemas s ON s.name = mv.schema_name
JOIN mz_clusters c ON c.name = mv.cluster_name
WHERE s.database_id IS NULL
)
SELECT * FROM user_mvs
UNION ALL
SELECT * FROM builtin_mvs").into_boxed_str()),
access: vec![PUBLIC_SELECT],
}
});

pub static MZ_MATERIALIZED_VIEW_REFRESH_STRATEGIES: LazyLock<BuiltinTable> = LazyLock::new(|| {
BuiltinTable {
name: "mz_materialized_view_refresh_strategies",
Expand Down Expand Up @@ -14068,7 +14135,7 @@ pub const MZ_ANALYTICS_CLUSTER: BuiltinCluster = BuiltinCluster {

/// List of all builtin objects sorted topologically by dependency.
pub static BUILTINS_STATIC: LazyLock<Vec<Builtin<NameReference>>> = LazyLock::new(|| {
let mut builtins = vec![
let mut builtin_types = vec![
Builtin::Type(&TYPE_ANY),
Builtin::Type(&TYPE_ANYARRAY),
Builtin::Type(&TYPE_ANYELEMENT),
Expand Down Expand Up @@ -14160,6 +14227,8 @@ pub static BUILTINS_STATIC: LazyLock<Vec<Builtin<NameReference>>> = LazyLock::ne
Builtin::Type(&TYPE_ACL_ITEM_ARRAY),
Builtin::Type(&TYPE_INTERNAL),
];

let mut builtin_funcs = Vec::new();
for (schema, funcs) in &[
(PG_CATALOG_SCHEMA, &*mz_sql::func::PG_CATALOG_BUILTINS),
(
Expand All @@ -14171,14 +14240,15 @@ pub static BUILTINS_STATIC: LazyLock<Vec<Builtin<NameReference>>> = LazyLock::ne
(MZ_UNSAFE_SCHEMA, &*mz_sql::func::MZ_UNSAFE_BUILTINS),
] {
for (name, func) in funcs.iter() {
builtins.push(Builtin::Func(BuiltinFunc {
builtin_funcs.push(Builtin::Func(BuiltinFunc {
name,
schema,
inner: func,
}));
}
}
builtins.append(&mut vec![

let mut builtin_items = vec![
Builtin::Source(&MZ_CATALOG_RAW),
Builtin::Log(&MZ_ARRANGEMENT_SHARING_RAW),
Builtin::Log(&MZ_ARRANGEMENT_BATCHES_RAW),
Expand Down Expand Up @@ -14231,8 +14301,6 @@ pub static BUILTINS_STATIC: LazyLock<Vec<Builtin<NameReference>>> = LazyLock::ne
Builtin::Table(&MZ_KAFKA_SOURCE_TABLES),
Builtin::Table(&MZ_SINKS),
Builtin::Table(&MZ_VIEWS),
Builtin::Table(&MZ_MATERIALIZED_VIEWS),
Builtin::Table(&MZ_MATERIALIZED_VIEW_REFRESH_STRATEGIES),
Builtin::Table(&MZ_TYPES),
Builtin::Table(&MZ_TYPE_PG_METADATA),
Builtin::Table(&MZ_ARRAY_TYPES),
Expand Down Expand Up @@ -14273,6 +14341,8 @@ pub static BUILTINS_STATIC: LazyLock<Vec<Builtin<NameReference>>> = LazyLock::ne
Builtin::Table(&MZ_COMMENTS),
Builtin::Table(&MZ_WEBHOOKS_SOURCES),
Builtin::Table(&MZ_HISTORY_RETENTION_STRATEGIES),
Builtin::MaterializedView(&MZ_MATERIALIZED_VIEWS),
Builtin::Table(&MZ_MATERIALIZED_VIEW_REFRESH_STRATEGIES),
Builtin::Table(&MZ_CONTINUAL_TASKS),
Builtin::MaterializedView(&MZ_NETWORK_POLICIES),
Builtin::MaterializedView(&MZ_NETWORK_POLICY_RULES),
Expand Down Expand Up @@ -14555,9 +14625,20 @@ pub static BUILTINS_STATIC: LazyLock<Vec<Builtin<NameReference>>> = LazyLock::ne
Builtin::View(&MZ_INDEX_ADVICE),
Builtin::View(&MZ_MCP_DATA_PRODUCTS),
Builtin::View(&MZ_MCP_DATA_PRODUCT_DETAILS),
]);
];

builtin_items.extend(notice::builtins());

// Generate builtin relations reporting builtin objects last, since they need a complete view
// of all other builtins.
let mut builtin_builtins = builtin::builtins(&builtin_items).collect();

builtins.extend(notice::builtins());
// Construct the full list of builtins, retaining dependency order.
let mut builtins = Vec::new();
builtins.append(&mut builtin_types);
builtins.append(&mut builtin_funcs);
builtins.append(&mut builtin_builtins);
builtins.append(&mut builtin_items);

builtins
});
Expand Down
Loading
Loading