Skip to content

Commit

Permalink
version 1.0 cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
wlmcewen committed Feb 11, 2016
1 parent 6da2269 commit 803df9b
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 10 deletions.
5 changes: 3 additions & 2 deletions CHANGELOG.md
@@ -1,6 +1,7 @@
v0.4.0, 2015-04-14 ([changes](https://github.com/sparkapi/sparkql/compare/v0.3.20...v0.4.0))
v1.0.0, 2016-02-11 ([changes](https://github.com/sparkapi/sparkql/compare/v0.3.20...v1.0.0))
-------------------

* [IMPROVEMENT] function support for fields (delayed resolution). Backing systems must
implement necessary function behaviour.
* Drop support for ruby 1.8.7. Georuby dropped support several years back and
this drop allows us to pick up newer update allows us to stay in sync with
that gems development
Expand Down
16 changes: 9 additions & 7 deletions README.md
@@ -1,6 +1,6 @@
SparkQL query language parser
=====================
This gem contains the syntax parser for processing spark api filter queries into manageable
This gem contains the syntax parser for processing spark api filter queries into manageable
expressions. To get an overview of the language syntax-wise, refer to the following files:

* lib/sparkql/parser.y # BNF Grammar
Expand All @@ -12,14 +12,16 @@ Installation
Add the gem to your gemfile:

Gemfile
gem 'sparkql', '~> 0.0.1'
gem 'sparkql', '~> 0.0.1'

When completed, run 'bundle install'.


Usage
-------------
See test/unit/parser_test.rb for generic parsing examples. In most cases an extended parser is
Ruby 1.9 or greater is required.

See test/unit/parser_test.rb for generic parsing examples. In most cases an extended parser is
needed to do anything of significance, such as the postgres and db2 search implementations in the
API.

Expand All @@ -40,12 +42,12 @@ The return value will be an array with one expression element containing the que

Development
-------------
The parser is based on racc, a yacc like LR parser that is a part of the ruby runtime. The grammar
is located at lib/sparkql/parser.y and is compiled as part of the test process. Refer to the
Rakefile for details. When modifying the grammar, please checkin BOTH the parser.y and parser.rb
The parser is based on racc, a yacc like LR parser that is a part of the ruby runtime. The grammar
is located at lib/sparkql/parser.y and is compiled as part of the test process. Refer to the
Rakefile for details. When modifying the grammar, please checkin BOTH the parser.y and parser.rb
files.

Debugging grammar issues can be done by hand using the "racc" command. For example, a dump of the
Debugging grammar issues can be done by hand using the "racc" command. For example, a dump of the
parser states (and conflicts) can be generated via

racc -o lib/sparkql/parser.rb lib/sparkql/parser.y -v # see lib/sparkql/parser.output
Expand Down
2 changes: 1 addition & 1 deletion VERSION
@@ -1 +1 @@
0.3.24
1.0.0

0 comments on commit 803df9b

Please sign in to comment.