@guojc1/sql-formatter-compact 1.0.0

package/dist/esm/languages/bigquery/bigquery.formatter.js

@@ -0,0 +1,256 @@
+import { expandPhrases } from '../../expandPhrases.js';
+import { EOF_TOKEN, isToken, TokenType } from '../../lexer/token.js';
+import { functions } from './bigquery.functions.js';
+import { dataTypes, keywords } from './bigquery.keywords.js';
+const reservedSelect = expandPhrases(['SELECT [ALL | DISTINCT] [AS STRUCT | AS VALUE]']);
+const reservedClauses = expandPhrases([
+    // Queries: https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax
+    'WITH [RECURSIVE]',
+    'FROM',
+    'WHERE',
+    'GROUP BY',
+    'HAVING',
+    'QUALIFY',
+    'WINDOW',
+    'PARTITION BY',
+    'ORDER BY',
+    'LIMIT',
+    'OFFSET',
+    'OMIT RECORD IF',
+    // Data modification: https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax
+    // - insert:
+    'INSERT [INTO]',
+    'VALUES',
+    // - update:
+    'SET',
+    // - merge:
+    'MERGE [INTO]',
+    'WHEN [NOT] MATCHED [BY SOURCE | BY TARGET] [THEN]',
+    'UPDATE SET',
+    'CLUSTER BY',
+    'FOR SYSTEM_TIME AS OF',
+    'WITH CONNECTION',
+    'WITH PARTITION COLUMNS',
+    'REMOTE WITH CONNECTION',
+]);
+const standardOnelineClauses = expandPhrases([
+    'CREATE [OR REPLACE] [TEMP|TEMPORARY|SNAPSHOT|EXTERNAL] TABLE [IF NOT EXISTS]',
+]);
+const tabularOnelineClauses = expandPhrases([
+    // - create:
+    // https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language
+    'CREATE [OR REPLACE] [MATERIALIZED] VIEW [IF NOT EXISTS]',
+    // - update:
+    'UPDATE',
+    // - delete:
+    'DELETE [FROM]',
+    // - drop table:
+    'DROP [SNAPSHOT | EXTERNAL] TABLE [IF EXISTS]',
+    // - alter table:
+    'ALTER TABLE [IF EXISTS]',
+    'ADD COLUMN [IF NOT EXISTS]',
+    'DROP COLUMN [IF EXISTS]',
+    'RENAME TO',
+    'ALTER COLUMN [IF EXISTS]',
+    'SET DEFAULT COLLATE',
+    'SET OPTIONS',
+    'DROP NOT NULL',
+    'SET DATA TYPE',
+    // - alter schema
+    'ALTER SCHEMA [IF EXISTS]',
+    // - alter view
+    'ALTER [MATERIALIZED] VIEW [IF EXISTS]',
+    // - alter bi_capacity
+    'ALTER BI_CAPACITY',
+    // - truncate:
+    'TRUNCATE TABLE',
+    // - create schema
+    'CREATE SCHEMA [IF NOT EXISTS]',
+    'DEFAULT COLLATE',
+    // stored procedures
+    'CREATE [OR REPLACE] [TEMP|TEMPORARY|TABLE] FUNCTION [IF NOT EXISTS]',
+    'CREATE [OR REPLACE] PROCEDURE [IF NOT EXISTS]',
+    // row access policy
+    'CREATE [OR REPLACE] ROW ACCESS POLICY [IF NOT EXISTS]',
+    'GRANT TO',
+    'FILTER USING',
+    // capacity
+    'CREATE CAPACITY',
+    'AS JSON',
+    // reservation
+    'CREATE RESERVATION',
+    // assignment
+    'CREATE ASSIGNMENT',
+    // search index
+    'CREATE SEARCH INDEX [IF NOT EXISTS]',
+    // drop
+    'DROP SCHEMA [IF EXISTS]',
+    'DROP [MATERIALIZED] VIEW [IF EXISTS]',
+    'DROP [TABLE] FUNCTION [IF EXISTS]',
+    'DROP PROCEDURE [IF EXISTS]',
+    'DROP ROW ACCESS POLICY',
+    'DROP ALL ROW ACCESS POLICIES',
+    'DROP CAPACITY [IF EXISTS]',
+    'DROP RESERVATION [IF EXISTS]',
+    'DROP ASSIGNMENT [IF EXISTS]',
+    'DROP SEARCH INDEX [IF EXISTS]',
+    'DROP [IF EXISTS]',
+    // DCL, https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language
+    'GRANT',
+    'REVOKE',
+    // Script, https://cloud.google.com/bigquery/docs/reference/standard-sql/scripting
+    'DECLARE',
+    'EXECUTE IMMEDIATE',
+    'LOOP',
+    'END LOOP',
+    'REPEAT',
+    'END REPEAT',
+    'WHILE',
+    'END WHILE',
+    'BREAK',
+    'LEAVE',
+    'CONTINUE',
+    'ITERATE',
+    'FOR',
+    'END FOR',
+    'BEGIN',
+    'BEGIN TRANSACTION',
+    'COMMIT TRANSACTION',
+    'ROLLBACK TRANSACTION',
+    'RAISE',
+    'RETURN',
+    'CALL',
+    // Debug, https://cloud.google.com/bigquery/docs/reference/standard-sql/debugging-statements
+    'ASSERT',
+    // Other, https://cloud.google.com/bigquery/docs/reference/standard-sql/other-statements
+    'EXPORT DATA',
+]);
+const reservedSetOperations = expandPhrases([
+    'UNION {ALL | DISTINCT}',
+    'EXCEPT DISTINCT',
+    'INTERSECT DISTINCT',
+]);
+const reservedJoins = expandPhrases([
+    'JOIN',
+    '{LEFT | RIGHT | FULL} [OUTER] JOIN',
+    '{INNER | CROSS} JOIN',
+]);
+const reservedKeywordPhrases = expandPhrases([
+    // https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#tablesample_operator
+    'TABLESAMPLE SYSTEM',
+    // From DDL: https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language
+    'ANY TYPE',
+    'ALL COLUMNS',
+    'NOT DETERMINISTIC',
+    // inside window definitions
+    '{ROWS | RANGE} BETWEEN',
+    // comparison operator
+    'IS [NOT] DISTINCT FROM',
+]);
+const reservedDataTypePhrases = expandPhrases([]);
+// https://cloud.google.com/bigquery/docs/reference/#standard-sql-reference
+export const bigquery = {
+    name: 'bigquery',
+    tokenizerOptions: {
+        reservedSelect,
+        reservedClauses: [...reservedClauses, ...tabularOnelineClauses, ...standardOnelineClauses],
+        reservedSetOperations,
+        reservedJoins,
+        reservedKeywordPhrases,
+        reservedDataTypePhrases,
+        reservedKeywords: keywords,
+        reservedDataTypes: dataTypes,
+        reservedFunctionNames: functions,
+        extraParens: ['[]'],
+        stringTypes: [
+            // The triple-quoted strings are listed first, so they get matched first.
+            // Otherwise the first two quotes of """ will get matched as an empty "" string.
+            { quote: '""".."""', prefixes: ['R', 'B', 'RB', 'BR'] },
+            { quote: "'''..'''", prefixes: ['R', 'B', 'RB', 'BR'] },
+            '""-bs',
+            "''-bs",
+            { quote: '""-raw', prefixes: ['R', 'B', 'RB', 'BR'], requirePrefix: true },
+            { quote: "''-raw", prefixes: ['R', 'B', 'RB', 'BR'], requirePrefix: true },
+        ],
+        identTypes: ['``'],
+        identChars: { dashes: true },
+        paramTypes: { positional: true, named: ['@'], quoted: ['@'] },
+        variableTypes: [{ regex: String.raw `@@\w+` }],
+        lineCommentTypes: ['--', '#'],
+        operators: ['&', '|', '^', '~', '>>', '<<', '||', '=>'],
+        postProcess,
+    },
+    formatOptions: {
+        onelineClauses: [...standardOnelineClauses, ...tabularOnelineClauses],
+        tabularOnelineClauses,
+    },
+};
+function postProcess(tokens) {
+    return detectArraySubscripts(combineParameterizedTypes(tokens));
+}
+// Converts OFFSET token inside array from RESERVED_CLAUSE to RESERVED_FUNCTION_NAME
+// See: https://cloud.google.com/bigquery/docs/reference/standard-sql/functions-and-operators#array_subscript_operator
+function detectArraySubscripts(tokens) {
+    let prevToken = EOF_TOKEN;
+    return tokens.map(token => {
+        if (token.text === 'OFFSET' && prevToken.text === '[') {
+            prevToken = token;
+            return Object.assign(Object.assign({}, token), { type: TokenType.RESERVED_FUNCTION_NAME });
+        }
+        else {
+            prevToken = token;
+            return token;
+        }
+    });
+}
+// Combines multiple tokens forming a parameterized type like STRUCT<ARRAY<INT64>> into a single token
+function combineParameterizedTypes(tokens) {
+    var _a;
+    const processed = [];
+    for (let i = 0; i < tokens.length; i++) {
+        const token = tokens[i];
+        if ((isToken.ARRAY(token) || isToken.STRUCT(token)) && ((_a = tokens[i + 1]) === null || _a === void 0 ? void 0 : _a.text) === '<') {
+            const endIndex = findClosingAngleBracketIndex(tokens, i + 1);
+            const typeDefTokens = tokens.slice(i, endIndex + 1);
+            processed.push({
+                type: TokenType.IDENTIFIER,
+                raw: typeDefTokens.map(formatTypeDefToken('raw')).join(''),
+                text: typeDefTokens.map(formatTypeDefToken('text')).join(''),
+                start: token.start,
+            });
+            i = endIndex;
+        }
+        else {
+            processed.push(token);
+        }
+    }
+    return processed;
+}
+const formatTypeDefToken = (key) => (token) => {
+    if (token.type === TokenType.IDENTIFIER || token.type === TokenType.COMMA) {
+        return token[key] + ' ';
+    }
+    else {
+        return token[key];
+    }
+};
+function findClosingAngleBracketIndex(tokens, startIndex) {
+    let level = 0;
+    for (let i = startIndex; i < tokens.length; i++) {
+        const token = tokens[i];
+        if (token.text === '<') {
+            level++;
+        }
+        else if (token.text === '>') {
+            level--;
+        }
+        else if (token.text === '>>') {
+            level -= 2;
+        }
+        if (level === 0) {
+            return i;
+        }
+    }
+    return tokens.length - 1;
+}
+//# sourceMappingURL=bigquery.formatter.js.map

