sql/statements/
explain.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::fmt::{Display, Formatter};
16
17use serde::Serialize;
18use sqlparser::ast::AnalyzeFormat;
19use sqlparser_derive::{Visit, VisitMut};
20
21use crate::statements::statement::Statement;
22
23/// Explain statement.
24#[derive(Debug, Clone, PartialEq, Eq, Visit, VisitMut, Serialize)]
25pub struct ExplainStatement {
26    /// `EXPLAIN ANALYZE ..`
27    pub analyze: bool,
28    /// `EXPLAIN .. VERBOSE ..`
29    pub verbose: bool,
30    /// `EXPLAIN .. FORMAT `
31    pub format: Option<AnalyzeFormat>,
32    /// The statement to analyze. Note this is a Greptime [`Statement`] (not a
33    /// [`sqlparser::ast::Statement`] so that we can use
34    /// Greptime specific statements
35    pub statement: Box<Statement>,
36}
37
38impl ExplainStatement {
39    pub fn format(&self) -> Option<AnalyzeFormat> {
40        self.format
41    }
42}
43
44impl Display for ExplainStatement {
45    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
46        write!(f, "EXPLAIN")?;
47        if self.analyze {
48            write!(f, " ANALYZE")?;
49        }
50        if self.verbose {
51            write!(f, " VERBOSE")?;
52        }
53        if let Some(format) = &self.format {
54            write!(f, " FORMAT {}", format)?;
55        }
56        write!(f, " {}", self.statement)
57    }
58}
sql/statements/explain.rs

sql/statements/
explain.rs
