sql/statements/
statement.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;
16
17use datafusion_sql::parser::Statement as DfStatement;
18use serde::Serialize;
19use sqlparser::ast::Statement as SpStatement;
20use sqlparser_derive::{Visit, VisitMut};
21
22use crate::error::{ConvertToDfStatementSnafu, Error};
23use crate::statements::admin::Admin;
24use crate::statements::alter::{AlterDatabase, AlterTable};
25use crate::statements::comment::Comment;
26use crate::statements::copy::Copy;
27use crate::statements::create::{
28    CreateDatabase, CreateExternalTable, CreateFlow, CreateTable, CreateTableLike, CreateView,
29};
30use crate::statements::cursor::{CloseCursor, DeclareCursor, FetchCursor};
31use crate::statements::delete::Delete;
32use crate::statements::describe::DescribeTable;
33use crate::statements::drop::{DropDatabase, DropFlow, DropTable, DropView};
34use crate::statements::explain::ExplainStatement;
35use crate::statements::insert::Insert;
36use crate::statements::kill::Kill;
37use crate::statements::query::Query;
38use crate::statements::set_variables::SetVariables;
39use crate::statements::show::{
40    ShowColumns, ShowCreateDatabase, ShowCreateFlow, ShowCreateTable, ShowCreateView,
41    ShowDatabases, ShowFlows, ShowIndex, ShowKind, ShowProcessList, ShowRegion, ShowSearchPath,
42    ShowStatus, ShowTableStatus, ShowTables, ShowVariables, ShowViews,
43};
44use crate::statements::tql::Tql;
45use crate::statements::truncate::TruncateTable;
46
47/// Tokens parsed by `DFParser` are converted into these values.
48#[allow(clippy::large_enum_variant)]
49#[derive(Debug, Clone, PartialEq, Eq, Visit, VisitMut, Serialize)]
50pub enum Statement {
51    // Query
52    Query(Box<Query>),
53    // Insert
54    Insert(Box<Insert>),
55    // Delete
56    Delete(Box<Delete>),
57    /// CREATE TABLE
58    CreateTable(CreateTable),
59    // CREATE EXTERNAL TABLE
60    CreateExternalTable(CreateExternalTable),
61    // CREATE TABLE ... LIKE
62    CreateTableLike(CreateTableLike),
63    // CREATE FLOW
64    CreateFlow(CreateFlow),
65    // CREATE VIEW ... AS
66    CreateView(CreateView),
67    // CREATE TRIGGER
68    #[cfg(feature = "enterprise")]
69    CreateTrigger(crate::statements::create::trigger::CreateTrigger),
70    // DROP TABLE
71    DropTable(DropTable),
72    // DROP DATABASE
73    DropDatabase(DropDatabase),
74    // DROP FLOW
75    DropFlow(DropFlow),
76    // DROP Trigger
77    #[cfg(feature = "enterprise")]
78    DropTrigger(crate::statements::drop::trigger::DropTrigger),
79    // DROP View
80    DropView(DropView),
81    // CREATE DATABASE
82    CreateDatabase(CreateDatabase),
83    /// ALTER TABLE
84    AlterTable(AlterTable),
85    /// ALTER DATABASE
86    AlterDatabase(AlterDatabase),
87    /// ALTER TRIGGER
88    #[cfg(feature = "enterprise")]
89    AlterTrigger(crate::statements::alter::trigger::AlterTrigger),
90    // Databases.
91    ShowDatabases(ShowDatabases),
92    // SHOW TABLES
93    ShowTables(ShowTables),
94    // SHOW TABLE STATUS
95    ShowTableStatus(ShowTableStatus),
96    // SHOW COLUMNS
97    ShowColumns(ShowColumns),
98    // SHOW CHARSET or SHOW CHARACTER SET
99    ShowCharset(ShowKind),
100    // SHOW COLLATION
101    ShowCollation(ShowKind),
102    // SHOW INDEX
103    ShowIndex(ShowIndex),
104    // SHOW REGION
105    ShowRegion(ShowRegion),
106    // SHOW CREATE DATABASE
107    ShowCreateDatabase(ShowCreateDatabase),
108    // SHOW CREATE TABLE
109    ShowCreateTable(ShowCreateTable),
110    // SHOW CREATE FLOW
111    ShowCreateFlow(ShowCreateFlow),
112    #[cfg(feature = "enterprise")]
113    ShowCreateTrigger(crate::statements::show::trigger::ShowCreateTrigger),
114    /// SHOW FLOWS
115    ShowFlows(ShowFlows),
116    // SHOW TRIGGERS
117    #[cfg(feature = "enterprise")]
118    ShowTriggers(crate::statements::show::trigger::ShowTriggers),
119    // SHOW CREATE VIEW
120    ShowCreateView(ShowCreateView),
121    // SHOW STATUS
122    ShowStatus(ShowStatus),
123    // SHOW SEARCH_PATH
124    ShowSearchPath(ShowSearchPath),
125    // SHOW VIEWS
126    ShowViews(ShowViews),
127    // DESCRIBE TABLE
128    DescribeTable(DescribeTable),
129    // EXPLAIN QUERY
130    Explain(Box<ExplainStatement>),
131    // COPY
132    Copy(Copy),
133    // Telemetry Query Language
134    Tql(Tql),
135    // TRUNCATE TABLE
136    TruncateTable(TruncateTable),
137    // SET VARIABLES
138    SetVariables(SetVariables),
139    // SHOW VARIABLES
140    ShowVariables(ShowVariables),
141    // COMMENT ON
142    Comment(Comment),
143    // USE
144    Use(String),
145    // Admin statement(extension)
146    Admin(Admin),
147    // DECLARE ... CURSOR FOR ...
148    DeclareCursor(DeclareCursor),
149    // FETCH ... FROM ...
150    FetchCursor(FetchCursor),
151    // CLOSE
152    CloseCursor(CloseCursor),
153    // KILL <process>
154    Kill(Kill),
155    // SHOW PROCESSLIST
156    ShowProcesslist(ShowProcessList),
157}
158
159impl Statement {
160    pub fn is_readonly(&self) -> bool {
161        match self {
162            // Read-only operations
163            Statement::Query(_)
164            | Statement::ShowDatabases(_)
165            | Statement::ShowTables(_)
166            | Statement::ShowTableStatus(_)
167            | Statement::ShowColumns(_)
168            | Statement::ShowCharset(_)
169            | Statement::ShowCollation(_)
170            | Statement::ShowIndex(_)
171            | Statement::ShowRegion(_)
172            | Statement::ShowCreateDatabase(_)
173            | Statement::ShowCreateTable(_)
174            | Statement::ShowCreateFlow(_)
175            | Statement::ShowFlows(_)
176            | Statement::ShowCreateView(_)
177            | Statement::ShowStatus(_)
178            | Statement::ShowSearchPath(_)
179            | Statement::ShowViews(_)
180            | Statement::DescribeTable(_)
181            | Statement::ShowVariables(_)
182            | Statement::ShowProcesslist(_)
183            | Statement::FetchCursor(_)
184            | Statement::Tql(_) => true,
185
186            #[cfg(feature = "enterprise")]
187            Statement::ShowCreateTrigger(_) => true,
188            #[cfg(feature = "enterprise")]
189            Statement::ShowTriggers(_) => true,
190
191            Statement::Explain(explain) => !explain.analyze || explain.statement.is_readonly(),
192
193            // Write operations
194            Statement::Insert(_)
195            | Statement::Delete(_)
196            | Statement::CreateTable(_)
197            | Statement::CreateExternalTable(_)
198            | Statement::CreateTableLike(_)
199            | Statement::CreateFlow(_)
200            | Statement::CreateView(_)
201            | Statement::DropTable(_)
202            | Statement::DropDatabase(_)
203            | Statement::DropFlow(_)
204            | Statement::DropView(_)
205            | Statement::CreateDatabase(_)
206            | Statement::AlterTable(_)
207            | Statement::AlterDatabase(_)
208            | Statement::Copy(_)
209            | Statement::TruncateTable(_)
210            | Statement::SetVariables(_)
211            | Statement::Comment(_)
212            | Statement::Use(_)
213            | Statement::DeclareCursor(_)
214            | Statement::CloseCursor(_)
215            | Statement::Kill(_)
216            | Statement::Admin(_) => false,
217
218            #[cfg(feature = "enterprise")]
219            Statement::AlterTrigger(_) => false,
220
221            #[cfg(feature = "enterprise")]
222            Statement::CreateTrigger(_) | Statement::DropTrigger(_) => false,
223        }
224    }
225}
226
227impl Display for Statement {
228    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
229        match self {
230            Statement::Query(s) => s.inner.fmt(f),
231            Statement::Insert(s) => s.inner.fmt(f),
232            Statement::Delete(s) => s.inner.fmt(f),
233            Statement::CreateTable(s) => s.fmt(f),
234            Statement::CreateExternalTable(s) => s.fmt(f),
235            Statement::CreateTableLike(s) => s.fmt(f),
236            Statement::CreateFlow(s) => s.fmt(f),
237            #[cfg(feature = "enterprise")]
238            Statement::CreateTrigger(s) => s.fmt(f),
239            Statement::DropFlow(s) => s.fmt(f),
240            #[cfg(feature = "enterprise")]
241            Statement::DropTrigger(s) => s.fmt(f),
242            Statement::DropTable(s) => s.fmt(f),
243            Statement::DropDatabase(s) => s.fmt(f),
244            Statement::DropView(s) => s.fmt(f),
245            Statement::CreateDatabase(s) => s.fmt(f),
246            Statement::AlterTable(s) => s.fmt(f),
247            Statement::AlterDatabase(s) => s.fmt(f),
248            #[cfg(feature = "enterprise")]
249            Statement::AlterTrigger(s) => s.fmt(f),
250            Statement::ShowDatabases(s) => s.fmt(f),
251            Statement::ShowTables(s) => s.fmt(f),
252            Statement::ShowTableStatus(s) => s.fmt(f),
253            Statement::ShowColumns(s) => s.fmt(f),
254            Statement::ShowIndex(s) => s.fmt(f),
255            Statement::ShowRegion(s) => s.fmt(f),
256            Statement::ShowCreateTable(s) => s.fmt(f),
257            Statement::ShowCreateFlow(s) => s.fmt(f),
258            #[cfg(feature = "enterprise")]
259            Statement::ShowCreateTrigger(s) => s.fmt(f),
260            Statement::ShowFlows(s) => s.fmt(f),
261            #[cfg(feature = "enterprise")]
262            Statement::ShowTriggers(s) => s.fmt(f),
263            Statement::ShowCreateDatabase(s) => s.fmt(f),
264            Statement::ShowCreateView(s) => s.fmt(f),
265            Statement::ShowViews(s) => s.fmt(f),
266            Statement::ShowStatus(s) => s.fmt(f),
267            Statement::ShowSearchPath(s) => s.fmt(f),
268            Statement::DescribeTable(s) => s.fmt(f),
269            Statement::Explain(s) => s.fmt(f),
270            Statement::Copy(s) => s.fmt(f),
271            Statement::Tql(s) => s.fmt(f),
272            Statement::TruncateTable(s) => s.fmt(f),
273            Statement::SetVariables(s) => s.fmt(f),
274            Statement::ShowVariables(s) => s.fmt(f),
275            Statement::Comment(s) => s.fmt(f),
276            Statement::ShowCharset(kind) => {
277                write!(f, "SHOW CHARSET {kind}")
278            }
279            Statement::ShowCollation(kind) => {
280                write!(f, "SHOW COLLATION {kind}")
281            }
282            Statement::CreateView(s) => s.fmt(f),
283            Statement::Use(s) => s.fmt(f),
284            Statement::Admin(admin) => admin.fmt(f),
285            Statement::DeclareCursor(s) => s.fmt(f),
286            Statement::FetchCursor(s) => s.fmt(f),
287            Statement::CloseCursor(s) => s.fmt(f),
288            Statement::Kill(k) => k.fmt(f),
289            Statement::ShowProcesslist(s) => s.fmt(f),
290        }
291    }
292}
293
294/// Comment hints from SQL.
295/// It'll be enabled when using `--comment` in mysql client.
296/// Eg: `SELECT * FROM system.number LIMIT 1; -- { ErrorCode 25 }`
297#[derive(Debug, Clone, PartialEq, Eq)]
298pub struct Hint {
299    pub error_code: Option<u16>,
300    pub comment: String,
301    pub prefix: String,
302}
303
304impl TryFrom<&Statement> for DfStatement {
305    type Error = Error;
306
307    fn try_from(s: &Statement) -> Result<Self, Self::Error> {
308        let s = match s {
309            Statement::Query(query) => SpStatement::Query(Box::new(query.inner.clone())),
310            Statement::Insert(insert) => insert.inner.clone(),
311            Statement::Delete(delete) => delete.inner.clone(),
312            _ => {
313                return ConvertToDfStatementSnafu {
314                    statement: format!("{s:?}"),
315                }
316                .fail();
317            }
318        };
319        Ok(DfStatement::Statement(Box::new(s)))
320    }
321}
sql/statements/statement.rs

sql/statements/
statement.rs