package/dist/esm/languages/bigquery/bigquery.formatter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bigquery.formatter.js","sourceRoot":"","sources":["../../../../src/languages/bigquery/bigquery.formatter.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAAO,EAAE,SAAS,EAAE,OAAO,EAAS,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAC5E,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACpD,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAE7D,MAAM,cAAc,GAAG,aAAa,CAAC,CAAC,gDAAgD,CAAC,CAAC,CAAC;AAEzF,MAAM,eAAe,GAAG,aAAa,CAAC;IACpC,sFAAsF;IACtF,kBAAkB;IAClB,MAAM;IACN,OAAO;IACP,UAAU;IACV,QAAQ;IACR,SAAS;IACT,QAAQ;IACR,cAAc;IACd,UAAU;IACV,OAAO;IACP,QAAQ;IACR,gBAAgB;IAChB,8FAA8F;IAC9F,YAAY;IACZ,eAAe;IACf,QAAQ;IACR,YAAY;IACZ,KAAK;IACL,WAAW;IACX,cAAc;IACd,mDAAmD;IACnD,YAAY;IAEZ,YAAY;IACZ,uBAAuB;IACvB,iBAAiB;IACjB,wBAAwB;IACxB,wBAAwB;CACzB,CAAC,CAAC;AAEH,MAAM,sBAAsB,GAAG,aAAa,CAAC;IAC3C,8EAA8E;CAC/E,CAAC,CAAC;AAEH,MAAM,qBAAqB,GAAG,aAAa,CAAC;IAC1C,YAAY;IACZ,yFAAyF;IACzF,yDAAyD;IACzD,YAAY;IACZ,QAAQ;IACR,YAAY;IACZ,eAAe;IACf,gBAAgB;IAChB,8CAA8C;IAC9C,iBAAiB;IACjB,yBAAyB;IACzB,4BAA4B;IAC5B,yBAAyB;IACzB,WAAW;IACX,0BAA0B;IAC1B,qBAAqB;IACrB,aAAa;IACb,eAAe;IACf,eAAe;IACf,iBAAiB;IACjB,0BAA0B;IAC1B,eAAe;IACf,uCAAuC;IACvC,sBAAsB;IACtB,mBAAmB;IACnB,cAAc;IACd,gBAAgB;IAChB,kBAAkB;IAClB,+BAA+B;IAC/B,iBAAiB;IAEjB,oBAAoB;IACpB,qEAAqE;IACrE,+CAA+C;IAC/C,oBAAoB;IACpB,uDAAuD;IACvD,UAAU;IACV,cAAc;IACd,WAAW;IACX,iBAAiB;IACjB,SAAS;IACT,cAAc;IACd,oBAAoB;IACpB,aAAa;IACb,mBAAmB;IACnB,eAAe;IACf,qCAAqC;IACrC,OAAO;IACP,yBAAyB;IACzB,sCAAsC;IACtC,mCAAmC;IACnC,4BAA4B;IAC5B,wBAAwB;IACxB,8BAA8B;IAC9B,2BAA2B;IAC3B,8BAA8B;IAC9B,6BAA6B;IAC7B,+BAA+B;IAC/B,kBAAkB;IAClB,2FAA2F;IAC3F,OAAO;IACP,QAAQ;IACR,kFAAkF;IAClF,SAAS;IACT,mBAAmB;IACnB,MAAM;IACN,UAAU;IACV,QAAQ;IACR,YAAY;IACZ,OAAO;IACP,WAAW;IACX,OAAO;IACP,OAAO;IACP,UAAU;IACV,SAAS;IACT,KAAK;IACL,SAAS;IACT,OAAO;IACP,mBAAmB;IACnB,oBAAoB;IACpB,sBAAsB;IACtB,OAAO;IACP,QAAQ;IACR,MAAM;IACN,4FAA4F;IAC5F,QAAQ;IACR,wFAAwF;IACxF,aAAa;CACd,CAAC,CAAC;AAEH,MAAM,qBAAqB,GAAG,aAAa,CAAC;IAC1C,wBAAwB;IACxB,iBAAiB;IACjB,oBAAoB;CACrB,CAAC,CAAC;AAEH,MAAM,aAAa,GAAG,aAAa,CAAC;IAClC,MAAM;IACN,oCAAoC;IACpC,sBAAsB;CACvB,CAAC,CAAC;AAEH,MAAM,sBAAsB,GAAG,aAAa,CAAC;IAC3C,kGAAkG;IAClG,oBAAoB;IACpB,mGAAmG;IACnG,UAAU;IACV,aAAa;IACb,mBAAmB;IACnB,4BAA4B;IAC5B,wBAAwB;IACxB,sBAAsB;IACtB,wBAAwB;CACzB,CAAC,CAAC;AAEH,MAAM,uBAAuB,GAAG,aAAa,CAAC,EAAE,CAAC,CAAC;AAElD,2EAA2E;AAC3E,MAAM,CAAC,MAAM,QAAQ,GAAmB;IACtC,IAAI,EAAE,UAAU;IAChB,gBAAgB,EAAE;QAChB,cAAc;QACd,eAAe,EAAE,CAAC,GAAG,eAAe,EAAE,GAAG,qBAAqB,EAAE,GAAG,sBAAsB,CAAC;QAC1F,qBAAqB;QACrB,aAAa;QACb,sBAAsB;QACtB,uBAAuB;QACvB,gBAAgB,EAAE,QAAQ;QAC1B,iBAAiB,EAAE,SAAS;QAC5B,qBAAqB,EAAE,SAAS;QAChC,WAAW,EAAE,CAAC,IAAI,CAAC;QACnB,WAAW,EAAE;YACX,yEAAyE;YACzE,gFAAgF;YAChF,EAAE,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE;YACvD,EAAE,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE;YACvD,OAAO;YACP,OAAO;YACP,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE;YAC1E,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE;SAC3E;QACD,UAAU,EAAE,CAAC,IAAI,CAAC;QAClB,UAAU,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE;QAC5B,UAAU,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,EAAE,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE;QAC7D,aAAa,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,GAAG,CAAA,OAAO,EAAE,CAAC;QAC7C,gBAAgB,EAAE,CAAC,IAAI,EAAE,GAAG,CAAC;QAC7B,SAAS,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC;QACvD,WAAW;KACZ;IACD,aAAa,EAAE;QACb,cAAc,EAAE,CAAC,GAAG,sBAAsB,EAAE,GAAG,qBAAqB,CAAC;QACrE,qBAAqB;KACtB;CACF,CAAC;AAEF,SAAS,WAAW,CAAC,MAAe;IAClC,OAAO,qBAAqB,CAAC,yBAAyB,CAAC,MAAM,CAAC,CAAC,CAAC;AAClE,CAAC;AAED,oFAAoF;AACpF,sHAAsH;AACtH,SAAS,qBAAqB,CAAC,MAAe;IAC5C,IAAI,SAAS,GAAG,SAAS,CAAC;IAC1B,OAAO,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE;QACxB,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,IAAI,SAAS,CAAC,IAAI,KAAK,GAAG,EAAE;YACrD,SAAS,GAAG,KAAK,CAAC;YAClB,uCAAY,KAAK,KAAE,IAAI,EAAE,SAAS,CAAC,sBAAsB,IAAG;SAC7D;aAAM;YACL,SAAS,GAAG,KAAK,CAAC;YAClB,OAAO,KAAK,CAAC;SACd;IACH,CAAC,CAAC,CAAC;AACL,CAAC;AAED,sGAAsG;AACtG,SAAS,yBAAyB,CAAC,MAAe;;IAChD,MAAM,SAAS,GAAY,EAAE,CAAC;IAC9B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;QACtC,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;QAExB,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAA,MAAA,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,0CAAE,IAAI,MAAK,GAAG,EAAE;YAClF,MAAM,QAAQ,GAAG,4BAA4B,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;YAC7D,MAAM,aAAa,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,QAAQ,GAAG,CAAC,CAAC,CAAC;YACpD,SAAS,CAAC,IAAI,CAAC;gBACb,IAAI,EAAE,SAAS,CAAC,UAAU;gBAC1B,GAAG,EAAE,aAAa,CAAC,GAAG,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC1D,IAAI,EAAE,aAAa,CAAC,GAAG,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC5D,KAAK,EAAE,KAAK,CAAC,KAAK;aACnB,CAAC,CAAC;YACH,CAAC,GAAG,QAAQ,CAAC;SACd;aAAM;YACL,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;SACvB;KACF;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,MAAM,kBAAkB,GACtB,CAAC,GAAyC,EAAE,EAAE,CAC9C,CAAC,KAAY,EAAU,EAAE;IACvB,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,UAAU,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,KAAK,EAAE;QACzE,OAAO,KAAK,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;KACzB;SAAM;QACL,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC;KACnB;AACH,CAAC,CAAC;AAEJ,SAAS,4BAA4B,CAAC,MAAe,EAAE,UAAkB;IACvE,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,KAAK,IAAI,CAAC,GAAG,UAAU,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;QAC/C,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;QACxB,IAAI,KAAK,CAAC,IAAI,KAAK,GAAG,EAAE;YACtB,KAAK,EAAE,CAAC;SACT;aAAM,IAAI,KAAK,CAAC,IAAI,KAAK,GAAG,EAAE;YAC7B,KAAK,EAAE,CAAC;SACT;aAAM,IAAI,KAAK,CAAC,IAAI,KAAK,IAAI,EAAE;YAC9B,KAAK,IAAI,CAAC,CAAC;SACZ;QACD,IAAI,KAAK,KAAK,CAAC,EAAE;YACf,OAAO,CAAC,CAAC;SACV;KACF;IACD,OAAO,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC;AAC3B,CAAC"}

package/dist/esm/languages/bigquery/bigquery.functions.d.ts

@@ -0,0 +1 @@
+export declare const functions: string[];