risingwave_frontend/handler/
create_database.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 pgwire::pg_response::StatementType;
16use risingwave_common::system_param::{NOTICE_BARRIER_INTERVAL_MS, NOTICE_CHECKPOINT_FREQUENCY};
17use risingwave_common::util::worker_util::DEFAULT_RESOURCE_GROUP;
18use risingwave_sqlparser::ast::{ObjectName, SetVariableValue};
19
20use super::RwPgResponse;
21use crate::binder::Binder;
22use crate::catalog::CatalogError;
23use crate::error::ErrorCode::PermissionDenied;
24use crate::error::Result;
25use crate::handler::HandlerArgs;
26use crate::handler::alter_resource_group::resolve_resource_group;
27
28pub async fn handle_create_database(
29    handler_args: HandlerArgs,
30    database_name: ObjectName,
31    if_not_exist: bool,
32    owner: Option<ObjectName>,
33    resource_group: Option<SetVariableValue>,
34    barrier_interval_ms: Option<u32>,
35    checkpoint_frequency: Option<u64>,
36) -> Result<RwPgResponse> {
37    let mut builder = RwPgResponse::builder(StatementType::CREATE_DATABASE);
38
39    let session = handler_args.session;
40    let database_name = Binder::resolve_database_name(database_name)?;
41
42    {
43        let user_reader = session.env().user_info_reader();
44        let reader = user_reader.read_guard();
45        if let Some(info) = reader.get_user_by_name(&session.user_name()) {
46            if !info.can_create_db && !info.is_super {
47                return Err(
48                    PermissionDenied("permission denied to create database".to_owned()).into(),
49                );
50            }
51        } else {
52            return Err(PermissionDenied("Session user is invalid".to_owned()).into());
53        }
54    }
55
56    {
57        let catalog_reader = session.env().catalog_reader();
58        let reader = catalog_reader.read_guard();
59        if reader.get_database_by_name(&database_name).is_ok() {
60            // If `if_not_exist` is true, not return error.
61            return if if_not_exist {
62                Ok(builder
63                    .notice(format!("database \"{}\" exists, skipping", database_name))
64                    .into())
65            } else {
66                Err(CatalogError::duplicated("database", database_name).into())
67            };
68        }
69    }
70
71    let database_owner = if let Some(owner) = owner {
72        let owner = Binder::resolve_user_name(owner)?;
73        session
74            .env()
75            .user_info_reader()
76            .read_guard()
77            .get_user_by_name(&owner)
78            .map(|u| u.id)
79            .ok_or_else(|| CatalogError::NotFound("user", owner.clone()))?
80    } else {
81        session.user_id()
82    };
83
84    let resource_group = resource_group
85        .map(resolve_resource_group)
86        .transpose()?
87        .flatten();
88
89    if resource_group.is_some() {
90        risingwave_common::license::Feature::ResourceGroup
91            .check_available()
92            .map_err(|e| anyhow::anyhow!(e))?;
93    }
94
95    let resource_group = resource_group.as_deref().unwrap_or(DEFAULT_RESOURCE_GROUP);
96
97    if let Some(interval) = barrier_interval_ms
98        && interval >= NOTICE_BARRIER_INTERVAL_MS
99    {
100        builder = builder.notice(
101                    format!("Barrier interval is set to {} ms >= {} ms. This can hurt freshness and potentially cause OOM.",
102                             interval, NOTICE_BARRIER_INTERVAL_MS));
103    }
104    if let Some(frequency) = checkpoint_frequency
105        && frequency >= NOTICE_CHECKPOINT_FREQUENCY
106    {
107        builder = builder.notice(
108                    format!("Checkpoint frequency is set to {} >= {}. This can hurt freshness and potentially cause OOM.",
109                             frequency, NOTICE_CHECKPOINT_FREQUENCY));
110    }
111
112    let catalog_writer = session.catalog_writer()?;
113    catalog_writer
114        .create_database(
115            &database_name,
116            database_owner,
117            resource_group,
118            barrier_interval_ms,
119            checkpoint_frequency,
120        )
121        .await?;
122
123    Ok(builder.into())
124}
125
126#[cfg(test)]
127mod tests {
128    use crate::test_utils::LocalFrontend;
129
130    #[tokio::test]
131    async fn test_create_database() {
132        let frontend = LocalFrontend::new(Default::default()).await;
133        let session = frontend.session_ref();
134        let catalog_reader = session.env().catalog_reader();
135
136        frontend.run_sql("CREATE DATABASE database").await.unwrap();
137        {
138            let reader = catalog_reader.read_guard();
139            assert!(reader.get_database_by_name("database").is_ok());
140        }
141
142        frontend.run_sql("CREATE USER user WITH NOSUPERUSER NOCREATEDB PASSWORD 'md5827ccb0eea8a706c4c34a16891f84e7b'").await.unwrap();
143        let user_id = {
144            let user_reader = session.env().user_info_reader();
145            user_reader
146                .read_guard()
147                .get_user_by_name("user")
148                .unwrap()
149                .id
150        };
151        let res = frontend
152            .run_user_sql(
153                "CREATE DATABASE database2",
154                "dev".to_owned(),
155                "user".to_owned(),
156                user_id,
157            )
158            .await;
159        assert!(res.is_err());
160
161        frontend.run_sql("CREATE USER user2 WITH NOSUPERUSER CREATEDB PASSWORD 'md5827ccb0eea8a706c4c34a16891f84e7b'").await.unwrap();
162        let user_id = {
163            let user_reader = session.env().user_info_reader();
164            user_reader
165                .read_guard()
166                .get_user_by_name("user2")
167                .unwrap()
168                .id
169        };
170        frontend
171            .run_user_sql(
172                "CREATE DATABASE database2",
173                "dev".to_owned(),
174                "user2".to_owned(),
175                user_id,
176            )
177            .await
178            .unwrap();
179        {
180            let reader = catalog_reader.read_guard();
181            assert!(reader.get_database_by_name("database2").is_ok());
182        }
183    }
184}
risingwave_frontend/handler/create_database.rs

risingwave_frontend/handler/
create_database.rs
