sql-formatter
Version:
Format whitespace in a SQL query to make it more readable
281 lines • 6.8 kB
JavaScript
import { expandPhrases } from '../../expandPhrases.js';
import { postProcess } from '../mariadb/likeMariaDb.js';
import { dataTypes, keywords } from './singlestoredb.keywords.js';
import { functions } from './singlestoredb.functions.js';
const reservedSelect = expandPhrases(['SELECT [ALL | DISTINCT | DISTINCTROW]']);
const reservedClauses = expandPhrases([
// queries
'WITH',
'FROM',
'WHERE',
'GROUP BY',
'HAVING',
'PARTITION BY',
'ORDER BY',
'LIMIT',
'OFFSET',
// Data manipulation
// - insert:
'INSERT [IGNORE] [INTO]',
'VALUES',
'REPLACE [INTO]',
'ON DUPLICATE KEY UPDATE',
// - update:
'SET',
// Data definition
'CREATE [OR REPLACE] [TEMPORARY] PROCEDURE [IF NOT EXISTS]',
'CREATE [OR REPLACE] [EXTERNAL] FUNCTION',
]);
const standardOnelineClauses = expandPhrases([
'CREATE [ROWSTORE] [REFERENCE | TEMPORARY | GLOBAL TEMPORARY] TABLE [IF NOT EXISTS]',
]);
const tabularOnelineClauses = expandPhrases([
// - create:
'CREATE VIEW',
// - update:
'UPDATE',
// - delete:
'DELETE [FROM]',
// - drop table:
'DROP [TEMPORARY] TABLE [IF EXISTS]',
// - alter table:
'ALTER [ONLINE] TABLE',
'ADD [COLUMN]',
'ADD [UNIQUE] {INDEX | KEY}',
'DROP [COLUMN]',
'MODIFY [COLUMN]',
'CHANGE',
'RENAME [TO | AS]',
// - truncate:
'TRUNCATE [TABLE]',
// https://docs.singlestore.com/managed-service/en/reference/sql-reference.html
'ADD AGGREGATOR',
'ADD LEAF',
'AGGREGATOR SET AS MASTER',
'ALTER DATABASE',
'ALTER PIPELINE',
'ALTER RESOURCE POOL',
'ALTER USER',
'ALTER VIEW',
'ANALYZE TABLE',
'ATTACH DATABASE',
'ATTACH LEAF',
'ATTACH LEAF ALL',
'BACKUP DATABASE',
'BINLOG',
'BOOTSTRAP AGGREGATOR',
'CACHE INDEX',
'CALL',
'CHANGE',
'CHANGE MASTER TO',
'CHANGE REPLICATION FILTER',
'CHANGE REPLICATION SOURCE TO',
'CHECK BLOB CHECKSUM',
'CHECK TABLE',
'CHECKSUM TABLE',
'CLEAR ORPHAN DATABASES',
'CLONE',
'COMMIT',
'CREATE DATABASE',
'CREATE GROUP',
'CREATE INDEX',
'CREATE LINK',
'CREATE MILESTONE',
'CREATE PIPELINE',
'CREATE RESOURCE POOL',
'CREATE ROLE',
'CREATE USER',
'DEALLOCATE PREPARE',
'DESCRIBE',
'DETACH DATABASE',
'DETACH PIPELINE',
'DROP DATABASE',
'DROP FUNCTION',
'DROP INDEX',
'DROP LINK',
'DROP PIPELINE',
'DROP PROCEDURE',
'DROP RESOURCE POOL',
'DROP ROLE',
'DROP USER',
'DROP VIEW',
'EXECUTE',
'EXPLAIN',
'FLUSH',
'FORCE',
'GRANT',
'HANDLER',
'HELP',
'KILL CONNECTION',
'KILLALL QUERIES',
'LOAD DATA',
'LOAD INDEX INTO CACHE',
'LOAD XML',
'LOCK INSTANCE FOR BACKUP',
'LOCK TABLES',
'MASTER_POS_WAIT',
'OPTIMIZE TABLE',
'PREPARE',
'PURGE BINARY LOGS',
'REBALANCE PARTITIONS',
'RELEASE SAVEPOINT',
'REMOVE AGGREGATOR',
'REMOVE LEAF',
'REPAIR TABLE',
'REPLACE',
'REPLICATE DATABASE',
'RESET',
'RESET MASTER',
'RESET PERSIST',
'RESET REPLICA',
'RESET SLAVE',
'RESTART',
'RESTORE DATABASE',
'RESTORE REDUNDANCY',
'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 CHARACTER SET',
'SHOW COLLATION',
'SHOW COLUMNS',
'SHOW CREATE DATABASE',
'SHOW CREATE FUNCTION',
'SHOW CREATE PIPELINE',
'SHOW CREATE PROCEDURE',
'SHOW CREATE TABLE',
'SHOW CREATE USER',
'SHOW CREATE VIEW',
'SHOW DATABASES',
'SHOW ENGINE',
'SHOW ENGINES',
'SHOW ERRORS',
'SHOW FUNCTION CODE',
'SHOW FUNCTION STATUS',
'SHOW GRANTS',
'SHOW INDEX',
'SHOW MASTER STATUS',
'SHOW OPEN TABLES',
'SHOW PLUGINS',
'SHOW PRIVILEGES',
'SHOW PROCEDURE CODE',
'SHOW PROCEDURE STATUS',
'SHOW PROCESSLIST',
'SHOW PROFILE',
'SHOW PROFILES',
'SHOW RELAYLOG EVENTS',
'SHOW REPLICA STATUS',
'SHOW REPLICAS',
'SHOW SLAVE',
'SHOW SLAVE HOSTS',
'SHOW STATUS',
'SHOW TABLE STATUS',
'SHOW TABLES',
'SHOW VARIABLES',
'SHOW WARNINGS',
'SHUTDOWN',
'SNAPSHOT DATABASE',
'SOURCE_POS_WAIT',
'START GROUP_REPLICATION',
'START PIPELINE',
'START REPLICA',
'START SLAVE',
'START TRANSACTION',
'STOP GROUP_REPLICATION',
'STOP PIPELINE',
'STOP REPLICA',
'STOP REPLICATING',
'STOP SLAVE',
'TEST PIPELINE',
'UNLOCK INSTANCE',
'UNLOCK TABLES',
'USE',
'XA',
// flow control
'ITERATE',
'LEAVE',
'LOOP',
'REPEAT',
'RETURN',
'WHILE',
]);
const reservedSetOperations = expandPhrases([
'UNION [ALL | DISTINCT]',
'EXCEPT',
'INTERSECT',
'MINUS',
]);
const reservedJoins = expandPhrases([
'JOIN',
'{LEFT | RIGHT | FULL} [OUTER] JOIN',
'{INNER | CROSS} JOIN',
'NATURAL {LEFT | RIGHT} [OUTER] JOIN',
// non-standard joins
'STRAIGHT_JOIN',
]);
const reservedPhrases = expandPhrases([
'ON DELETE',
'ON UPDATE',
'CHARACTER SET',
'{ROWS | RANGE} BETWEEN',
'IDENTIFIED BY',
]);
export const singlestoredb = {
name: 'singlestoredb',
tokenizerOptions: {
reservedSelect,
reservedClauses: [...reservedClauses, ...standardOnelineClauses, ...tabularOnelineClauses],
reservedSetOperations,
reservedJoins,
reservedPhrases,
reservedKeywords: keywords,
reservedDataTypes: dataTypes,
reservedFunctionNames: functions,
// TODO: support _binary"some string" prefix
stringTypes: [
'""-qq-bs',
"''-qq-bs",
{ quote: "''-raw", prefixes: ['B', 'X'], requirePrefix: true },
],
identTypes: ['``'],
identChars: { first: '$', rest: '$', allowFirstCharNumber: true },
variableTypes: [
{ regex: '@@?[A-Za-z0-9_$]+' },
{ quote: '``', prefixes: ['@'], requirePrefix: true },
],
lineCommentTypes: ['--', '#'],
operators: [
':=',
'&',
'|',
'^',
'~',
'<<',
'>>',
'<=>',
'&&',
'||',
'::',
'::$',
'::%',
':>',
'!:>',
'*.*', // Not actually an operator
],
postProcess,
},
formatOptions: {
alwaysDenseOperators: ['::', '::$', '::%'],
onelineClauses: [...standardOnelineClauses, ...tabularOnelineClauses],
tabularOnelineClauses,
},
};
//# sourceMappingURL=singlestoredb.formatter.js.map