Skip to content

Update reserved words list, add more join support #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sgress454 wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update reserved words list, add more join support #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e4a23b8
update reserved words list, add alias rules
sgress454 Dec 2, 2025
61ab23f
reorder, update joins
sgress454 Dec 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
180 changes: 116 additions & 64 deletions pegjs/sqlite.pegjs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,102 +1,135 @@
{
const reservedMap = {
'ALTER': true,
'ALL': true,
'ADD': true,
'ALL': true,
'ALTER': true,
'AND': true,
'AS': true,
'ASC': true,

'AUTOINCREMENT': true,
'BETWEEN': true,
'BY': true,

'CALL': true,
'CASE': true,
'CHECK': true,
'COLLATE': true,
'COMMIT': true,
'CONSTRAINT': true,
'CREATE': true,
'CONTAINS': true,
'COUNT': true,
'CURRENT_DATE': true,
'CURRENT_TIME': true,
'CURRENT_TIMESTAMP': true,
'CURRENT_USER': true,

'DEFAULT': true,
'DEFERRABLE': true,
'DELETE': true,
'DESC': true,
'DISTINCT': true,
'DROP': true,

'ELSE': true,
'END': true,
'ESCAPE': true,
'EXCEPT': true,
'EXISTS': true,
'EXPLAIN': true,
'FOREIGN': true,
'FROM': true,
'GROUP': true,
'HAVING': true,
'IN': true,
'INDEX': true,
'INSERT': true,
'INTERSECT': true,
'INTO': true,
'IS': true,
'ISNULL': true,
'JOIN': true,
'LIMIT': true,
'NOT': true,
'NOTHING': true,
'NOTNULL': true,
'NULL': true,
'ON': true,
'OR': true,
'ORDER': true,
'PRIMARY': true,
'REFERENCES': true,
'RETURNING': true,
'SELECT': true,
'SET': true,
'TABLE': true,
'THEN': true,
'TO': true,
'TRANSACTION': true,
'UNION': true,
'UNIQUE': true,
'UPDATE': true,
'USING': true,
'VALUES': true,
'WHEN': true,
'WHERE': true,
};

'FALSE': true,
const invalidImplicitAliasMap = {
'ADD': true,
'ALL': true,
'ALTER': true,
'AND': true,
'AS': true,
'AUTOINCREMENT': true,
'BETWEEN': true,
'CASE': true,
'CHECK': true,
'COLLATE': true,
'COMMIT': true,
'CONSTRAINT': true,
'CREATE': true,
'CROSS': true,
'DEFAULT': true,
'DEFERRABLE': true,
'DELETE': true,
'DISTINCT': true,
'DROP': true,
'ELSE': true,
'ESCAPE': true,
'EXCEPT': true,
'EXISTS': true,
'FOREIGN': true,
'FROM': true,
'FULL': true,

'GENERATED': true,
'GLOB': true,
'GROUP': true,

'HAVING': true,

'IN': true,
'INDEX': true,
'INDEXED': true,
'INNER': true,
'INSERT': true,
'INTERSECT': true,
'INTO': true,
'IS': true,

'JOIN': true,
// 'JSON': true,

// 'KEY': true,

'LEFT': true,
'LIKE': true,
'LIMIT': true,
'LOW_PRIORITY': true, // for lock table

'MATCH': true,
'NATURAL': true,
'NOT': true,
'NOTHING': true,
'NULL': true,

'ON': true,
'OR': true,
'ORDER': true,
'OUTER': true,

'RECURSIVE': true,
'RENAME': true,
'READ': true, // for lock table
'PRIMARY': true,
'REFERENCES': true,
'REGEXP': true,
'RETURNING': true,
'RIGHT': true,

'SELECT': true,
'SESSION_USER': true,
'SET': true,
'SHOW': true,
'SYSTEM_USER': true,

'TABLE': true,
'THEN': true,
'TRUE': true,
'TRUNCATE': true,
// 'TYPE': true, // reserved (MySQL)

'TO': true,
'TRANSACTION': true,
'UNION': true,
'UNIQUE': true,
'UPDATE': true,
'USING': true,

'VALUES': true,

'WITH': true,
'WHEN': true,
'WHERE': true,
'WRITE': true, // for lock table

'GLOBAL': true,
'SESSION': true,
'LOCAL': true,
'PERSIST': true,
'PERSIST_ONLY': true,
};
}

function getLocationObject() {
return options.includeLocations ? {loc: location()} : {}
Expand Down Expand Up @@ -777,15 +810,15 @@ use_stmt
alter_table_stmt
= KW_ALTER __
KW_TABLE __
t:table_ref_list __
t:table_name __
e:alter_action_list {
if (t && t.length > 0) t.forEach(table => tableList.add(`alter::${table.db}::${table.table}`));
tableList.add(`alter::${t.db}::${t.table}`)
return {
tableList: Array.from(tableList),
columnList: columnListTableAlias(columnList),
ast: {
type: 'alter',
table: t,
table: [t],
expr: e
}
};
Expand Down Expand Up @@ -1514,8 +1547,8 @@ column_list_item
}

alias_clause
= KW_AS ___ i:alias_ident { return i; }
/ KW_AS? __ i:ident { return i; }
= KW_AS __ i:alias_ident_explicit { return i; }
/ i:alias_ident_implicit { return i; }

from_clause
= KW_FROM __ l:table_ref_list { return l; }
Expand Down Expand Up @@ -1648,8 +1681,11 @@ table_base
}

