https://github.com/fuseraft/tsql_parser
A very light-weight and opinionated T-SQL parser and formatter.
https://github.com/fuseraft/tsql_parser
Last synced: 6 months ago
JSON representation
A very light-weight and opinionated T-SQL parser and formatter.
- Host: GitHub
- URL: https://github.com/fuseraft/tsql_parser
- Owner: fuseraft
- Created: 2023-03-27T15:36:15.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-04-03T22:07:29.000Z (almost 3 years ago)
- Last Synced: 2025-07-04T05:17:01.851Z (6 months ago)
- Language: Ruby
- Size: 65.4 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# TSqlParser
A very light-weight and opinionated T-SQL parser and formatter.
The **`tsql_parser`** library can be used to format gnarly/headache-inducing T-SQL stored procedure code (> 1000 LoC) into easy to understand T-SQL.
It can also be used to tokenize a T-SQL string and produce a hash array containing metadata about each token in the T-SQL string.
The parser implementation rolls its own lexical analysis and tokenization instead of leaning on generators like Lex, YACC, or Bison.
Contributions welcome! Please submit any issues you discover and if you want to fix something, please fork and submit a pull request!
### Installation
#### Terminal
```bash
$ gem install tsql_parser
```
#### Gemfile
```ruby
source "https://rubygems.org"
gem "tsql_parser", "~> 0.1.8"
```
#### Example Usage
Here is an example of printing formatted T-SQL to the terminal.
```ruby
require "tsql_parser"
file = File.expand_path("~/path/to/tsql_script.sql")
tsql = File.read(file)
puts TSqlParser.format(tsql)
```
### TSqlParser Methods
This is the facade for working with the library.
**`TSqlParser#parse(sql) → hash_array`**
- Parses a T-SQL string and returns a hash array containing metadata about the tokens.
**`TSqlParser#format(sql, tab_count = 0, tab = " ") → formatted_sql_string`**
- Parses and formats a T-SQL string.
- The default tab count is `0`.
- The default tab string is four white-space characters.
### TSqlParser::Parsing::Tokenizer Methods
**`Tokenizer#tokenize(tsql_string) → hash_array`**
- Tokenizes a T-SQL string into a hash array of tokens.
### Configuration
I'm still building out the configurability of the tokenization, parsing, and formatter.
**`Defaults#set_default_tab_count(tab_count = 0)`**
- Sets the default tab count to use during formatting.
**`Defaults#set_default_tab(tab = " ")`**
- Sets the default tab string to use during formatting.
**`Defaults#set_default_single_char_tokens(delim_array=[])`**
- Sets the list of recognized character tokens.
```ruby
# Example
TSqlParser::Parsing::Defaults.set_default_single_char_tokens ["(", ",", ")", "=", "+", "-", "%", "/", "*", "<", "!", ">", "'", "[", "]", ";"]
```
**`Defaults#set_default_delimiters(delim_array=[])`**
* Sets the list of token-separators.
```ruby
# Example
TSqlParser::Parsing::Defaults.set_default_delimiters [" ", "\n", "\t"]
```
## Contributions
I would love contributions from the open-source community.
Here is a link to the [Quickstart on Contributing to Projects](https://docs.github.com/en/get-started/quickstart/contributing-to-projects)