common_grpc_expr/
error.rs

1// Copyright 2023 Greptime Team
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::any::Any;
16
17use api::v1::ColumnDataType;
18use common_error::ext::ErrorExt;
19use common_error::status_code::StatusCode;
20use common_macro::stack_trace_debug;
21use snafu::{Location, Snafu};
22use store_api::metadata::MetadataError;
23
24#[derive(Snafu)]
25#[snafu(visibility(pub))]
26#[stack_trace_debug]
27pub enum Error {
28    #[snafu(display("Column datatype error"))]
29    ColumnDataType {
30        #[snafu(implicit)]
31        location: Location,
32        source: api::error::Error,
33    },
34
35    #[snafu(display(
36        "Duplicated timestamp column in gRPC requests, exists {}, duplicated: {}",
37        exists,
38        duplicated
39    ))]
40    DuplicatedTimestampColumn {
41        exists: String,
42        duplicated: String,
43        #[snafu(implicit)]
44        location: Location,
45    },
46
47    #[snafu(display("Duplicated column name in gRPC requests, name: {}", name,))]
48    DuplicatedColumnName {
49        name: String,
50        #[snafu(implicit)]
51        location: Location,
52    },
53
54    #[snafu(display("Missing timestamp column, msg: {}", msg))]
55    MissingTimestampColumn {
56        msg: String,
57        #[snafu(implicit)]
58        location: Location,
59    },
60
61    #[snafu(display("Missing required field in protobuf, field: {}", field))]
62    MissingField {
63        field: String,
64        #[snafu(implicit)]
65        location: Location,
66    },
67
68    #[snafu(display("Invalid column proto definition, column: {}", column))]
69    InvalidColumnDef {
70        column: String,
71        #[snafu(implicit)]
72        location: Location,
73        source: api::error::Error,
74    },
75
76    #[snafu(display("Unknown location type: {}", location_type))]
77    UnknownLocationType {
78        location_type: i32,
79        #[snafu(implicit)]
80        location: Location,
81    },
82
83    #[snafu(display("Unknown proto column datatype: {}", datatype))]
84    UnknownColumnDataType {
85        datatype: i32,
86        #[snafu(implicit)]
87        location: Location,
88        #[snafu(source)]
89        error: prost::UnknownEnumValue,
90    },
91
92    #[snafu(display(
93        "Fulltext index only supports string type, column: {column_name}, unexpected type: {column_type:?}"
94    ))]
95    InvalidFulltextIndexColumnType {
96        column_name: String,
97        column_type: ColumnDataType,
98        #[snafu(implicit)]
99        location: Location,
100    },
101
102    #[snafu(display("Invalid set table option request"))]
103    InvalidSetTableOptionRequest {
104        #[snafu(source)]
105        error: MetadataError,
106    },
107
108    #[snafu(display("Invalid unset table option request"))]
109    InvalidUnsetTableOptionRequest {
110        #[snafu(source)]
111        error: MetadataError,
112    },
113
114    #[snafu(display("Invalid table option request: {err_msg}"))]
115    InvalidTableOptionRequest {
116        err_msg: String,
117        #[snafu(implicit)]
118        location: Location,
119    },
120
121    #[snafu(display("Invalid set fulltext option request"))]
122    InvalidSetFulltextOptionRequest {
123        #[snafu(implicit)]
124        location: Location,
125        #[snafu(source)]
126        error: prost::UnknownEnumValue,
127    },
128
129    #[snafu(display("Invalid set skipping index option request"))]
130    InvalidSetSkippingIndexOptionRequest {
131        #[snafu(implicit)]
132        location: Location,
133        #[snafu(source)]
134        error: prost::UnknownEnumValue,
135    },
136
137    #[snafu(display("Missing alter index options"))]
138    MissingAlterIndexOption {
139        #[snafu(implicit)]
140        location: Location,
141    },
142
143    #[snafu(display("Invalid index option"))]
144    InvalidIndexOption {
145        #[snafu(implicit)]
146        location: Location,
147        #[snafu(source)]
148        error: datatypes::error::Error,
149    },
150
151    #[snafu(display("Sql common error"))]
152    SqlCommon {
153        source: common_sql::error::Error,
154        #[snafu(implicit)]
155        location: Location,
156    },
157
158    #[snafu(display("Missing required field in protobuf, column name: {}", column_name))]
159    ColumnNotFound {
160        column_name: String,
161        #[snafu(implicit)]
162        location: Location,
163    },
164
165    #[snafu(display("Need table metadata, but not found, table_id: {}", table_id))]
166    MissingTableMeta {
167        table_id: u32,
168        #[snafu(implicit)]
169        location: Location,
170    },
171
172    #[snafu(display("Unexpected: {err_msg}"))]
173    Unexpected {
174        err_msg: String,
175        #[snafu(implicit)]
176        location: Location,
177    },
178}
179
180pub type Result<T> = std::result::Result<T, Error>;
181
182impl ErrorExt for Error {
183    fn status_code(&self) -> StatusCode {
184        match self {
185            Error::ColumnDataType { .. } => StatusCode::Internal,
186            Error::DuplicatedTimestampColumn { .. }
187            | Error::DuplicatedColumnName { .. }
188            | Error::MissingTimestampColumn { .. } => StatusCode::InvalidArguments,
189            Error::MissingField { .. } => StatusCode::InvalidArguments,
190            Error::InvalidColumnDef { source, .. } => source.status_code(),
191            Error::UnknownLocationType { .. } => StatusCode::InvalidArguments,
192
193            Error::UnknownColumnDataType { .. } | Error::InvalidFulltextIndexColumnType { .. } => {
194                StatusCode::InvalidArguments
195            }
196            Error::InvalidSetTableOptionRequest { .. }
197            | Error::InvalidUnsetTableOptionRequest { .. }
198            | Error::InvalidTableOptionRequest { .. }
199            | Error::InvalidSetFulltextOptionRequest { .. }
200            | Error::InvalidSetSkippingIndexOptionRequest { .. }
201            | Error::MissingAlterIndexOption { .. }
202            | Error::InvalidIndexOption { .. } => StatusCode::InvalidArguments,
203            Error::ColumnNotFound { .. } => StatusCode::TableColumnNotFound,
204            Error::SqlCommon { source, .. } => source.status_code(),
205            Error::MissingTableMeta { .. } => StatusCode::Unexpected,
206            Error::Unexpected { .. } => StatusCode::Unexpected,
207        }
208    }
209
210    fn as_any(&self) -> &dyn Any {
211        self
212    }
213}
common_grpc_expr/error.rs

common_grpc_expr/
error.rs
