risingwave_meta/
error.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::error::{BoxedError, NotImplemented};
16use risingwave_common::secret::SecretError;
17use risingwave_common::session_config::SessionConfigError;
18use risingwave_connector::error::ConnectorError;
19use risingwave_connector::sink::SinkError;
20use risingwave_meta_model::WorkerId;
21use risingwave_pb::PbFieldNotFound;
22use risingwave_rpc_client::error::{RpcError, ToTonicStatus};
23
24use crate::hummock::error::Error as HummockError;
25use crate::model::MetadataModelError;
26use crate::storage::MetaStoreError;
27
28pub type MetaResult<T> = std::result::Result<T, MetaError>;
29
30#[derive(
31    thiserror::Error,
32    thiserror_ext::ReportDebug,
33    thiserror_ext::Arc,
34    thiserror_ext::Construct,
35    thiserror_ext::Macro,
36)]
37#[thiserror_ext(newtype(name = MetaError, backtrace), macro(path = "crate::error"))]
38pub enum MetaErrorInner {
39    #[error("MetaStore transaction error: {0}")]
40    TransactionError(
41        #[source]
42        #[backtrace]
43        MetaStoreError,
44    ),
45
46    #[error("MetadataModel error: {0}")]
47    MetadataModelError(
48        #[from]
49        #[backtrace]
50        MetadataModelError,
51    ),
52
53    #[error("Hummock error: {0}")]
54    HummockError(
55        #[from]
56        #[backtrace]
57        HummockError,
58    ),
59
60    #[error(transparent)]
61    RpcError(
62        #[from]
63        #[backtrace]
64        RpcError,
65    ),
66
67    #[error("PermissionDenied: {0}")]
68    PermissionDenied(String),
69
70    #[error("Invalid worker: {0}, {1}")]
71    InvalidWorker(WorkerId, String),
72
73    #[error("Invalid parameter: {0}")]
74    InvalidParameter(#[message] String),
75
76    // Used for catalog errors.
77    #[error("{0} id not found: {1}")]
78    #[construct(skip)]
79    CatalogIdNotFound(&'static str, String),
80
81    #[error("table_fragment not exist: id={0}")]
82    FragmentNotFound(u32),
83
84    #[error("{0} with name {1} exists")]
85    Duplicated(&'static str, String),
86
87    #[error("Service unavailable: {0}")]
88    Unavailable(#[message] String),
89
90    #[error("Election failed: {0}")]
91    Election(#[source] BoxedError),
92
93    #[error("Cancelled: {0}")]
94    Cancelled(String),
95
96    #[error("SystemParams error: {0}")]
97    SystemParams(String),
98
99    #[error("SessionParams error: {0}")]
100    SessionConfig(
101        #[from]
102        #[backtrace]
103        SessionConfigError,
104    ),
105
106    #[error(transparent)]
107    Connector(
108        #[from]
109        #[backtrace]
110        ConnectorError,
111    ),
112
113    #[error("Sink error: {0}")]
114    Sink(
115        #[from]
116        #[backtrace]
117        SinkError,
118    ),
119
120    #[error(transparent)]
121    Internal(
122        #[from]
123        #[backtrace]
124        anyhow::Error,
125    ),
126
127    // Indicates that recovery was triggered manually.
128    #[error("adhoc recovery triggered")]
129    AdhocRecovery,
130
131    #[error("Integrity check failed")]
132    IntegrityCheckFailed,
133
134    #[error("{0} has been deprecated, please use {1} instead.")]
135    Deprecated(String, String),
136
137    #[error(transparent)]
138    NotImplemented(#[from] NotImplemented),
139
140    #[error("Secret error: {0}")]
141    SecretError(
142        #[from]
143        #[backtrace]
144        SecretError,
145    ),
146}
147
148impl MetaError {
149    pub fn is_invalid_worker(&self) -> bool {
150        matches!(self.inner(), MetaErrorInner::InvalidWorker(..))
151    }
152
153    pub fn catalog_id_not_found<T: ToString>(relation: &'static str, id: T) -> Self {
154        MetaErrorInner::CatalogIdNotFound(relation, id.to_string()).into()
155    }
156
157    pub fn is_fragment_not_found(&self) -> bool {
158        matches!(self.inner(), MetaErrorInner::FragmentNotFound(..))
159    }
160
161    pub fn is_cancelled(&self) -> bool {
162        matches!(self.inner(), MetaErrorInner::Cancelled(..))
163    }
164
165    pub fn catalog_duplicated<T: Into<String>>(relation: &'static str, name: T) -> Self {
166        MetaErrorInner::Duplicated(relation, name.into()).into()
167    }
168}
169
170impl From<MetaError> for tonic::Status {
171    fn from(err: MetaError) -> Self {
172        use tonic::Code;
173
174        let code = match err.inner() {
175            MetaErrorInner::PermissionDenied(_) => Code::PermissionDenied,
176            MetaErrorInner::CatalogIdNotFound(_, _) => Code::NotFound,
177            MetaErrorInner::Duplicated(_, _) => Code::AlreadyExists,
178            MetaErrorInner::Unavailable(_) => Code::Unavailable,
179            MetaErrorInner::Cancelled(_) => Code::Cancelled,
180            MetaErrorInner::InvalidParameter(_) => Code::InvalidArgument,
181            _ => Code::Internal,
182        };
183
184        err.to_status(code, "meta")
185    }
186}
187
188impl From<PbFieldNotFound> for MetaError {
189    fn from(e: PbFieldNotFound) -> Self {
190        MetadataModelError::from(e).into()
191    }
192}
193
194impl From<MetaStoreError> for MetaError {
195    fn from(e: MetaStoreError) -> Self {
196        match e {
197            // `MetaStore::txn` method error.
198            MetaStoreError::TransactionAbort() => MetaErrorInner::TransactionError(e).into(),
199            _ => MetadataModelError::from(e).into(),
200        }
201    }
202}
203
204impl From<MetaErrorInner> for SinkError {
205    fn from(e: MetaErrorInner) -> Self {
206        SinkError::Coordinator(e.into())
207    }
208}
209
210impl From<MetaError> for SinkError {
211    fn from(e: MetaError) -> Self {
212        SinkError::Coordinator(e.into())
213    }
214}
risingwave_meta/error.rs

risingwave_meta/
error.rs