join_op
= KW_LEFT __ KW_OUTER? __ KW_JOIN { return 'LEFT JOIN'; }
/ (KW_INNER __)? KW_JOIN { return 'INNER JOIN'; }
= natural:(KW_NATURAL __)? KW_LEFT __ KW_OUTER? __ KW_JOIN { return natural ? 'NATURAL LEFT JOIN' : 'LEFT JOIN'; }
/ natural:(KW_NATURAL __)? KW_RIGHT __ KW_OUTER? __ KW_JOIN { return natural ? 'NATURAL RIGHT JOIN' : 'RIGHT JOIN'; }
/ natural:(KW_NATURAL __)? KW_FULL __ KW_OUTER? __ KW_JOIN { return natural ? 'NATURAL FULL JOIN' : 'FULL JOIN'; }
/ natural:(KW_NATURAL __)? (KW_INNER __)? KW_JOIN { return natural ? 'NATURAL INNER JOIN' : 'INNER JOIN'; }
/ KW_CROSS __ KW_JOIN { return 'CROSS JOIN'; }

table_name
= dt:ident tail:(__ DOT __ ident)? {
Expand Down Expand Up @@ -2332,16 +2368,28 @@ ident
return name;
}

alias_ident
alias_ident_explicit
= name:ident_name !{
if (reservedMap[name.toUpperCase()] === true) throw new Error("Error: "+ JSON.stringify(name)+" is a reserved word, can not as alias clause");
return false
} {
return name;
}
/ name:quoted_ident {
/ name:quoted_ident { return name; }

alias_ident_implicit
= name:ident_name !{
// reject reserved words
if (reservedMap[name.toUpperCase()] === true) return true;

// reject invalid implicit alias words
if (invalidImplicitAliasMap[name.toUpperCase()] === true) return true;

return false;
} {
return name;
}
/ name:quoted_ident { return name; }

quoted_ident_type
= double_quoted_ident / single_quoted_ident / backticks_quoted_ident
Expand Down Expand Up @@ -2772,7 +2820,11 @@ KW_COLLATE = "COLLATE"i !ident_start { return 'COLLATE'; }

KW_ON = "ON"i !ident_start
KW_LEFT = "LEFT"i !ident_start
KW_RIGHT = "RIGHT"i !ident_start
KW_CROSS = "CROSS"i !ident_start
KW_FULL = "FULL"i !ident_start
KW_INNER = "INNER"i !ident_start
KW_NATURAL = "NATURAL"i !ident_start
KW_JOIN = "JOIN"i !ident_start
KW_OUTER = "OUTER"i !ident_start
KW_OVER = "OVER"i !ident_start
Expand Down
43 changes: 43 additions & 0 deletions test/sqlite.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -300,4 +300,47 @@ describe('sqlite', () => {
expect(getParsedSql(sql)).to.be.equal(sql)
});
});
it('should allow column names that are keywords, but not reserved words, without quotes', () => {
const sql = `SELECT partition FROM some_table`
expect(getParsedSql(sql)).to.be.equal('SELECT "partition" FROM "some_table"')
})
it('should allow column names that are reserved words with quotes', () => {
const sql = `SELECT "from" FROM some_table`
expect(getParsedSql(sql)).to.be.equal('SELECT "from" FROM "some_table"')
})
it('should allow table names that are keywords, but not reserved words, without quotes', () => {
const sql = `CREATE TABLE partition (foo integer)`
expect(getParsedSql(sql)).to.be.equal('CREATE TABLE "partition" ("foo" INTEGER)')
})
it('should allow explict aliases that would be invalid as implicit aliases', () => {
const sql = `SELECT * FROM foo as left where left.bar=1`
expect(getParsedSql(sql)).to.be.equal('SELECT * FROM "foo" AS "left" WHERE "left"."bar" = 1')
})

describe('joins', () => {
const joinTypes = {
'LEFT JOIN': 'LEFT JOIN',
'LEFT OUTER JOIN': 'LEFT JOIN',
'RIGHT JOIN': 'RIGHT JOIN',
'RIGHT OUTER JOIN': 'RIGHT JOIN',
'FULL JOIN': 'FULL JOIN',
'FULL OUTER JOIN': 'FULL JOIN',
'INNER JOIN': 'INNER JOIN',
'NATURAL LEFT JOIN': 'NATURAL LEFT JOIN',
'NATURAL RIGHT JOIN': 'NATURAL RIGHT JOIN',
'NATURAL FULL JOIN': 'NATURAL FULL JOIN',
'NATURAL INNER JOIN': 'NATURAL INNER JOIN',
'NATURAL LEFT OUTER JOIN': 'NATURAL LEFT JOIN',
'NATURAL RIGHT OUTER JOIN': 'NATURAL RIGHT JOIN',
'NATURAL FULL OUTER JOIN': 'NATURAL FULL JOIN',
'CROSS JOIN': 'CROSS JOIN',
'JOIN': 'INNER JOIN',
}
Object.keys(joinTypes).forEach(joinType => {
it(`should support ${joinType}`, () => {
const sql = `SELECT * FROM table1 ${joinType} table2 ON table1.id = table2.t1_id`
expect(getParsedSql(sql)).to.be.equal(`SELECT * FROM "table1" ${joinTypes[joinType]} "table2" ON "table1"."id" = "table2"."t1_id"`)
})
})
})
})