risingwave_frontend/catalog/
mod.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
15//! Definitions of catalog structs.
16//!
17//! The main struct is [`root_catalog::Catalog`], which is the root containing other catalog
18//! structs. It is accessed via [`catalog_service::CatalogReader`] and
19//! [`catalog_service::CatalogWriter`], which is held by [`crate::session::FrontendEnv`].
20
21use risingwave_common::catalog::{
22    ROW_ID_COLUMN_NAME, RW_RESERVED_COLUMN_NAME_PREFIX, is_system_schema,
23};
24use risingwave_connector::sink::catalog::SinkCatalog;
25use thiserror::Error;
26
27use crate::error::{ErrorCode, Result, RwError};
28pub(crate) mod catalog_service;
29pub mod purify;
30
31pub(crate) mod connection_catalog;
32pub(crate) mod database_catalog;
33pub(crate) mod function_catalog;
34pub(crate) mod index_catalog;
35pub(crate) mod root_catalog;
36pub(crate) mod schema_catalog;
37pub(crate) mod source_catalog;
38pub(crate) mod subscription_catalog;
39pub(crate) mod system_catalog;
40pub(crate) mod table_catalog;
41pub(crate) mod view_catalog;
42
43pub(crate) mod secret_catalog;
44
45pub(crate) use catalog_service::CatalogReader;
46pub use index_catalog::IndexCatalog;
47pub use table_catalog::TableCatalog;
48
49use crate::user::UserId;
50
51pub(crate) type ConnectionId = u32;
52pub(crate) type SourceId = u32;
53pub(crate) type SinkId = u32;
54pub(crate) type SubscriptionId = u32;
55pub(crate) type ViewId = u32;
56pub(crate) type DatabaseId = u32;
57pub(crate) type SchemaId = u32;
58pub(crate) type TableId = risingwave_common::catalog::TableId;
59pub(crate) type ColumnId = risingwave_common::catalog::ColumnId;
60pub(crate) type FragmentId = u32;
61pub(crate) type SecretId = risingwave_common::catalog::SecretId;
62
63/// Check if the column name does not conflict with the internally reserved column name.
64pub fn check_column_name_not_reserved(column_name: &str) -> Result<()> {
65    if column_name.starts_with(ROW_ID_COLUMN_NAME) {
66        return Err(ErrorCode::InternalError(format!(
67            "column name prefixed with {:?} are reserved word.",
68            ROW_ID_COLUMN_NAME
69        ))
70        .into());
71    }
72
73    if column_name.starts_with(RW_RESERVED_COLUMN_NAME_PREFIX) {
74        return Err(ErrorCode::InternalError(format!(
75            "column name prefixed with {:?} are reserved word.",
76            RW_RESERVED_COLUMN_NAME_PREFIX
77        ))
78        .into());
79    }
80
81    if ["tableoid", "xmin", "cmin", "xmax", "cmax", "ctid"].contains(&column_name) {
82        return Err(ErrorCode::InvalidInputSyntax(format!(
83            "column name \"{column_name}\" conflicts with a system column name"
84        ))
85        .into());
86    }
87
88    Ok(())
89}
90
91/// Check if modifications happen to system catalog.
92pub fn check_schema_writable(schema: &str) -> Result<()> {
93    if is_system_schema(schema) {
94        Err(ErrorCode::ProtocolError(format!(
95            "permission denied to write on \"{}\", System catalog modifications are currently disallowed.",
96            schema
97        )).into())
98    } else {
99        Ok(())
100    }
101}
102
103pub type CatalogResult<T> = std::result::Result<T, CatalogError>;
104
105#[derive(Error, Debug)]
106pub enum CatalogError {
107    #[error("{0} not found: {1}")]
108    NotFound(&'static str, String),
109    #[error(
110        "{0} with name {1} exists{under_creation}", under_creation = (.2).then_some(" but under creation").unwrap_or("")
111    )]
112    Duplicated(
113        &'static str,
114        String,
115        // whether the object is under creation
116        bool,
117    ),
118}
119
120impl CatalogError {
121    pub fn duplicated(object_type: &'static str, name: String) -> Self {
122        Self::Duplicated(object_type, name, false)
123    }
124}
125
126impl From<CatalogError> for RwError {
127    fn from(e: CatalogError) -> Self {
128        ErrorCode::CatalogError(Box::new(e)).into()
129    }
130}
131
132/// A trait for the catalog with owners, including relations (table, index, sink, etc.) and
133/// function, connection.
134///
135/// This trait can be used to reduce code duplication and can be extended if needed in the future.
136pub trait OwnedByUserCatalog {
137    /// Returns the owner of the catalog.
138    fn owner(&self) -> UserId;
139}
140
141impl OwnedByUserCatalog for SinkCatalog {
142    fn owner(&self) -> UserId {
143        self.owner.user_id
144    }
145}
risingwave_frontend/catalog/mod.rs

risingwave_frontend/catalog/
mod.rs
