feat: Sorting for search results #121

adilansari · 2022-08-12T06:06:38Z

Interface to allow users to specify sort order for search results.

TigrisSort asc = Sort.ascending("a");
TigrisSort desc = Sort.descending("b");

SearchRequest req = SearchRequest.matchAll().withSort(asc, desc).build();

OR

TigrisSort asc = Sort.ascending("a");
TigrisSort desc = Sort.descending("b");
SortingOrder order = SortingOrder.withOrder(asc, desc).build()

SearchRequest req = SearchRequest.newBuilder().withQ("running").withSort(order).build();

codecov-commenter · 2022-08-12T16:47:32Z

Codecov Report

Merging #121 (68d9ccc) into main (e942711) will increase coverage by 0.46%.
The diff coverage is 91.42%.

@@             Coverage Diff              @@
##               main     #121      +/-   ##
============================================
+ Coverage     83.00%   83.47%   +0.46%     
- Complexity      616      646      +30     
============================================
  Files            68       72       +4     
  Lines          1948     2015      +67     
  Branches        166      173       +7     
============================================
+ Hits           1617     1682      +65     
- Misses          296      297       +1     
- Partials         35       36       +1

Impacted Files	Coverage Δ
.../tigrisdata/db/client/search/FacetFieldsQuery.java	`87.50% <50.00%> (-3.62%)`	⬇️
.../com/tigrisdata/db/client/search/SortingOrder.java	`86.66% <86.66%> (ø)`
.../main/java/com/tigrisdata/db/client/FieldSort.java	`100.00% <100.00%> (ø)`
...t/src/main/java/com/tigrisdata/db/client/Sort.java	`100.00% <100.00%> (ø)`
.../main/java/com/tigrisdata/db/client/SortOrder.java	`100.00% <100.00%> (ø)`
...n/java/com/tigrisdata/db/client/TypeConverter.java	`93.56% <100.00%> (+1.16%)`	⬆️
...com/tigrisdata/db/client/search/SearchRequest.java	`95.83% <100.00%> (+4.52%)`	⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

adilansari · 2022-08-12T16:48:54Z

client/src/main/java/com/tigrisdata/db/client/FieldSort.java

+import java.util.Objects;
+
+/** Represents a collection field and corresponding sort order */
+public final class FieldSort implements TigrisSort {


In future we can extend this further

class GeoDistanceSort implements TigrisSort {} Sort.geoDistance(String fieldName, GeoLocation loc)

client/src/main/java/com/tigrisdata/db/client/TigrisSort.java

client/src/main/java/com/tigrisdata/db/client/SortingOperator.java

client/src/main/java/com/tigrisdata/db/client/Sort.java

JigarJoshi · 2022-08-12T19:49:18Z

client/src/main/java/com/tigrisdata/db/client/FieldSort.java

+  }
+
+  @Override
+  public boolean equals(Object o) {


nit: in other places in this library. I have been using IDE generated equals and hashCode (Java 7+) with java.util.Objects

JigarJoshi · 2022-08-12T19:56:31Z

client/src/main/java/com/tigrisdata/db/client/search/SearchRequest.java

     * @return {@link SearchRequest.Builder}
     */
-    public Builder withSortOrder(SortOrder sortOrder) {
+    public Builder withSort(SortingOrder sortOrder) {


What are the use cases when this method is useful vs the following?

can you add a rpc method test to exercise the full trip?

Allow sharing of SortingOrder between search requests. Or if we introduce sorting for read.

makes sense.

adilansari added 2 commits August 11, 2022 23:01

feat: Sorting for search results

6c65b67

refactor: changed api to withOrder

21d9412

adilansari force-pushed the sorting branch from 98e432c to 21d9412 Compare August 12, 2022 16:45

adilansari commented Aug 12, 2022

View reviewed changes