Skip to content

Latest commit

 

History

History
70 lines (46 loc) · 3.23 KB

readme.md

File metadata and controls

70 lines (46 loc) · 3.23 KB
Raw

Tranquil

Build Status Coverage Status Scrutinizer Javadoc Maven Central GitHub Release

Tranquil is a Java library which provides a SQL-esque language for querying JSON and Maps.

Tranquil wraps a JSON de/serialization library and adds some predicate and projection capabilities. The inputs for these capabilities are expressed in SQL since many developers are likely to be familiar with using SQL to express select and where clauses.

That's quite a mouthful so have a quick look at the simple example for clarification.

Plenty more details in the docs.

Examples

See the docs, specifically:

Using Tranquil

The tranquil library is available on Maven Central. Note: if using Tranquil as a test utility then use <scope>test</scope> or testCompile.

Maven

<dependency>
    <groupId>io.github.glytching</groupId>
    <artifactId>tranquil</artifactId>
    <version>1.0.0</version>
</dependency>

Gradle

compile 'io.github.glytching:tranquil:1.0.0'

Building Tranquil

$ git clone https://github.com/glytching/tranquil.git
$ cd tranquil
$ mvn clean install

This will compile and run all automated tests and install the library in your local Maven repository.

Note: the code is formatted using the Google Code Formatter.

License

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.

You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.