jguitart / rsql-panache

jguitart/rsql-panache

This is an extension to adapt rsql query parser (https://github.com/jirutka/rsql-parser) to quarkus panache extension.

Dependencies

This extension needs quarkus panache and rsql-parser to work, so this extension will add those in you dependeny tree.

Add in you pom.xml the dependencies:

    <dependency>
      <groupId>cz.jirutka.rsql</groupId>
      <artifactId>rsql-parser</artifactId>
      <version>2.1.0</version>
    </dependency>
    <dependency>
      <groupId>io.quarkus</groupId>
      <artifactId>quarkus-hibernate-orm-panache</artifactId>
    </dependency>

Install

Gradle

    implementation 'org.jguitart:rsql-panache:1.0.2'

Maven

    <dependency>
        <groupId>org.jguitart</groupId>
        <artifactId>rsql-panache</artifactId>
        <version>1.0.2</version>
    </dependency>

Usage

The main way to use this extension is to implement a RsqlParser. This must extends PanacheRsqlParserBase.

Basic example:

 public class FruitRsqlParser extends PanacheRsqlParserBase<Fruit> {

    // The parser doesn't take in account query sort, so if you want to define it, you should add it.
    Sort sort;

    public FruitRsqlParser(String sortColumn, boolean asc) {
        sort = asc ? Sort.by(sortColumn).ascending():Sort.by(sortColumn).descending();
    }

    // This method is called by parse method, and parse method calculates and passes queryDescriptor.
    // At the end it returns a panache Query ready to use.
    @Override
    public PanacheQuery<Fruit> build(PanacheQueryDescriptor queryDescriptor) {
        PanacheQuery<Fruit> result;
        if(queryDescriptor.getQuery()!=null && !queryDescriptor.getQuery().isBlank()) {
            result = Fruit.find(queryDescriptor.getQuery(), this.sort, queryDescriptor.getParams());
        } else {
            result = Fruit.findAll();
        }
        return result;
    }
}

Once this class is implemented then we can use it without any problem.

    String query = "name == apple || name == banana";
    String sortColumn = "name";
    boolean asc = true;
    FruitRsqlParser<Fruit> parser = new FruitRsqlParser(sortColumn, asc); 
    PanacheQuery<Fruit> query = parser.parse(query);
    query.listAll();

Date and Instant

Date and Instant fields in entity should be queried as a epoch millis.

Example:

    // Of course Fruit entity should have a `Date dateCreated` field.
    java.util.Date desiredDateCreated = new java.util.Date():
    String q = String.format("dateCreated==%d", desiredDateCreated.getTime());
    String sortColumn = "name";
    boolean asc = true;
    FruitRsqlParser<Fruit> parser = new FruitRsqlParser(sortColumn, asc);
    PanacheQuery<Fruit> query = parser.parse(query);
    query.listAll();