risingwave_frontend/handler/
alter_system.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::session_config::SessionConfig;
17use risingwave_common::system_param::reader::SystemParamsRead;
18use risingwave_sqlparser::ast::{Ident, SetVariableValue};
19
20use super::variable::set_var_to_param_str;
21use super::{HandlerArgs, RwPgResponse};
22use crate::error::{ErrorCode, Result};
23
24// Warn user if barrier_interval_ms is set above 5mins.
25const NOTICE_BARRIER_INTERVAL_MS: u32 = 300000;
26// Warn user if checkpoint_frequency is set above 60.
27const NOTICE_CHECKPOINT_FREQUENCY: u64 = 60;
28
29pub async fn handle_alter_system(
30    handler_args: HandlerArgs,
31    param: Ident,
32    value: SetVariableValue,
33) -> Result<RwPgResponse> {
34    let value = set_var_to_param_str(&value);
35    let param_name = param.to_string();
36    let meta_client = handler_args.session.env().meta_client();
37    let mut builder = RwPgResponse::builder(StatementType::ALTER_SYSTEM);
38
39    // Currently session params are separated from system params. If the param exist in session params, we set it. Otherwise
40    // we try to set it as a system param.
41    if SessionConfig::contains_param(&param_name) {
42        if SessionConfig::check_no_alter_sys(&param_name)? {
43            return Err(ErrorCode::InternalError(format!(
44                "session param {} cannot be altered system wide",
45                param_name
46            ))
47            .into());
48        }
49        meta_client
50            .set_session_param(param_name.clone(), value.clone())
51            .await?;
52
53        if let Some(value) = value {
54            builder = builder.notice(format!(
55                "The config {param_name} of the current session has already been set to {value}"
56            ));
57            handler_args
58                .session
59                .set_config(param_name.as_str(), value)?;
60        } else {
61            builder = builder.notice(format!(
62                "The config {param_name} of the current session has already been reset to default"
63            ));
64            handler_args.session.reset_config(param_name.as_str())?;
65        }
66    } else {
67        let params = meta_client.set_system_param(param_name, value).await?;
68        if let Some(params) = params {
69            if params.barrier_interval_ms() >= NOTICE_BARRIER_INTERVAL_MS {
70                builder = builder.notice(
71                    format!("Barrier interval is set to {} ms >= {} ms. This can hurt freshness and potentially cause OOM.",
72                             params.barrier_interval_ms(), NOTICE_BARRIER_INTERVAL_MS));
73            }
74            if params.checkpoint_frequency() >= NOTICE_CHECKPOINT_FREQUENCY {
75                builder = builder.notice(
76                    format!("Checkpoint frequency is set to {} >= {}. This can hurt freshness and potentially cause OOM.",
77                             params.checkpoint_frequency(), NOTICE_CHECKPOINT_FREQUENCY));
78            }
79        }
80    }
81    Ok(builder.into())
82}
risingwave_frontend/handler/alter_system.rs

risingwave_frontend/handler/
alter_system.rs
