uqa-sql 0.4.9

PostgreSQL-compatible SQL compiler built on libpg_query
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112

//
// Unified Query Algebra
//
// Copyright (c) 2023-2026 Cognica, Inc.
//

//! `PostgreSQL` column-name and stored-type declaration rules.

use crate::{ColumnType, SQLError};

pub const POSTGRES_SYSTEM_COLUMNS: [&str; 6] = ["tableoid", "xmin", "cmin", "xmax", "cmax", "ctid"];

pub fn validate_postgres_column_name(name: &str) -> Result<(), SQLError> {
    if POSTGRES_SYSTEM_COLUMNS.contains(&name) {
        return Err(SQLError::Routine {
            sqlstate: "42701".into(),
            message: format!("column name \"{name}\" conflicts with a system column name"),
        });
    }
    Ok(())
}

pub fn validate_postgres_relation_column_type(name: &str, ty: &ColumnType) -> Result<(), SQLError> {
    let pseudo_type = match ty {
        ColumnType::Void | ColumnType::AnyArray | ColumnType::Record => Some(ty.sql_name()),
        ColumnType::Array(element)
            if matches!(
                element.as_ref(),
                ColumnType::Void | ColumnType::AnyArray | ColumnType::Record
            ) =>
        {
            Some(ty.sql_name())
        }
        _ => None,
    };
    if let Some(pseudo_type) = pseudo_type {
        return Err(SQLError::Routine {
            sqlstate: "42P16".into(),
            message: format!("column \"{name}\" has pseudo-type {pseudo_type}"),
        });
    }
    Ok(())
}

/// Append a declared column after checking its name against the existing schema.
pub fn append_registered_column(
    table: &str,
    columns: &mut Vec<crate::ast::ColumnDef>,
    column: crate::ast::ColumnDef,
) -> Result<(), String> {
    if columns.iter().any(|existing| existing.name == column.name) {
        return Err(format!(
            "column `{}` already exists on table `{table}`",
            column.name
        ));
    }
    columns.push(column);
    Ok(())
}

/// Reject `SET DEFAULT`, when `setting`, or `DROP DEFAULT` on an identity or generated column, as `PostgreSQL`'s `ATExecColumnDefault` does: its hint names the command that changes such a column.
pub fn reject_default_change(
    catalog: &dyn crate::assignment::columns::AssignmentColumnCatalog,
    table: &str,
    column: &str,
    setting: bool,
) -> Result<(), SQLError> {
    let Some(shape) = catalog
        .try_column_shape(table, column)
        .map_err(|error| SQLError::Internal(format!("read column `{column}`: {error}")))?
        .flatten()
    else {
        return Ok(());
    };
    let relation = uqa_core::RelationIdentity::from_legacy_name(table)
        .map_err(|error| SQLError::Internal(format!("resolve ALTER TABLE target: {error}")))?
        .name;
    let (kind, hint) = if shape.identity_sequence.is_some() {
        (
            "an identity column",
            (!setting).then_some("ALTER TABLE ... ALTER COLUMN ... DROP IDENTITY"),
        )
    } else if let Some(generated) = shape.generated {
        (
            "a generated column",
            if setting {
                Some("ALTER TABLE ... ALTER COLUMN ... SET EXPRESSION")
            } else {
                (generated == crate::ast::GeneratedColumnKind::Stored)
                    .then_some("ALTER TABLE ... ALTER COLUMN ... DROP EXPRESSION")
            },
        )
    } else {
        return Ok(());
    };
    Err(SQLError::Diagnostic {
        sqlstate: "42601".into(),
        message: format!("column \"{column}\" of relation \"{relation}\" is {kind}"),
        detail: None,
        hint: hint.map(|command| format!("Use {command} instead.")),
    })
}

pub mod addition;

pub mod publication;

pub mod alteration;

pub mod removal;

pub mod removal_metadata;