https://github.com/hackolade/sql-select-statement-parser
Returns object describing columns and tables names used in SQL SELECT query
https://github.com/hackolade/sql-select-statement-parser
parser sql
Last synced: 9 months ago
JSON representation
Returns object describing columns and tables names used in SQL SELECT query
- Host: GitHub
- URL: https://github.com/hackolade/sql-select-statement-parser
- Owner: hackolade
- License: mit
- Created: 2022-03-17T13:38:00.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2025-02-18T08:37:36.000Z (12 months ago)
- Last Synced: 2025-03-30T16:46:27.571Z (10 months ago)
- Topics: parser, sql
- Language: JavaScript
- Homepage:
- Size: 1.87 MB
- Stars: 5
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SELECT statement SQL parser
Dialect-agnostic parser of SQL SELECT statements.
Function parseSelectStatement accepts SQL SELECT statement of different SQL dialects (MySQL, Oracle, PostgreSQL, T-SQL, Snowflake, etc.) and returns object describing columns and tables names used in the query.
## Installation
```
npm install @hackolade/sql-select-statement-parser
```
## Usage
```javascript
const result = parseSelectStatement(`
SELECT "database".'schema'.table.[column] AS columnAlias
FROM database.schema.table AS tableAlias;
`);
```
## Result structure
```javascript
{
selectItems: [{ // array of selected columns and expressions
name: "column", // column name or *
tableName: "table", // table name
schemaName: "schema", // schema name (or database name for some dialects)
databaseName: "database", // database name (if schema also exists in the dialect)
originalName: "[column]", // original column name including quotes
// (or square brackets for T-SQL)
alias: "columnAlias", // column alias
fieldReferences: ["column"], // List of column names used in expression.
// Appears only when selected item is
// described by expression.
}],
from: [{ // array of tables described in a FROM clause
table: "table", // table name
schemaName: "schema", // schema name (or database name for some dialects)
databaseName: "database", // database name (if schema also exists in the dialect)
alias: "tableAlias", // table alias
originalName: "`table`", // original table name including quotes
//(or square brackets for T-SQL)
}]
}
```
## License
[MIT](LICENSE)