sql-formatter
Version:
Format whitespace in a SQL query to make it more readable
216 lines • 6.59 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.tidb = void 0;
const expandPhrases_js_1 = require("../../expandPhrases.js");
const likeMariaDb_js_1 = require("../mariadb/likeMariaDb.js");
const tidb_keywords_js_1 = require("./tidb.keywords.js");
const tidb_functions_js_1 = require("./tidb.functions.js");
const reservedSelect = (0, expandPhrases_js_1.expandPhrases)(['SELECT [ALL | DISTINCT | DISTINCTROW]']);
const reservedClauses = (0, expandPhrases_js_1.expandPhrases)([
// queries
'WITH [RECURSIVE]',
'FROM',
'WHERE',
'GROUP BY',
'HAVING',
'WINDOW',
'PARTITION BY',
'ORDER BY',
'LIMIT',
'OFFSET',
// Data manipulation
// - insert:
'INSERT [LOW_PRIORITY | DELAYED | HIGH_PRIORITY] [IGNORE] [INTO]',
'REPLACE [LOW_PRIORITY | DELAYED] [INTO]',
'VALUES',
'ON DUPLICATE KEY UPDATE',
// - update:
'SET',
]);
const standardOnelineClauses = (0, expandPhrases_js_1.expandPhrases)(['CREATE [TEMPORARY] TABLE [IF NOT EXISTS]']);
const tabularOnelineClauses = (0, expandPhrases_js_1.expandPhrases)([
// https://docs.pingcap.com/tidb/stable/sql-statement-create-view
'CREATE [OR REPLACE] [SQL SECURITY DEFINER | SQL SECURITY INVOKER] VIEW [IF NOT EXISTS]',
// https://docs.pingcap.com/tidb/stable/sql-statement-update
'UPDATE [LOW_PRIORITY] [IGNORE]',
// https://docs.pingcap.com/tidb/stable/sql-statement-delete
'DELETE [LOW_PRIORITY] [QUICK] [IGNORE] FROM',
// https://docs.pingcap.com/tidb/stable/sql-statement-drop-table
'DROP [TEMPORARY] TABLE [IF EXISTS]',
// https://docs.pingcap.com/tidb/stable/sql-statement-alter-table
'ALTER TABLE',
'ADD [COLUMN]',
'{CHANGE | MODIFY} [COLUMN]',
'DROP [COLUMN]',
'RENAME [TO | AS]',
'RENAME COLUMN',
'ALTER [COLUMN]',
'{SET | DROP} DEFAULT',
// https://docs.pingcap.com/tidb/stable/sql-statement-truncate
'TRUNCATE [TABLE]',
// https://docs.pingcap.com/tidb/stable/sql-statement-alter-database
'ALTER DATABASE',
// https://docs.pingcap.com/tidb/stable/sql-statement-alter-instance
'ALTER INSTANCE',
'ALTER RESOURCE GROUP',
'ALTER SEQUENCE',
// https://docs.pingcap.com/tidb/stable/sql-statement-alter-user
'ALTER USER',
'ALTER VIEW',
'ANALYZE TABLE',
'CHECK TABLE',
'CHECKSUM TABLE',
'COMMIT',
'CREATE DATABASE',
'CREATE INDEX',
'CREATE RESOURCE GROUP',
'CREATE ROLE',
'CREATE SEQUENCE',
'CREATE USER',
'DEALLOCATE PREPARE',
'DESCRIBE',
'DROP DATABASE',
'DROP INDEX',
'DROP RESOURCE GROUP',
'DROP ROLE',
'DROP TABLESPACE',
'DROP USER',
'DROP VIEW',
'EXPLAIN',
'FLUSH',
// https://docs.pingcap.com/tidb/stable/sql-statement-grant-privileges
'GRANT',
'IMPORT TABLE',
'INSTALL COMPONENT',
'INSTALL PLUGIN',
'KILL',
'LOAD DATA',
'LOCK INSTANCE FOR BACKUP',
'LOCK TABLES',
'OPTIMIZE TABLE',
'PREPARE',
'RELEASE SAVEPOINT',
'RENAME TABLE',
'RENAME USER',
'REPAIR TABLE',
'RESET',
'REVOKE',
'ROLLBACK',
'ROLLBACK TO SAVEPOINT',
'SAVEPOINT',
'SET CHARACTER SET',
'SET DEFAULT ROLE',
'SET NAMES',
'SET PASSWORD',
'SET RESOURCE GROUP',
'SET ROLE',
'SET TRANSACTION',
'SHOW',
'SHOW BINARY LOGS',
'SHOW BINLOG EVENTS',
'SHOW CHARACTER SET',
'SHOW COLLATION',
'SHOW COLUMNS',
'SHOW CREATE DATABASE',
'SHOW CREATE TABLE',
'SHOW CREATE USER',
'SHOW CREATE VIEW',
'SHOW DATABASES',
'SHOW ENGINE',
'SHOW ENGINES',
'SHOW ERRORS',
'SHOW EVENTS',
'SHOW GRANTS',
'SHOW INDEX',
'SHOW MASTER STATUS',
'SHOW OPEN TABLES',
'SHOW PLUGINS',
'SHOW PRIVILEGES',
'SHOW PROCESSLIST',
'SHOW PROFILE',
'SHOW PROFILES',
'SHOW STATUS',
'SHOW TABLE STATUS',
'SHOW TABLES',
'SHOW TRIGGERS',
'SHOW VARIABLES',
'SHOW WARNINGS',
// https://docs.pingcap.com/tidb/stable/sql-statement-table
'TABLE',
'UNINSTALL COMPONENT',
'UNINSTALL PLUGIN',
'UNLOCK INSTANCE',
'UNLOCK TABLES',
// https://docs.pingcap.com/tidb/stable/sql-statement-use
'USE',
]);
const reservedSetOperations = (0, expandPhrases_js_1.expandPhrases)(['UNION [ALL | DISTINCT]']);
const reservedJoins = (0, expandPhrases_js_1.expandPhrases)([
'JOIN',
'{LEFT | RIGHT} [OUTER] JOIN',
'{INNER | CROSS} JOIN',
'NATURAL [INNER] JOIN',
'NATURAL {LEFT | RIGHT} [OUTER] JOIN',
// non-standard joins
'STRAIGHT_JOIN',
]);
const reservedPhrases = (0, expandPhrases_js_1.expandPhrases)([
'ON {UPDATE | DELETE} [SET NULL]',
'CHARACTER SET',
'{ROWS | RANGE} BETWEEN',
'IDENTIFIED BY',
]);
// https://docs.pingcap.com/tidb/stable/basic-features
exports.tidb = {
name: 'tidb',
tokenizerOptions: {
reservedSelect,
reservedClauses: [...reservedClauses, ...standardOnelineClauses, ...tabularOnelineClauses],
reservedSetOperations,
reservedJoins,
reservedPhrases,
supportsXor: true,
reservedKeywords: tidb_keywords_js_1.keywords,
reservedDataTypes: tidb_keywords_js_1.dataTypes,
reservedFunctionNames: tidb_functions_js_1.functions,
// TODO: support _ char set prefixes such as _utf8, _latin1, _binary, _utf8mb4, etc.
stringTypes: [
'""-qq-bs',
{ quote: "''-qq-bs", prefixes: ['N'] },
{ quote: "''-raw", prefixes: ['B', 'X'], requirePrefix: true },
],
identTypes: ['``'],
identChars: { first: '$', rest: '$', allowFirstCharNumber: true },
variableTypes: [
{ regex: '@@?[A-Za-z0-9_.$]+' },
{ quote: '""-qq-bs', prefixes: ['@'], requirePrefix: true },
{ quote: "''-qq-bs", prefixes: ['@'], requirePrefix: true },
{ quote: '``', prefixes: ['@'], requirePrefix: true },
],
paramTypes: { positional: true },
lineCommentTypes: ['--', '#'],
operators: [
'%',
':=',
'&',
'|',
'^',
'~',
'<<',
'>>',
'<=>',
'->',
'->>',
'&&',
'||',
'!',
'*.*', // Not actually an operator
],
postProcess: likeMariaDb_js_1.postProcess,
},
formatOptions: {
onelineClauses: [...standardOnelineClauses, ...tabularOnelineClauses],
tabularOnelineClauses,
},
};
//# sourceMappingURL=tidb.formatter.js.map