risingwave_frontend/expr/function_impl/
cast_regclass.rs

1// Copyright 2025 RisingWave Labs
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15use risingwave_common::session_config::SearchPath;
16use risingwave_expr::{ExprError, capture_context, function};
17use risingwave_sqlparser::parser::{Parser, ParserError};
18use thiserror::Error;
19use thiserror_ext::AsReport;
20
21use super::context::{AUTH_CONTEXT, CATALOG_READER, DB_NAME, SEARCH_PATH};
22use crate::Binder;
23use crate::binder::ResolveQualifiedNameError;
24use crate::catalog::root_catalog::SchemaPath;
25use crate::catalog::{CatalogError, CatalogReader};
26use crate::session::AuthContext;
27
28#[derive(Error, Debug)]
29enum ResolveRegclassError {
30    #[error("parse object name failed: {0}")]
31    Parser(#[from] ParserError),
32    #[error("catalog error: {0}")]
33    Catalog(#[from] CatalogError),
34    #[error("resolve qualified name error: {0}")]
35    ResolveQualifiedName(#[from] ResolveQualifiedNameError),
36}
37
38impl From<ResolveRegclassError> for ExprError {
39    fn from(e: ResolveRegclassError) -> Self {
40        match e {
41            ResolveRegclassError::Parser(e) => ExprError::Parse(e.to_report_string().into()),
42            ResolveRegclassError::Catalog(e) => ExprError::InvalidParam {
43                name: "name",
44                reason: e.to_report_string().into(),
45            },
46            ResolveRegclassError::ResolveQualifiedName(e) => ExprError::InvalidParam {
47                name: "name",
48                reason: e.to_report_string().into(),
49            },
50        }
51    }
52}
53
54#[capture_context(CATALOG_READER, AUTH_CONTEXT, SEARCH_PATH, DB_NAME)]
55fn resolve_regclass_impl(
56    catalog: &CatalogReader,
57    auth_context: &AuthContext,
58    search_path: &SearchPath,
59    db_name: &str,
60    class_name: &str,
61) -> Result<u32, ExprError> {
62    resolve_regclass_inner(catalog, auth_context, search_path, db_name, class_name)
63        .map_err(Into::into)
64}
65
66fn resolve_regclass_inner(
67    catalog: &CatalogReader,
68    auth_context: &AuthContext,
69    search_path: &SearchPath,
70    db_name: &str,
71    class_name: &str,
72) -> Result<u32, ResolveRegclassError> {
73    // We use the full parser here because this function needs to accept every legal way
74    // of identifying an object in PG SQL as a valid value for the varchar
75    // literal.  For example: 'foo', 'public.foo', '"my table"', and
76    // '"my schema".foo' must all work as values passed pg_table_size.
77    let obj = Parser::parse_object_name_str(class_name)?;
78
79    let (schema_name, class_name) = Binder::resolve_schema_qualified_name(db_name, obj)?;
80    let schema_path = SchemaPath::new(schema_name.as_deref(), search_path, &auth_context.user_name);
81    Ok(catalog
82        .read_guard()
83        .get_id_by_class_name(db_name, schema_path, &class_name)?)
84}
85
86#[function("cast_regclass(varchar) -> int4")]
87fn cast_regclass(class_name: &str) -> Result<i32, ExprError> {
88    let oid = resolve_regclass_impl_captured(class_name)?;
89    Ok(oid as i32)
90}
risingwave_frontend/expr/function_impl/cast_regclass.rs

risingwave_frontend/expr/function_impl/
cast_regclass.rs
