Skip to main content

uqa_sql/catalog/
view.rs

1//
2// Unified Query Algebra
3//
4// Copyright (c) 2023-2026 Cognica, Inc.
5//
6
7use crate::{RowSchema, SQLError};
8
9mod production;
10pub use production::{
11    create_view_output_columns_with_control, materialized_view_schema_with_control,
12    named_view_schema_with_control, ViewRewriteDefinitionRef,
13};
14mod materialized;
15pub use materialized::materialized_view_schema;
16
17/// Scanning an unpopulated materialized view fails even if the query would read no rows.
18pub fn require_materialized_view_population(name: &str, populated: bool) -> Result<(), SQLError> {
19    if populated {
20        return Ok(());
21    }
22    let (_, relation) =
23        uqa_core::RelationIdentity::parse_reference(name).map_err(SQLError::Unsupported)?;
24    Err(SQLError::Diagnostic {
25        sqlstate: "55000".into(),
26        message: format!("materialized view \"{relation}\" has not been populated"),
27        detail: None,
28        hint: Some("Use the REFRESH MATERIALIZED VIEW command.".into()),
29    })
30}
31
32pub fn create_view_output_columns(
33    schema: &RowSchema,
34    declared: &[String],
35) -> Result<Vec<String>, SQLError> {
36    create_view_output_columns_with_control(
37        schema,
38        declared,
39        &uqa_core::memory::ProductionControl::uncontrolled(),
40    )
41    .map(|output| {
42        output
43            .into_uncontrolled()
44            .expect("ordinary view column names")
45    })
46}
47
48pub fn named_view_schema(
49    query_schema: &RowSchema,
50    output_columns: &[String],
51) -> Result<RowSchema, SQLError> {
52    named_view_schema_with_control(
53        query_schema,
54        output_columns,
55        &uqa_core::memory::ProductionControl::uncontrolled(),
56    )
57}
58
59pub fn validate_view_column_types(
60    query_schema: &RowSchema,
61    output_columns: &[String],
62) -> Result<(), SQLError> {
63    for (position, column) in output_columns.iter().enumerate() {
64        if let Some(ty) = query_schema.column_type(position) {
65            crate::schema::columns::validate_postgres_relation_column_type(column, ty)?;
66        }
67    }
68    Ok(())
69}
70
71#[derive(Debug, Clone, Copy, Default, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
72pub enum StoredViewKind {
73    #[default]
74    View,
75    Materialized,
76}
77
78#[derive(Debug, Clone, Copy, Default)]
79pub struct ViewMutationCapabilities {
80    pub insertable: bool,
81    pub updatable: bool,
82    pub deletable: bool,
83}
84impl ViewMutationCapabilities {
85    pub const fn fully_updatable(self) -> bool {
86        self.updatable && self.deletable
87    }
88}
89
90#[derive(Clone)]
91pub struct ViewRewriteDefinition {
92    pub query: crate::plan::QueryPlan,
93    pub output_columns: Option<Vec<String>>,
94    pub options: Vec<(String, String)>,
95    pub kind: StoredViewKind,
96    pub materialized_column_types: Vec<Option<crate::ColumnType>>,
97    pub materialized_column_collations: Option<Vec<u32>>,
98}
99
100impl ViewRewriteDefinition {
101    pub fn row_schema(
102        &self,
103        routines: &dyn crate::routines::RoutineResolution,
104        catalog: super::analysis::CatalogReadView,
105        resolution: super::resolution::RelationNameResolution,
106    ) -> Result<crate::RowSchema, crate::SQLError> {
107        let control = uqa_core::memory::ProductionControl::uncontrolled();
108        let scope = crate::binding::production::ControlledBindingContext {
109            catalog,
110            resolution: resolution.into(),
111            ctes: crate::binding::production::BindingMap::new(),
112            deferred_ctes: crate::binding::production::BindingMap::new(),
113            non_returning_ctes: crate::binding::production::BindingNameSet::new(),
114            scalar_subqueries: &[],
115        };
116        ViewRewriteDefinitionRef::from(self).row_schema_with_control(routines, scope, &control)
117    }
118}
119
120#[cfg(test)]
121mod tests;