# antlr4-javascript-sql

**Repository Path**: xulx_code/antlr4-javascript-sql

## Basic Information

- **Project Name**: antlr4-javascript-sql
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-02-22
- **Last Updated**: 2024-07-05

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

antlr4-javascript-sql
=====================

An UMD module wrapping ANTLR generated parser, lexer, listener and visitor for SQL databases,
based on the antlr4-javascript-sparql module by Szymon Danielczyk.

### Info 

Parser classes where generated from G4 grammar files using the ANTLR runtime, version 4.5.1.

The SQL grammar file is Copyright (c) 2014 by Bart Kiers, released under the MIT License; it can be downloaded from the antlr/grammars-v4 repository.

Classes have been generated with the following commands:

```
java -Xmx500M -cp "antlr-4.5.1-complete.jar:$CLASSPATH" org.antlr.v4.Tool -Dlanguage=JavaScript grammars/sql/SQL.g4 -o lib
```

Then a the following modifications have been made to generated classes:

  * each class has been wrapped in a function for dependency injection
  * in `SQLLexer`, `atn` and `decisionToFDA` have been moved inside the constructor
  * in `SQLParser` `atn`, `decisionToFDA`, `sharedContextCache` have been moved inside the constructor; `atn` has been bound to `this` and the `Object.defineProperty` has been commented out

### Usage


To build UMD module type:    
 
```    
npm install -g browserify
"preinstall": "browserify  --ignore-missing main.js -o release/antlr4-sql.js",
```

To use with webpack define following shim antlr4-sql.js 

```
var antlr4 = require('antlr4-base');
var SQLLexer = require('node_modules/antlr4-javascript-sql/lib/SQLLexer.js');
var SQLParser = require('node_modules/antlr4-javascript-sql/lib/SQLParser.js');
var SQLListener = require('node_modules/antlr4-javascript-sql/lib/SQLListener');
var SQLVisitor = require('node_modules/antlr4-javascript-sql/lib/SQLVisitor');

var listener = SQLListener(antlr4);
var visitor = SQLVisitor(antlr4);

module.exports = {
  SQLLexer: SQLLexer(antlr4),
  SQLParser: SQLParser(antlr4, listener, visitor),
  SQLListener: listener,
  SQLVisitor: visitor
};
``` 

### Test 

```
npm install 
npm test
```