risingwave_common/session_config/
search_path.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 std::convert::Infallible;
16use std::str::FromStr;
17
18use super::SESSION_CONFIG_LIST_SEP;
19use crate::catalog::{DEFAULT_SCHEMA_NAME, PG_CATALOG_SCHEMA_NAME, RW_CATALOG_SCHEMA_NAME};
20
21pub const USER_NAME_WILD_CARD: &str = "\"$user\"";
22
23/// see <https://www.postgresql.org/docs/14/runtime-config-client.html#GUC-SEARCH-PATH>
24///
25/// 1. when we `select` or `drop` object and don't give a specified schema, it will search the
26///    object from the valid items in schema `rw_catalog`, `pg_catalog` and `search_path`. If schema
27///    `rw_catalog` and `pg_catalog` are not in `search_path`, we will search them firstly. If they're
28///    in `search_path`, we will follow the order in `search_path`.
29///
30/// 2. when we `create` a `source` or `mv` and don't give a specified schema, it will use the first
31///    valid schema in `search_path`.
32///
33/// 3. when we `create` a `index` or `sink`, it will use the schema of the associated table.
34#[derive(Clone, Debug, PartialEq)]
35pub struct SearchPath {
36    origin_str: String,
37    /// The path will implicitly includes `rw_catalog` and `pg_catalog` if user does specify them.
38    path: Vec<String>,
39    real_path: Vec<String>,
40}
41
42impl SearchPath {
43    pub fn real_path(&self) -> &[String] {
44        &self.real_path
45    }
46
47    pub fn path(&self) -> &[String] {
48        &self.path
49    }
50}
51
52impl Default for SearchPath {
53    fn default() -> Self {
54        [USER_NAME_WILD_CARD, DEFAULT_SCHEMA_NAME]
55            .join(SESSION_CONFIG_LIST_SEP)
56            .parse()
57            .unwrap()
58    }
59}
60
61impl FromStr for SearchPath {
62    type Err = Infallible;
63
64    fn from_str(s: &str) -> Result<Self, Self::Err> {
65        let paths = s.split(SESSION_CONFIG_LIST_SEP).map(|path| path.trim());
66        let mut real_path = vec![];
67        for p in paths {
68            let p = p.trim();
69            if !p.is_empty() {
70                real_path.push(p.to_owned());
71            }
72        }
73        let string = real_path.join(SESSION_CONFIG_LIST_SEP);
74
75        let mut path = real_path.clone();
76        let rw_catalog = RW_CATALOG_SCHEMA_NAME.to_owned();
77        if !real_path.contains(&rw_catalog) {
78            path.insert(0, rw_catalog);
79        }
80
81        let pg_catalog = PG_CATALOG_SCHEMA_NAME.to_owned();
82        if !real_path.contains(&pg_catalog) {
83            path.insert(0, pg_catalog);
84        }
85
86        Ok(Self {
87            origin_str: string,
88            path,
89            real_path,
90        })
91    }
92}
93
94impl std::fmt::Display for SearchPath {
95    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
96        write!(f, "{}", self.origin_str)
97    }
98}
risingwave_common/session_config/search_path.rs

risingwave_common/session_config/
search_path.rs
