sqlparser/dialect/clickhouse.rs
1// Licensed to the Apache Software Foundation (ASF) under one
2// or more contributor license agreements. See the NOTICE file
3// distributed with this work for additional information
4// regarding copyright ownership. The ASF licenses this file
5// to you under the Apache License, Version 2.0 (the
6// "License"); you may not use this file except in compliance
7// with the License. You may obtain a copy of the License at
8//
9// http://www.apache.org/licenses/LICENSE-2.0
10//
11// Unless required by applicable law or agreed to in writing,
12// software distributed under the License is distributed on an
13// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14// KIND, either express or implied. See the License for the
15// specific language governing permissions and limitations
16// under the License.
17
18use crate::dialect::Dialect;
19
20// A [`Dialect`] for [ClickHouse](https://clickhouse.com/).
21#[derive(Debug)]
22pub struct ClickHouseDialect {}
23
24impl Dialect for ClickHouseDialect {
25 fn is_identifier_start(&self, ch: char) -> bool {
26 // See https://clickhouse.com/docs/en/sql-reference/syntax/#syntax-identifiers
27 ch.is_ascii_lowercase() || ch.is_ascii_uppercase() || ch == '_'
28 }
29
30 fn is_identifier_part(&self, ch: char) -> bool {
31 self.is_identifier_start(ch) || ch.is_ascii_digit()
32 }
33
34 fn supports_string_literal_backslash_escape(&self) -> bool {
35 true
36 }
37
38 fn supports_select_wildcard_except(&self) -> bool {
39 true
40 }
41
42 fn describe_requires_table_keyword(&self) -> bool {
43 true
44 }
45
46 fn require_interval_qualifier(&self) -> bool {
47 true
48 }
49
50 fn supports_limit_comma(&self) -> bool {
51 true
52 }
53
54 fn supports_insert_table_function(&self) -> bool {
55 true
56 }
57
58 fn supports_insert_format(&self) -> bool {
59 true
60 }
61
62 fn supports_numeric_literal_underscores(&self) -> bool {
63 true
64 }
65
66 // ClickHouse uses this for some FORMAT expressions in `INSERT` context, e.g. when inserting
67 // with FORMAT JSONEachRow a raw JSON key-value expression is valid and expected.
68 //
69 // [ClickHouse formats](https://clickhouse.com/docs/en/interfaces/formats)
70 fn supports_dictionary_syntax(&self) -> bool {
71 true
72 }
73
74 /// See <https://clickhouse.com/docs/en/sql-reference/functions#higher-order-functions---operator-and-lambdaparams-expr-function>
75 fn supports_lambda_functions(&self) -> bool {
76 true
77 }
78
79 fn supports_from_first_select(&self) -> bool {
80 true
81 }
82
83 /// See <https://clickhouse.com/docs/en/sql-reference/statements/select/order-by>
84 fn supports_order_by_all(&self) -> bool {
85 true
86 }
87
88 // See <https://clickhouse.com/docs/en/sql-reference/aggregate-functions/grouping_function#grouping-sets>
89 fn supports_group_by_expr(&self) -> bool {
90 true
91 }
92
93 /// See <https://clickhouse.com/docs/en/sql-reference/statements/select/group-by#rollup-modifier>
94 fn supports_group_by_with_modifier(&self) -> bool {
95 true
96 }
97}