formatQueryOneLine: create new function format queries on one line

2024-09-20 08:40:50 +00:00 · 2023-10-25 10:10:04 +02:00 · 2023-10-25 10:10:04 +02:00 · a95a2a5d66
commit a95a2a5d66
parent 2d2eaceb77
4 changed files with 132 additions and 4 deletions
--- a/docs/en/sql-reference/functions/other-functions.md
+++ b/docs/en/sql-reference/functions/other-functions.md
@ -2838,3 +2838,75 @@ Result:
 │ SELECT 1                 │
 └──────────────────────────┘
 ```
+
+```sql
+SELECT formatQuery('select a,    b FRom tab WHERE a > 3 and  b < 3');
+```
+
+Result:
+
+```result
+┌─formatQuery('select a,    b FRom tab WHERE a > 3 and  b < 3')─┐
+│ SELECT
+    a,
+    b
+FROM tab
+WHERE (a > 3) AND (b < 3)            │
+└───────────────────────────────────────────────────────────────┘
+```
+
+## formatQueryOneLine
+
+Returns a formatted version of the given SQL query on a single line.
+
+**Syntax**
+
+```sql
+formatQueryOneLine(query)
+```
+
+**Arguments**
+
+- `query` - The SQL query to be formatted. [String](../../sql-reference/data-types/string.md)
+
+**Returned value**
+
+- The formatted query. [String](../../sql-reference/data-types/string.md).
+
+**Example**
+
+```sql
+SELECT formatQueryOneLine('select 1;');
+```
+
+Result:
+
+```result
+┌─formatQueryOneLine('select 1;')─┐
+│ SELECT 1                        │
+└─────────────────────────────────┘
+```
+
+```sql
+SELECT formatQueryOneLine('SeLecT 1');
+```
+
+Result:
+
+```result
+┌─formatQueryOneLine('SeLecT 1')──┐
+│ SELECT 1                        │
+└─────────────────────────────────┘
+```
+
+```sql
+SELECT formatQueryOneLine('select a,    b FRom tab WHERE a > 3 and  b < 3');
+```
+
+Result:
+
+```result
+┌─formatQueryOneLine('select a,    b FRom tab WHERE a > 3 and  b < 3')─┐
+│ SELECT a, b FROM tab WHERE (a > 3) AND (b < 3)                       │
+└──────────────────────────────────────────────────────────────────────┘
+```
--- a/src/Functions/formatQuery.cpp
+++ b/src/Functions/formatQuery.cpp
@ -16,10 +16,11 @@ namespace ErrorCodes
    extern const int ILLEGAL_TYPE_OF_ARGUMENT;
 }

+template <bool one_line, typename Name>
 class FunctionFormatQuery : public IFunction
 {
 public:
-    static constexpr auto name = "formatQuery";
+    static constexpr auto name = Name::name;
    static FunctionPtr create(ContextPtr context)
    {
        const auto & settings = context->getSettings();
@ -66,7 +67,7 @@ private:
        ParserQuery parser{end};
        auto ast = parseQuery(parser, begin, end, {}, max_query_size, max_parser_depth);
        WriteBufferFromVector buf(output, AppendModeTag{});
-        formatAST(*ast, buf, /* hilite */ false);
+        formatAST(*ast, buf, /* hilite */ false, /* one_line */ one_line);
        buf.finalize();
    }
    void formatVector(
@ -93,15 +94,49 @@ private:
    size_t max_parser_depth;
 };

+struct NameFormatQuery
+{
+    static constexpr auto name = "formatQuery";
+};
+
+struct NameFormatQueryOneLine
+{
+    static constexpr auto name = "formatQueryOneLine";
+};

 REGISTER_FUNCTION(formatQuery)
 {
-    factory.registerFunction<FunctionFormatQuery>(FunctionDocumentation{
+    factory.registerFunction<FunctionFormatQuery<false, NameFormatQuery>>(FunctionDocumentation{
        .description = "Returns a formatted version of the given SQL query.\n[example:simple]\n[example:camelcase]",
        .syntax = "formatQuery(query)",
        .arguments = {{"query", "The SQL query to be formatted. [String](../../sql-reference/data-types/string.md)"}},
        .returned_value = "The formatted query. [String](../../sql-reference/data-types/string.md).",
-        .examples{{"simple", "SELECT formatQuery('select 1;')", "SELECT 1"}, {"camelcase", "SELECT formatQuery('SeLecT 1')", "SELECT 1"}},
+        .examples{
+            {"simple", "SELECT formatQuery('select 1;')", "SELECT 1"},
+            {"camelcase", "SELECT formatQuery('SeLecT 1')", "SELECT 1"},
+            {"multiline",
+             "SELECT formatQuery('select a,    b FRom tab WHERE a > 3 and  b < 3');",
+             "SELECT\n"
+             "    a,\n"
+             "    b\n"
+             "FROM tab\n"
+             "WHERE (a > 3) AND (b < 3)"}},
+        .categories{"Other"}});
+}
+
+REGISTER_FUNCTION(formatQueryOneLine)
+{
+    factory.registerFunction<FunctionFormatQuery<true, NameFormatQueryOneLine>>(FunctionDocumentation{
+        .description = "Returns a formatted version of the given SQL query on a single line.\n[example:simple]\n[example:camelcase]",
+        .syntax = "formatQueryOneLine(query)",
+        .arguments = {{"query", "The SQL query to be formatted. [String](../../sql-reference/data-types/string.md)"}},
+        .returned_value = "The formatted query. [String](../../sql-reference/data-types/string.md).",
+        .examples{
+            {"simple", "SELECT formatQueryOneLine('select 1;')", "SELECT 1"},
+            {"camelcase", "SELECT formatQueryOneLine('SeLecT 1')", "SELECT 1"},
+            {"multiline",
+             "SELECT formatQuery('select a,    b FRom tab WHERE a > 3 and  b < 3');",
+             "SELECT a, b FROM tab WHERE (a > 3) AND (b < 3)"}},
        .categories{"Other"}});
 }
 }
--- a/tests/queries/0_stateless/02882_formatQuery.reference
+++ b/tests/queries/0_stateless/02882_formatQuery.reference
@ -7,3 +7,13 @@ INSERT INTO tab FORMAT Values
 CREATE TABLE default.no_prop_table\n(\n    `some_column` UInt64\n)\nENGINE = MergeTree\nORDER BY tuple()\nSETTINGS index_granularity = 8192
 EXPLAIN SYNTAX\nSELECT\n    CAST(1, \'INT\'),\n    CEIL(1),\n    CEILING(1),\n    CHAR(49),\n    CHAR_LENGTH(\'1\'),\n    CHARACTER_LENGTH(\'1\'),\n    COALESCE(1),\n    CONCAT(\'1\', \'1\'),\n    CORR(1, 1),\n    COS(1),\n    COUNT(1),\n    COVAR_POP(1, 1),\n    COVAR_SAMP(1, 1),\n    DATABASE(),\n    SCHEMA(),\n    dateDiff(\'DAY\', toDate(\'2020-10-24\'), toDate(\'2019-10-24\')),\n    EXP(1),\n    FLATTEN([[1]]),\n    FLOOR(1),\n    FQDN(),\n    GREATEST(1),\n    IF(1, 1, 1),\n    IFNULL(1, 1),\n    LCASE(\'A\'),\n    LEAST(1),\n    LENGTH(\'1\'),\n    LN(1),\n    LOCATE(\'1\', \'1\'),\n    LOG(1),\n    LOG10(1),\n    LOG2(1),\n    LOWER(\'A\'),\n    MAX(1),\n    MID(\'123\', 1, 1),\n    MIN(1),\n    MOD(1, 1),\n    NOT 1,\n    NOW(),\n    NOW64(),\n    NULLIF(1, 1),\n    PI(),\n    position(\'123\', \'2\'),\n    POW(1, 1),\n    POWER(1, 1),\n    RAND(),\n    REPLACE(\'1\', \'1\', \'2\'),\n    REVERSE(\'123\'),\n    ROUND(1),\n    SIN(1),\n    SQRT(1),\n    STDDEV_POP(1),\n    STDDEV_SAMP(1),\n    SUBSTR(\'123\', 2),\n    substring(\'123\', 2),\n    SUM(1),\n    TAN(1),\n    TANH(1),\n    TRUNC(1),\n    TRUNCATE(1),\n    UCASE(\'A\'),\n    UPPER(\'A\'),\n    USER(),\n    VAR_POP(1),\n    VAR_SAMP(1),\n    WEEK(toDate(\'2020-10-24\')),\n    YEARWEEK(toDate(\'2020-10-24\'))\nFORMAT TSVRaw
 1
+formatQueryOneLine
+SELECT 1
+SELECT 1
+SELECT 1
+SELECT 1
+1
+INSERT INTO tab FORMAT Values
+CREATE TABLE default.no_prop_table (`some_column` UInt64) ENGINE = MergeTree ORDER BY tuple() SETTINGS index_granularity = 8192
+EXPLAIN SYNTAX SELECT CAST(1, \'INT\'), CEIL(1), CEILING(1), CHAR(49), CHAR_LENGTH(\'1\'), CHARACTER_LENGTH(\'1\'), COALESCE(1), CONCAT(\'1\', \'1\'), CORR(1, 1), COS(1), COUNT(1), COVAR_POP(1, 1), COVAR_SAMP(1, 1), DATABASE(), SCHEMA(), dateDiff(\'DAY\', toDate(\'2020-10-24\'), toDate(\'2019-10-24\')), EXP(1), FLATTEN([[1]]), FLOOR(1), FQDN(), GREATEST(1), IF(1, 1, 1), IFNULL(1, 1), LCASE(\'A\'), LEAST(1), LENGTH(\'1\'), LN(1), LOCATE(\'1\', \'1\'), LOG(1), LOG10(1), LOG2(1), LOWER(\'A\'), MAX(1), MID(\'123\', 1, 1), MIN(1), MOD(1, 1), NOT 1, NOW(), NOW64(), NULLIF(1, 1), PI(), position(\'123\', \'2\'), POW(1, 1), POWER(1, 1), RAND(), REPLACE(\'1\', \'1\', \'2\'), REVERSE(\'123\'), ROUND(1), SIN(1), SQRT(1), STDDEV_POP(1), STDDEV_SAMP(1), SUBSTR(\'123\', 2), substring(\'123\', 2), SUM(1), TAN(1), TANH(1), TRUNC(1), TRUNCATE(1), UCASE(\'A\'), UPPER(\'A\'), USER(), VAR_POP(1), VAR_SAMP(1), WEEK(toDate(\'2020-10-24\')), YEARWEEK(toDate(\'2020-10-24\')) FORMAT TSVRaw
+1
--- a/tests/queries/0_stateless/02882_formatQuery.sql
+++ b/tests/queries/0_stateless/02882_formatQuery.sql
@ -8,3 +8,14 @@ SELECT formatQuery('CREATE TABLE default.no_prop_table(`some_column` UInt64) ENG
 SELECT formatQuery('EXPLAIN SYNTAX SELECT CAST(1 AS INT), CEIL(1), CEILING(1), CHAR(49), CHAR_LENGTH(\'1\'), CHARACTER_LENGTH(\'1\'), COALESCE(1), CONCAT(\'1\', \'1\'), CORR(1, 1), COS(1), COUNT(1), COVAR_POP(1, 1), COVAR_SAMP(1, 1), DATABASE(), SCHEMA(), DATEDIFF(\'DAY\', toDate(\'2020-10-24\'), toDate(\'2019-10-24\')), EXP(1), FLATTEN([[1]]), FLOOR(1), FQDN(), GREATEST(1), IF(1, 1, 1), IFNULL(1, 1), LCASE(\'A\'), LEAST(1), LENGTH(\'1\'), LN(1), LOCATE(\'1\', \'1\'), LOG(1), LOG10(1), LOG2(1), LOWER(\'A\'), MAX(1), MID(\'123\', 1, 1), MIN(1), MOD(1, 1), NOT(1), NOW(), NOW64(), NULLIF(1, 1), PI(), POSITION(\'123\', \'2\'), POW(1, 1), POWER(1, 1), RAND(), REPLACE(\'1\', \'1\', \'2\'), REVERSE(\'123\'), ROUND(1), SIN(1), SQRT(1), STDDEV_POP(1), STDDEV_SAMP(1), SUBSTR(\'123\', 2), SUBSTRING(\'123\', 2), SUM(1), TAN(1), TANH(1), TRUNC(1), TRUNCATE(1), UCASE(\'A\'), UPPER(\'A\'), USER(), VAR_POP(1), VAR_SAMP(1), WEEK(toDate(\'2020-10-24\')), YEARWEEK(toDate(\'2020-10-24\')) format TSVRaw;');
 SELECT normalizedQueryHash(formatQuery('select 1')) = normalizedQueryHash(formatQuery('SELECT 1'));
 SELECT formatQuery('SEECTwrong'); -- { serverError SYNTAX_ERROR }
+SELECT 'formatQueryOneLine';
+SELECT formatQueryOneLine('select 1;');
+SELECT formatQueryOneLine('select 1');
+SELECT formatQueryOneLine('SELECT 1;');
+SELECT formatQueryOneLine('SELECT 1');
+SELECT formatQueryOneLine('select 1;') == formatQueryOneLine('SeLecT 1');
+SELECT formatQueryOneLine('INSERT INTO tab VALUES (\'\') (\'test\')');
+SELECT formatQueryOneLine('CREATE TABLE default.no_prop_table(`some_column` UInt64) ENGINE = MergeTree ORDER BY tuple() SETTINGS index_granularity = 8192');
+SELECT formatQueryOneLine('EXPLAIN SYNTAX SELECT CAST(1 AS INT), CEIL(1), CEILING(1), CHAR(49), CHAR_LENGTH(\'1\'), CHARACTER_LENGTH(\'1\'), COALESCE(1), CONCAT(\'1\', \'1\'), CORR(1, 1), COS(1), COUNT(1), COVAR_POP(1, 1), COVAR_SAMP(1, 1), DATABASE(), SCHEMA(), DATEDIFF(\'DAY\', toDate(\'2020-10-24\'), toDate(\'2019-10-24\')), EXP(1), FLATTEN([[1]]), FLOOR(1), FQDN(), GREATEST(1), IF(1, 1, 1), IFNULL(1, 1), LCASE(\'A\'), LEAST(1), LENGTH(\'1\'), LN(1), LOCATE(\'1\', \'1\'), LOG(1), LOG10(1), LOG2(1), LOWER(\'A\'), MAX(1), MID(\'123\', 1, 1), MIN(1), MOD(1, 1), NOT(1), NOW(), NOW64(), NULLIF(1, 1), PI(), POSITION(\'123\', \'2\'), POW(1, 1), POWER(1, 1), RAND(), REPLACE(\'1\', \'1\', \'2\'), REVERSE(\'123\'), ROUND(1), SIN(1), SQRT(1), STDDEV_POP(1), STDDEV_SAMP(1), SUBSTR(\'123\', 2), SUBSTRING(\'123\', 2), SUM(1), TAN(1), TANH(1), TRUNC(1), TRUNCATE(1), UCASE(\'A\'), UPPER(\'A\'), USER(), VAR_POP(1), VAR_SAMP(1), WEEK(toDate(\'2020-10-24\')), YEARWEEK(toDate(\'2020-10-24\')) format TSVRaw;');
+SELECT normalizedQueryHash(formatQueryOneLine('select 1')) = normalizedQueryHash(formatQueryOneLine('SELECT 1'));
+SELECT formatQueryOneLine('SEECTwrong'); -- { serverError SYNTAX_ERROR }