chore: add SortBy to fetch objects

Author: bevzzz

src/it/java/io/weaviate/integration/SearchITest.java

@@ -29,6 +29,7 @@
 import io.weaviate.client6.v1.api.collections.query.Metadata;
 import io.weaviate.client6.v1.api.collections.query.QueryMetadata;
 import io.weaviate.client6.v1.api.collections.query.QueryResponseGroup;
+import io.weaviate.client6.v1.api.collections.query.SortBy;
 import io.weaviate.client6.v1.api.collections.query.Where;
 import io.weaviate.containers.Container;
 import io.weaviate.containers.Container.ContainerGroup;
@@ -257,6 +258,41 @@ public void testFetchObjectsWithFilters() throws IOException {
 
   }
 
+  @Test
+  public void testFetchObjectsWithSort() throws IOException {
+    var nsNumbers = ns("Numbers");
+
+    // Arrange
+    client.collections.create(nsNumbers,
+        c -> c.properties(Property.integer("value")));
+
+    var numbers = client.collections.use(nsNumbers);
+
+    var one = numbers.data.insert(Map.of("value", 1L));
+    var two = numbers.data.insert(Map.of("value", 2L));
+    var three = numbers.data.insert(Map.of("value", 3L));
+
+    // Act: sort ascending
+    var asc = numbers.query.fetchObjects(
+        q -> q.sort(SortBy.property("value")));
+
+    Assertions.assertThat(asc.objects())
+        .hasSize(3)
+        .extracting(WeaviateObject::properties)
+        .extracting(object -> object.get("value"))
+        .containsExactly(1L, 2L, 3L);
+
+    // Act: sort descending
+    var desc = numbers.query.fetchObjects(
+        q -> q.sort(SortBy.property("value").desc()));
+
+    Assertions.assertThat(desc.objects())
+        .hasSize(3)
+        .extracting(WeaviateObject::properties)
+        .extracting(object -> object.get("value"))
+        .containsExactly(3L, 2L, 1L);
+  }
+
   @Test
   public void testBm25() throws IOException, InterruptedException, ExecutionException {
     var nsWords = ns("Words");

src/main/java/io/weaviate/client6/v1/api/collections/query/FetchObjects.java

@@ -1,21 +1,34 @@
 package io.weaviate.client6.v1.api.collections.query;
 
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.List;
 import java.util.function.Function;
 
 import io.weaviate.client6.v1.internal.ObjectBuilder;
 import io.weaviate.client6.v1.internal.grpc.protocol.WeaviateProtoSearchGet;
 
-public record FetchObjects(BaseQueryOptions common) implements QueryOperator {
+public record FetchObjects(BaseQueryOptions common, List<SortBy> sortBy) implements QueryOperator {
 
   public static FetchObjects of(Function<Builder, ObjectBuilder<FetchObjects>> fn) {
     return fn.apply(new Builder()).build();
   }
 
   public FetchObjects(Builder builder) {
-    this(builder.baseOptions());
+    this(builder.baseOptions(), builder.sortBy);
   }
 
   public static class Builder extends BaseQueryOptions.Builder<Builder, FetchObjects> {
+    private final List<SortBy> sortBy = new ArrayList<>();
+
+    public Builder sort(SortBy... sortBy) {
+      return sort(Arrays.asList(sortBy));
+    }
+
+    public Builder sort(List<SortBy> sortBy) {
+      this.sortBy.addAll(sortBy);
+      return this;
+    }
 
     @Override
     public final FetchObjects build() {
@@ -26,5 +39,11 @@ public final FetchObjects build() {
   @Override
   public void appendTo(WeaviateProtoSearchGet.SearchRequest.Builder req) {
     common.appendTo(req);
+
+    for (final var sort : sortBy) {
+      req.addSortBy(WeaviateProtoSearchGet.SortBy.newBuilder()
+          .addAllPath(sort.path())
+          .setAscending(sort.ascending()));
+    }
   }
 }

src/main/java/io/weaviate/client6/v1/api/collections/query/SortBy.java

@@ -0,0 +1,17 @@
+package io.weaviate.client6.v1.api.collections.query;
+
+import java.util.List;
+
+public record SortBy(List<String> path, boolean ascending) {
+  public static SortBy property(String property) {
+    return new SortBy(List.of(property), true);
+  }
+
+  public SortBy asc() {
+    return new SortBy(path, true);
+  }
+
+  public SortBy desc() {
+    return new SortBy(path, false);
+  }
+}