feat: add data.update method

Author: bevzzz

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

@@ -15,6 +15,7 @@
 import io.weaviate.client6.v1.api.collections.WeaviateObject;
 import io.weaviate.client6.v1.api.collections.data.Reference;
 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.QueryReference;
 import io.weaviate.client6.v1.api.collections.vectorindex.Hnsw;
 import io.weaviate.client6.v1.api.collections.vectorizers.NoneVectorizer;
@@ -180,9 +181,73 @@ public void testReferences_AddReplaceDelete() throws IOException {
 
   @Test
   public void testReplace() {
+    // Replace (PUT):
+    // properties, reference, vectors
   }
 
   @Test
-  public void testUpdate() {
+  public void testUpdate() throws IOException {
+    // Arrange
+    var nsBooks = ns("Books");
+    var nsAuthors = ns("Authors");
+
+    client.collections.create(nsAuthors,
+        collection -> collection
+            .properties(Property.text("name")));
+
+    client.collections.create(nsBooks,
+        collection -> collection
+            .properties(Property.text("title"), Property.integer("year"))
+            .references(Property.reference("writtenBy", nsAuthors))
+            .vector(Hnsw.of(new NoneVectorizer())));
+
+    var authors = client.collections.use(nsAuthors);
+    var walter = authors.data.insert(Map.of("name", "walter scott"));
+
+    var vector = new Float[] { 1f, 2f, 3f };
+
+    var books = client.collections.use(nsBooks);
+
+    // Add 1 book without mentioning its author, year published,
+    // or supplying a vector.
+    var ivanhoe = books.data.insert(Map.of("title", "ivanhoe"));
+
+    // Act
+    books.data.update(ivanhoe.metadata().uuid(),
+        update -> update
+            .properties(Map.of("year", 1819))
+            .reference("writtenBy", Reference.objects(walter))
+            .vectors(Vectors.of(vector)));
+
+    // Assert
+    var updIvanhoe = books.query.byId(
+        ivanhoe.metadata().uuid(),
+        query -> query
+            .returnMetadata(Metadata.VECTOR)
+            .returnReferences(
+                QueryReference.single("writtenBy",
+                    writtenBy -> writtenBy.returnMetadata(Metadata.ID))));
+
+    Assertions.assertThat(updIvanhoe).get()
+        .satisfies(book -> {
+          Assertions.assertThat(book)
+              .as("has year property")
+              .extracting(WeaviateObject::properties, InstanceOfAssertFactories.MAP)
+              .contains(Map.entry("year", 1819L));
+
+          Assertions.assertThat(book)
+              .as("has reference to Authors")
+              .extracting(WeaviateObject::references, InstanceOfAssertFactories.MAP)
+              .extractingByKey("writtenBy", InstanceOfAssertFactories.list(WeaviateObject.class))
+              .first()
+              .extracting(WeaviateObject::properties, InstanceOfAssertFactories.MAP)
+              .contains(Map.entry("name", "walter scott"));
+
+          Assertions.assertThat(book)
+              .as("has a vector")
+              .extracting(WeaviateObject::metadata)
+              .extracting(QueryMetadata::vectors)
+              .returns(vector, Vectors::getDefaultSingle);
+        });
   }
 }

src/main/java/io/weaviate/client6/v1/api/collections/data/UpdateObjectRequest.java

@@ -0,0 +1,67 @@
+package io.weaviate.client6.v1.api.collections.data;
+
+import java.util.Collections;
+import java.util.function.Function;
+
+import com.google.gson.reflect.TypeToken;
+
+import io.weaviate.client6.v1.api.collections.ObjectMetadata;
+import io.weaviate.client6.v1.api.collections.Vectors;
+import io.weaviate.client6.v1.api.collections.WeaviateObject;
+import io.weaviate.client6.v1.internal.ObjectBuilder;
+import io.weaviate.client6.v1.internal.json.JSON;
+import io.weaviate.client6.v1.internal.orm.CollectionDescriptor;
+import io.weaviate.client6.v1.internal.rest.Endpoint;
+
+public record UpdateObjectRequest<T>(WeaviateObject<T, Reference, ObjectMetadata> object) {
+
+  static final <T> Endpoint<UpdateObjectRequest<T>, Void> endpoint(CollectionDescriptor<T> collectionDescriptor) {
+    return Endpoint.of(
+        request -> "PATCH",
+        request -> "/objects/" + collectionDescriptor.name() + "/" + request.object.metadata().uuid(),
+        (gson, request) -> JSON.serialize(request.object, TypeToken.getParameterized(
+            WeaviateObject.class, collectionDescriptor.typeToken().getType(), Reference.class, ObjectMetadata.class)),
+        request -> Collections.emptyMap(),
+        code -> code != 204,
+        (gson, response) -> null);
+  }
+
+  public static <T> UpdateObjectRequest<T> of(String uuid,
+      Function<UpdateObjectRequest.Builder<T>, ObjectBuilder<UpdateObjectRequest<T>>> fn) {
+    return fn.apply(new Builder<>(uuid)).build();
+  }
+
+  public UpdateObjectRequest(Builder<T> builder) {
+    this(builder.object.build());
+  }
+
+  public static class Builder<T> implements ObjectBuilder<UpdateObjectRequest<T>> {
+    private final WeaviateObject.Builder<T, Reference, ObjectMetadata> object = new WeaviateObject.Builder<>();
+    private final ObjectMetadata.Builder metadata = new ObjectMetadata.Builder();
+
+    public Builder(String uuid) {
+      this.metadata.uuid(uuid);
+    }
+
+    public Builder<T> properties(T properties) {
+      this.object.properties(properties);
+      return this;
+    }
+
+    public Builder<T> vectors(Vectors vectors) {
+      this.metadata.vectors(vectors);
+      return this;
+    }
+
+    public Builder<T> reference(String property, Reference... references) {
+      this.object.reference(property, references);
+      return this;
+    }
+
+    @Override
+    public UpdateObjectRequest<T> build() {
+      this.object.metadata(this.metadata.build());
+      return new UpdateObjectRequest<>(this);
+    }
+  }
+}

src/main/java/io/weaviate/client6/v1/api/collections/data/WeaviateDataClient.java

@@ -41,6 +41,12 @@ public boolean exists(String uuid) throws IOException {
     return this.query.byId(uuid).isPresent();
   }
 
+  public void update(String uuid, Function<UpdateObjectRequest.Builder<T>, ObjectBuilder<UpdateObjectRequest<T>>> fn)
+      throws IOException {
+    this.restTransport.performRequest(UpdateObjectRequest.of(uuid, fn),
+        UpdateObjectRequest.endpoint(collectionDescriptor));
+  }
+
   public void delete(String uuid) throws IOException {
     this.restTransport.performRequest(new DeleteObjectRequest(collectionDescriptor.name(), uuid),
         DeleteObjectRequest._ENDPOINT);