uqa-sql 0.5.0

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

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

//! Foreign-server catalog identity and ownership, independent of a transport implementation.

use super::roles::{identity::RoleSubject, RoleDefinition, RoleIdentity};
use crate::SQLError;
use serde::{Deserialize, Serialize};
use std::collections::{BTreeMap, BTreeSet};

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct ForeignServerMetadata {
    pub oid: u32,
    pub object_id: [u8; 16],
    pub owner: RoleIdentity,
    pub server_type: Option<String>,
    pub version: Option<String>,
    /// Written option names, absent only in preceding map-only records.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub option_order: Option<Vec<String>>,
    /// Missing only while restoring a catalog that predates wrapper identities.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub wrapper_reference: Option<super::foreign_wrapper::ForeignWrapperReference>,
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ForeignServerDefinition {
    pub name: String,
    pub fdw_type: String,
    pub options: BTreeMap<String, String>,
    pub metadata: ForeignServerMetadata,
}

impl ForeignServerDefinition {
    pub fn bound_wrapper<'a>(
        &self,
        wrappers: &'a super::foreign_wrapper::ForeignWrappers,
    ) -> Result<&'a super::foreign_wrapper::ForeignWrapperDefinition, SQLError> {
        let reference = self.metadata.wrapper_reference.ok_or_else(|| {
            SQLError::Internal(format!(
                "foreign server `{}` has no wrapper identity",
                self.name
            ))
        })?;
        super::foreign_wrapper::bound_wrapper(wrappers, &self.fdw_type, reference)
    }
}

/// Validate identities before publishing any restored definition. A name, OID or incarnation cannot alias another server, and an owner must still be the role incarnation that created it.
pub fn validate_foreign_servers(
    servers: &BTreeMap<String, ForeignServerDefinition>,
    roles: &BTreeMap<String, RoleDefinition>,
) -> Result<(), SQLError> {
    let mut oids = BTreeSet::new();
    let mut identities = BTreeSet::new();
    for (name, server) in servers {
        let metadata = &server.metadata;
        validate_foreign_server_name(name)?;
        if name != &server.name {
            return Err(invalid(name, "invalid catalog name"));
        }
        if metadata.oid < super::oids::FIRST_NORMAL_OBJECT_ID || !oids.insert(metadata.oid) {
            return Err(invalid(name, "invalid or duplicate catalog OID"));
        }
        if metadata.object_id == [0; 16] || !identities.insert(metadata.object_id) {
            return Err(invalid(name, "invalid or duplicate object identity"));
        }
        if let Some(order) = &metadata.option_order {
            let names = order.iter().collect::<BTreeSet<_>>();
            if names.len() != order.len()
                || order.len() != server.options.len()
                || order.iter().any(|name| !server.options.contains_key(name))
            {
                return Err(invalid(name, "option order disagrees with stored options"));
            }
        }
        if !metadata.owner.is_valid() || metadata.owner.role_definition(roles).is_none() {
            return Err(invalid(name, "owner references a missing or replaced role"));
        }
    }
    Ok(())
}

/// SQL rejects an empty identifier during parsing; direct callers must reject it before a durable definition is written.
pub fn validate_foreign_server_name(name: &str) -> Result<(), SQLError> {
    if name.is_empty() {
        return Err(invalid(name, "invalid catalog name"));
    }
    Ok(())
}

fn invalid(name: &str, reason: &str) -> SQLError {
    SQLError::Internal(format!("foreign server `{name}`: {reason}"))
}

#[cfg(test)]
mod tests;