Update Samples

Author: clun

astra-db-java/src/main/java/com/datastax/astra/client/Collection.java

@@ -66,6 +66,7 @@
 
 import java.time.Instant;
 import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.List;
 import java.util.Map;
 import java.util.Optional;
@@ -532,6 +533,7 @@ public final CompletableFuture<InsertOneResult> insertOneAsync(T document, float
      * directly within the document. This is achieved through a specified expression, which the service translates
      * into vector embeddings. These embeddings can then be utilized for advanced database operations that leverage
      * vector similarity.
+     * <p><i style='color: orange;'><b>Note</b> : This feature is under current development.</i></p>
      *
      * <p><b>Note:</b> As with the base {@code insertOne} method, providing an {@code _id} field that matches an existing
      * document's {@code _id} in the collection will cause the insertion to fail with an error. If the {@code _id} field
@@ -573,6 +575,7 @@ public final InsertOneResult insertOne(T document, String vectorize) {
      * provides an asynchronous counterpart to {@link #insertOne(T document, String vectorize)}, allowing for
      * non-blocking operations while a document, along with its vectorization based on the provided string, is
      * inserted into the collection.
+     * <p><i style='color: orange;'><b>Note</b> : This feature is under current development.</i></p>
      *
      * <p>Utilizing this method facilitates the insertion of documents in scenarios where application responsiveness
      * is crucial. It allows the application to continue with other tasks while the document insertion, including
@@ -845,6 +848,39 @@ public InsertManyResult insertMany(List<? extends T> documents) {
         return insertMany(documents, new InsertManyOptions());
     }
 
+    /**
+     * Inserts a batch of documents into the collection using default insertion options. This method is a
+     * simplified version of {@link #insertMany(List, InsertManyOptions)}, intended for use cases where
+     * default settings for concurrency, chunk size, and insertion order are sufficient. It provides an
+     * efficient way to insert multiple documents concurrently, optimizing the insertion process with
+     * predefined settings.
+     *
+     * <p>The default {@link InsertManyOptions} used by this method assumes non-concurrent (sequential)
+     * insertion, with no specific chunk size or timeout constraints. This is suitable for general use
+     * cases where the simplicity of invocation is prioritized over the customization of insertion
+     * parameters. For more advanced control over the insertion process, including the ability to specify
+     * concurrency levels, chunk sizes, and operation timeouts, use the overloaded
+     * {@link #insertMany(List, InsertManyOptions)} method.</p>
+     *
+     * <p>This method leverages the same underlying insertion logic as its overloaded counterpart,
+     * ensuring consistent behavior and error handling. It automatically handles validation of the
+     * input documents list, chunking of documents based on default settings, and aggregation of
+     * insertion results into a single {@link InsertManyResult}.</p>
+     *
+     * <p><b>Usage:</b> Ideal for inserting a collection of documents without the need for custom
+     * insertion options. Simplifies the insertion process for basic use cases.</p>
+     *
+     * @param documents A list of documents to be inserted. Must not be null or empty, and no document should
+     *                  be null.
+     * @return An {@link InsertManyResult} object containing the IDs of all successfully inserted documents.
+     * @throws IllegalArgumentException if the documents list is null or empty, or if any document is null.
+     * @throws RuntimeException if there is an error in merging the results of concurrent insertions.
+     */
+    @SafeVarargs
+    public final InsertManyResult insertMany(T... documents) {
+        return insertMany(Arrays.asList(documents), new InsertManyOptions());
+    }
+
     /**
      * Asynchronously inserts a batch of documents into the collection using default insertion options. This method
      * provides an asynchronous alternative to {@link #insertMany(List)}, facilitating non-blocking operations while
@@ -1196,6 +1232,7 @@ public FindIterable<T> find(float[] vector, int limit) {
     /**
      * Finds documents in the collection that match the specified filter and sorts them based on their similarity
      * to a provided vector, limiting the number of results returned.
+     * <p><i style='color: orange;'><b>Note</b> : This feature is under current development.</i></p>
      * <p>
      * This method leverage the 'vectorization' to compute the embeddings on the fly in order to execute the search.
      * </p>
@@ -1206,7 +1243,7 @@ public FindIterable<T> find(float[] vector, int limit) {
      * @return A {@link FindIterable} for iterating over the sorted and limited documents.
      */
     public FindIterable<T> find(Filter filter, String vectorize, int limit) {
-        return find(filter, FindOptions.Builder.vectorize(vectorize).limit(limit));
+        return find(filter, FindOptions.Builder.sort(vectorize).limit(limit));
     }
 
     /**

astra-db-java/src/main/java/com/datastax/astra/client/model/FindOneAndDeleteOptions.java

@@ -64,7 +64,8 @@ public FindOneAndDeleteOptions sort(Sort... sort) {
     }
 
     /**
-     * Add a criteria with $vectorize in the sort clause
+     * Add a criteria with $vectorize in the sort clause.
+     * <p><i style='color: orange;'><b>Note</b> : This feature is under current development.</i></p>
      *
      * @param vectorize an expression to look for vectorization
      * @param sorts The sort criteria to be applied to the findOne operation.
@@ -139,12 +140,13 @@ public static FindOneAndDeleteOptions projection(Projection... projection) {
 
         /**
          * Initializes the building process with vectorize options.
+         * <p><i style='color: orange;'><b>Note</b> : This feature is under current development.</i></p>
          *
          * @param vectorize The vectorize criteria to be applied to the findOne operation
          * @param sorts The sort criteria to be applied to the findOne operation.
          * @return A new {@link FindOneAndDeleteOptions} instance configured with the provided vectorize criteria.
          */
-        public static FindOneAndDeleteOptions vectorize(String vectorize, Sort... sorts) {
+        public static FindOneAndDeleteOptions sort(String vectorize, Sort... sorts) {
             return new FindOneAndDeleteOptions().sort(vectorize, sorts);
         }
 
@@ -155,7 +157,7 @@ public static FindOneAndDeleteOptions vectorize(String vectorize, Sort... sorts)
          * @param sorts The sort criteria to be applied to the findOne operation.
          * @return A new {@link FindOneAndDeleteOptions} instance configured with the provided vector criteria.
          */
-        public static FindOneAndDeleteOptions vector(float[] vector, Sort... sorts) {
+        public static FindOneAndDeleteOptions sort(float[] vector, Sort... sorts) {
             return new FindOneAndDeleteOptions().sort(vector, sorts);
         }
     }

astra-db-java/src/main/java/com/datastax/astra/client/model/FindOneAndReplaceOptions.java

@@ -76,12 +76,13 @@ public FindOneAndReplaceOptions sort(Sort... sort) {
 
     /**
      * Add a criteria with $vectorize in the sort clause
+     * <p><i style='color: orange;'><b>Note</b> : This feature is under current development.</i></p>
      *
      * @param vectorize an expression to look for vectorization
      * @param sorts The sort criteria to be applied to the findOne operation.
      * @return current command
      */
-    public FindOneAndReplaceOptions vectorize(String vectorize, Sort ... sorts) {
+    public FindOneAndReplaceOptions sort(String vectorize, Sort ... sorts) {
         setSort(Sorts.vectorize(vectorize));
         if (sorts != null) {
             getSort().putAll(OptionsUtils.sort(sorts));
@@ -96,7 +97,7 @@ public FindOneAndReplaceOptions vectorize(String vectorize, Sort ... sorts) {
      * @param sorts The sort criteria to be applied to the findOne operation.
      * @return current command
      */
-    public FindOneAndReplaceOptions vector(float[] vector, Sort... sorts) {
+    public FindOneAndReplaceOptions sort(float[] vector, Sort... sorts) {
         setSort(Sorts.vector(vector));
         if (sorts != null) {
             getSort().putAll(OptionsUtils.sort(sorts));
@@ -215,13 +216,14 @@ public static FindOneAndReplaceOptions upsert(Boolean upsert) {
 
         /**
          * Initializes the building process with vectorize options.
+         * <p><i style='color: orange;'><b>Note</b> : This feature is under current development.</i></p>
          *
          * @param vectorize The vectorize criteria to be applied to the findOne operation
          * @param sorts The sort criteria to be applied to the findOne operation.
          * @return A new {@link FindOneAndReplaceOptions} instance configured with the provided vectorize criteria.
          */
-        public static FindOneAndReplaceOptions vectorize(String vectorize, Sort... sorts) {
-            return new FindOneAndReplaceOptions().vectorize(vectorize, sorts);
+        public static FindOneAndReplaceOptions sort(String vectorize, Sort... sorts) {
+            return new FindOneAndReplaceOptions().sort(vectorize, sorts);
         }
 
         /**
@@ -231,8 +233,8 @@ public static FindOneAndReplaceOptions vectorize(String vectorize, Sort... sorts
          * @param sorts The sort criteria to be applied to the findOne operation.
          * @return A new {@link FindOneAndReplaceOptions} instance configured with the provided vector criteria.
          */
-        public static FindOneAndReplaceOptions vector(float[] vector, Sort... sorts) {
-            return new FindOneAndReplaceOptions().vector(vector, sorts);
+        public static FindOneAndReplaceOptions sort(float[] vector, Sort... sorts) {
+            return new FindOneAndReplaceOptions().sort(vector, sorts);
         }
     }
 

astra-db-java/src/main/java/com/datastax/astra/client/model/FindOneAndUpdateOptions.java

@@ -82,7 +82,7 @@ public FindOneAndUpdateOptions sort(Sort... sort) {
      * @param sorts The sort criteria to be applied to the findOne operation.
      * @return current command
      */
-    public FindOneAndUpdateOptions vectorize(String vectorize, Sort ... sorts) {
+    public FindOneAndUpdateOptions sort(String vectorize, Sort ... sorts) {
         setSort(Sorts.vectorize(vectorize));
         if (sorts != null) {
             getSort().putAll(OptionsUtils.sort(sorts));
@@ -97,7 +97,7 @@ public FindOneAndUpdateOptions vectorize(String vectorize, Sort ... sorts) {
      * @param sorts The sort criteria to be applied to the findOne operation.
      * @return current command
      */
-    public FindOneAndUpdateOptions vector(float[] vector, Sort... sorts) {
+    public FindOneAndUpdateOptions sort(float[] vector, Sort... sorts) {
         setSort(Sorts.vector(vector));
         if (sorts != null) {
             getSort().putAll(OptionsUtils.sort(sorts));
@@ -220,8 +220,8 @@ public static FindOneAndUpdateOptions upsert(Boolean upsert) {
          * @param sorts The sort criteria to be applied to the findOne operation.
          * @return A new {@link FindOneAndUpdateOptions} instance configured with the provided vectorize criteria.
          */
-        public static FindOneAndUpdateOptions vectorize(String vectorize, Sort... sorts) {
-            return new FindOneAndUpdateOptions().vectorize(vectorize, sorts);
+        public static FindOneAndUpdateOptions sort(String vectorize, Sort... sorts) {
+            return new FindOneAndUpdateOptions().sort(vectorize, sorts);
         }
 
         /**
@@ -231,8 +231,8 @@ public static FindOneAndUpdateOptions vectorize(String vectorize, Sort... sorts)
          * @param sorts The sort criteria to be applied to the findOne operation.
          * @return A new {@link FindOneAndUpdateOptions} instance configured with the provided vector criteria.
          */
-        public static FindOneAndUpdateOptions vector(float[] vector, Sort... sorts) {
-            return new FindOneAndUpdateOptions().vector(vector, sorts);
+        public static FindOneAndUpdateOptions sort(float[] vector, Sort... sorts) {
+            return new FindOneAndUpdateOptions().sort(vector, sorts);
         }
     }
 

astra-db-java/src/main/java/com/datastax/astra/client/model/FindOneOptions.java

@@ -70,6 +70,7 @@ public FindOneOptions sort(Sort... sort) {
 
     /**
      * Add a criteria with $vectorize in the sort clause
+     * <p><i style='color: orange;'><b>Note</b> : This feature is under current development.</i></p>
      *
      * @param vectorize an expression to look for vectorization
      * @param sorts The sort criteria to be applied to the findOne operation.
@@ -156,6 +157,7 @@ public static FindOneOptions sort(float[] vector, Sort... sort) {
 
         /**
          * Initializes the building process with sorting options.
+         * <p><i style='color: orange;'><b>Note</b> : This feature is under current development.</i></p>
          *
          * @param vectorize string to be vectorized in the findOne operation.
          * @param sort The sort criteria to be applied to the findOne operation.
@@ -184,26 +186,5 @@ public static FindOneOptions includeSimilarity() {
             return new FindOneOptions().includeSimilarity();
         }
 
-        /**
-         * Initializes the building process with vectorize options.
-         *
-         * @param vectorize The vectorize criteria to be applied to the findOne operation
-         * @param sorts The sort criteria to be applied to the findOne operation.
-         * @return A new {@link FindOneOptions} instance configured with the provided vectorize criteria.
-         */
-        public static FindOneOptions vectorize(String vectorize, Sort... sorts) {
-            return new FindOneOptions().sort(vectorize, sorts);
-        }
-
-        /**
-         * Initializes the building process with vector options.
-         *
-         * @param vector The vector criteria to be applied to the findOne operation
-         * @param sorts The sort criteria to be applied to the findOne operation.
-         * @return A new {@link FindOneOptions} instance configured with the provided vector criteria.
-         */
-        public static FindOneOptions vector(float[] vector, Sort... sorts) {
-            return new FindOneOptions().sort(vector, sorts);
-        }
     }
 }

astra-db-java/src/main/java/com/datastax/astra/client/model/FindOptions.java

@@ -85,7 +85,8 @@ public FindOptions sort(Sort... sort) {
     }
 
     /**
-     * Add a criteria with $vectorize in the sort clause
+     * Add a criteria with $vectorize in the sort clause.
+     * <p><i style='color: orange;'><b>Note</b> : This feature is under current development.</i></p>
      *
      * @param vectorize an expression to look for vectorization
      * @param sorts The sort criteria to be applied to the findOne operation.
@@ -211,6 +212,7 @@ public static FindOptions sort(float[] vector, Sort... sort) {
 
         /**
          * Initializes the building process with sorting options.
+         * <p><i style='color: orange;'><b>Note</b> : This feature is under current development.</i></p>
          *
          * @param vectorize string to be vectorized in the findOne operation.
          * @param sort The sort criteria to be applied to the findOne operation.
@@ -259,26 +261,5 @@ public static FindOptions limit(int limit) {
             return new FindOptions().limit(limit);
         }
 
-        /**
-         * Initializes the building process with vectorize options.
-         *
-         * @param vectorize The vectorize criteria to be applied to the findOne operation
-         * @param sort The sort criteria to be applied to the findOne operation.
-         * @return A new {@link FindOneOptions} instance configured with the provided vectorize criteria.
-         */
-        public static FindOptions vectorize(String vectorize, Sort ... sort) {
-            return new FindOptions().sort(vectorize, sort);
-        }
-
-        /**
-         * Initializes the building process with vector options.
-         *
-         * @param vector The vector criteria to be applied to the findOne operation
-         * @param sort The sort criteria to be applied to the findOne operation.
-         * @return A new {@link FindOneOptions} instance configured with the provided vector criteria.
-         */
-        public static FindOptions vector(float[] vector, Sort ... sort) {
-            return new FindOptions().sort(vector, sort);
-        }
     }
 }

astra-db-java/src/test/java/com/datastax/astra/test/integration/collection/VectorizePreviewITTest.java

@@ -16,7 +16,7 @@
 import java.util.UUID;
 import java.util.stream.Collectors;
 
-import static com.datastax.astra.client.model.FindOptions.Builder.vectorize;
+import static com.datastax.astra.client.model.FindOptions.Builder.sort;
 import static org.assertj.core.api.Assertions.assertThat;
 
 /**
@@ -69,7 +69,7 @@ void shouldInsertOneDocumentWithVectorize() {
     @Test
     void testFindVectorize() {
         List<Document> doclist = collectionVectorize
-                .find(vectorize("Life is too short for Javascript"))
+                .find(sort("Life is too short for Javascript"))
                 .all();
         assertThat(doclist).isNotNull().isNotEmpty();
     }