The {@code DataAPIClient} is designed to simplify database interactions by providing: + *
The {@code DataAPIClient} is designed to simplify database interactions by providing:
+ * *Core Features: + *
This design philosophy facilitates quick onboarding and ease of use while enabling advanced customizations when needed.
+ * + *Example usage:
- *
- * {@code
+ * Example Usage:
+ * {@code
* DataAPIClientOptions options = new DataAPIClientOptions()
* .destination(DataAPIDestination.DSE) // Set the destination
* .httpClientOptions(new HttpClientOptions()
@@ -68,8 +67,7 @@
* .enableFeatureFlagTables() // Enable feature flag for tables
* .addDatabaseAdditionalHeader(HEADER_FEATURE_FLAG_TABLES, "true"); // Add custom headers
* DataAPIClient client = new DataAPIClient("token", options);
- * }
- *
+ * }
*/
public class DataAPIClient {
@@ -214,14 +212,13 @@ public DataAPIClient(DataAPIClientOptions options) {
* performing administrative tasks such as database creation, user management, and configuration adjustments.
* It provides a programmatic interface for managing Astra resources securely and efficiently.
*
- * This method has three variants, allowing for flexibility in token usage: + *
This method has three variants, allowing for flexibility in token usage:
*To perform administrative tasks, the token must belong to a user with sufficient privileges (e.g., Database * Administrator or Organization Administrator). If these conditions are not met, a {@code SecurityException} is thrown.
@@ -245,8 +242,10 @@ public DataAPIClient(DataAPIClientOptions options) { * } * * + * @param adminOptions + * The options to configure the administration client, including the authentication token. * @return An instance of {@link AstraDBAdmin} configured with the appropriate authentication token and options, - * ready for administrative operations. + * ready for administrative operations. */ public AstraDBAdmin getAdmin(AdminOptions adminOptions) { if (!options.isAstra()) { @@ -288,7 +287,7 @@ public AstraDBAdmin getAdmin(String superToken) { * with the specified Data API endpoint, supporting a wide range of data manipulation operations such as querying, * inserting, updating, and deleting data. * - *The {@code getDatabase} method has multiple variants to cater to different usage scenarios: + *
The {@code getDatabase} method has multiple variants to cater to different usage scenarios:
*By providing flexibility in how connections are established and configured, these methods simplify the process * of interacting with Cassandra databases through the Data API. They are suitable for various deployment scenarios, @@ -323,12 +321,30 @@ public AstraDBAdmin getAdmin(String superToken) { * @return A {@link Database} client tailored for interaction with the Data API, configured according to the * provided parameters. * + * @param apiEndpoint The URL of the Data API endpoint to connect to. + * @param dbOptions The options to configure the database client. * @throws IllegalArgumentException If the provided parameters are invalid or insufficient for resolving the endpoint. */ public Database getDatabase(String apiEndpoint, DatabaseOptions dbOptions) { return new Database(apiEndpoint, dbOptions); } + /** + * Retrieves a database client configured to connect to the Data API using the specified API endpoint and keyspace. + *
+ * Uses default {@link DatabaseOptions} for configuration. + *
+ * + * @param apiEndpoint The URL of the Data API endpoint to connect to. + * @param keyspace The name of the keyspace to use for database operations. + * @return A {@link Database} client configured with default options for the specified endpoint and keyspace. + * @see #getDatabase(String, DatabaseOptions) + */ + public Database getDatabase(String apiEndpoint, String keyspace) { + DatabaseOptions dbOptions = new DatabaseOptions(token, options).keyspace(keyspace); + return new Database(apiEndpoint, dbOptions); + } + /** * Retrieves a database client configured to connect to the Data API using the specified API endpoint. *diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/DataAPIClients.java b/astra-db-java/src/main/java/com/datastax/astra/client/DataAPIClients.java index 95d3e5ad..220b9bf1 100644 --- a/astra-db-java/src/main/java/com/datastax/astra/client/DataAPIClients.java +++ b/astra-db-java/src/main/java/com/datastax/astra/client/DataAPIClients.java @@ -94,6 +94,35 @@ public static DataAPIClient clientCassandra() { UsernamePasswordTokenProvider.DEFAULT_CREDENTIALS); } + /** + * Creates and configures a {@link DataAPIClient} for interaction with a local instance of DataAPI, + * a data gateway that facilitates working with Apache Cassandra®. This method is tailored for + * development and testing workflows, enabling simplified and efficient access to local database + * resources without the need for extensive configuration. + * + *
The returned {@link DataAPIClient} is preconfigured with: + *
Example usage:
+ *
+ * {@code
+ * DataAPIClient client = DataAPIClients.local("username", "password");
+ * }
+ *
+ */
public static DataAPIClient clientCassandra(String username, String password) {
return new DataAPIClient(
new UsernamePasswordTokenProvider(username, password).getToken(),
@@ -103,12 +132,70 @@ public static DataAPIClient clientCassandra(String username, String password) {
.logRequests());
}
+ /**
+ * Creates and configures a {@link DataAPIClient} specifically designed for interaction with a local instance
+ * of the Data API and Cassandra. This method simplifies the setup process by combining the creation of a {@link DataAPIClient}
+ * with the integration of a {@link Database} abstraction. It is tailored for local development and testing,
+ * enabling seamless interaction with Apache Cassandra® through Stargate with minimal configuration.
+ *
+ * Upon creation, this method ensures that a default keyspace is available in the local Stargate instance + * by automatically invoking {@link com.datastax.astra.client.admin.DatabaseAdmin#createKeyspace(String)}. This guarantees that developers + * have a ready-to-use environment for executing database operations during their development or testing workflows. + * + *
The returned {@link Database} client is preconfigured with: + *
Example usage:
+ *
+ * {@code
+ * Database db = localDbWithDefaultKeyspace();
+ * }
+ *
+ */
public static DataAPIClient clientHCD() {
return clientHCD(
UsernamePasswordTokenProvider.DEFAULT_USERNAME,
UsernamePasswordTokenProvider.DEFAULT_CREDENTIALS);
}
+ /**
+ * Creates and configures a {@link DataAPIClient} specifically designed for interaction with a local instance
+ * of the Data API and Cassandra. This method simplifies the setup process by combining the creation of a {@link DataAPIClient}
+ * with the integration of a {@link Database} abstraction. It is tailored for local development and testing,
+ * enabling seamless interaction with Apache Cassandra® through Stargate with minimal configuration.
+ *
+ * Upon creation, this method ensures that a default keyspace is available in the local Stargate instance + * by automatically invoking {@link com.datastax.astra.client.admin.DatabaseAdmin#createKeyspace(String)}. This guarantees that developers + * have a ready-to-use environment for executing database operations during their development or testing workflows. + * + *
The returned {@link Database} client is preconfigured with: + *
Example usage:
+ *
+ * {@code
+ * Database db = localDbWithDefaultKeyspace();
+ * }
+ *
+ */
public static DataAPIClient clientHCD(String username, String password) {
return new DataAPIClient(
new UsernamePasswordTokenProvider(username, password).getToken(),
@@ -204,8 +291,6 @@ public static DataAPIClient astra(String token) {
.logRequests());
}
-
-
/**
* Creates a {@link DataAPIClient} specifically configured for interacting with Astra in a test environment.
* This method is designed for testing scenarios, providing an isolated environment to safely execute
diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/admin/AdminOptions.java b/astra-db-java/src/main/java/com/datastax/astra/client/admin/AdminOptions.java
index 69a50f99..f5e781cd 100644
--- a/astra-db-java/src/main/java/com/datastax/astra/client/admin/AdminOptions.java
+++ b/astra-db-java/src/main/java/com/datastax/astra/client/admin/AdminOptions.java
@@ -20,7 +20,7 @@
* #L%
*/
-import com.datastax.astra.client.core.commands.BaseOptions;
+import com.datastax.astra.client.core.options.BaseOptions;
import com.datastax.astra.client.core.commands.CommandType;
import com.datastax.astra.client.core.options.DataAPIClientOptions;
import com.datastax.astra.internal.serdes.DataAPISerializer;
@@ -28,17 +28,52 @@
import lombok.Setter;
import lombok.experimental.Accessors;
+/**
+ * Represents the configuration options for administrative operations in the database API.
+ * This class extends {@link BaseOptions} to inherit common configuration options
+ * and provides additional functionality specific to administrative commands.
+ *
+ * Example usage:
+ *
+ * {@code
+ * AdminOptions options = new AdminOptions()
+ * .token("your-token-here")
+ * .options(new DataAPIClientOptions())
+ * .serializer(new CustomSerializer());
+ * }
+ *
+ *
+ * Key Features:
+ *- *
Example usage:
- *
- * {@code
- *
- * // Initialization of the client
- * DataApiClient client1 = DataApiClients.create("http://<>endpoint>", "", new HttpClientOptions());
- *
- * // Example operation: Create a new namespace
- * DataApiNamespace newNamespace = client.createNamespace("exampleNamespace");
- *
- * // Example operation: Fetch a namespace
- * DataApiNamespace fetchedNamespace = client.getNamespace("exampleNamespace");
- *
- * // Example operation: Delete a namespace
- * client.deleteNamespace("exampleNamespace");
- * }
- *
*/
public interface DatabaseAdmin {
@@ -99,6 +83,24 @@ public interface DatabaseAdmin {
*/
FindEmbeddingProvidersResult findEmbeddingProviders();
+ /**
+ * Retrieve the list of reranking providers available in the current database. Reranking providers are services
+ * that sort a list of record based on a algorithm (eg bm25) . This method returns a map of provider names to
+ * {@link RerankProvider} instances, allowing applications
+ * to access and utilize the reranking services.
+ *
+ * Example usage:
+ *
+ * {@code
+ * // Assuming 'client' is an instance of DataApiClient
+ * Map providers = client.findEmbeddingProvidersAsMap());
+ * }
+ *
+ * @return
+ * list of available providers
+ */
+ FindRerankingProvidersResult findRerankingProviders();
+
/**
* Asynchronously retrieves a stream of keyspaces names available in the current database. This method facilitates
* non-blocking operations by allowing the application to continue executing other tasks while the list of keyspace
@@ -209,29 +211,45 @@ default void dropKeyspace(String keyspace) {
dropKeyspace(keyspace, null);
}
- void dropKeyspace(String keyspace, BaseOptions options);
-
/**
- * Asynchronously drops (deletes) the specified keyspace from the database. This operation is idempotent, meaning
- * it will not produce an error if the keyspace does not exist. Performing this operation asynchronously ensures
- * that the calling thread remains responsive, and can be particularly useful for applications that require high
- * availability and cannot afford to block on potentially long-running operations. Just like its synchronous counterpart,
- * this method should be used with caution as dropping a keyspace will remove all associated data, collections,
- * or tables, and this action is irreversible.
+ * Drops (deletes) the specified keyspace from the database. This operation is idempotent; it will not
+ * produce an error if the keyspace does not exist. This method is useful for cleaning up data or removing
+ * entire keyspaces as part of database maintenance or restructuring. Caution should be exercised when using
+ * this method, as dropping a keyspace will remove all the data, collections, or tables contained within it,
+ * and this action cannot be undone.
*
* Example usage:
*
* {@code
* // Assume 'client' is an instance of your data API client
- * String keyspace = "asyncTargetKeyspace";
+ * String keyspace = "targetKeyspace";
*
- * // Asynchronously drop the namespace
- * client.dropKeyspaceAsync(keyspace);
+ * // Drop the keyspace
+ * client.dropKeyspace(keyspace);
*
- * // The keyspace 'asyncTargetKeyspace' is now being deleted in the background, along with all its contained data
+ * // The keyspace 'targetKeyspace' is now deleted, along with all its contained data
* }
*
*
+ * This example demonstrates how to safely drop a keyspace by name. The operation ensures that even if the
+ * keyspace does not exist, the method call will not interrupt the flow of the application, thereby allowing
+ * for flexible and error-tolerant code design.
+ *
+ * @param keyspace The name of the keyspace to be dropped. This parameter specifies the target keyspace
+ * that should be deleted. The operation will proceed silently and without error even if the
+ * keyspace does not exist, ensuring consistent behavior.
+ * @param options The options to use for the operation.
+ */
+ void dropKeyspace(String keyspace, BaseOptions options);
+
+ /**
+ * Asynchronously drops (deletes) the specified keyspace from the database. This operation is idempotent, meaning
+ * it will not produce an error if the keyspace does not exist. Performing this operation asynchronously ensures
+ * that the calling thread remains responsive, and can be particularly useful for applications that require high
+ * availability and cannot afford to block on potentially long-running operations. Just like its synchronous counterpart,
+ * this method should be used with caution as dropping a keyspace will remove all associated data, collections,
+ * or tables, and this action is irreversible.
+ *
* This example illustrates the non-blocking nature of dropping a keyspace. It demonstrates the method's utility in
* maintaining application responsiveness, even when performing potentially long-running database operations.
*
diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/collections/Collection.java b/astra-db-java/src/main/java/com/datastax/astra/client/collections/Collection.java
index 5f4d38d8..04cccb64 100644
--- a/astra-db-java/src/main/java/com/datastax/astra/client/collections/Collection.java
+++ b/astra-db-java/src/main/java/com/datastax/astra/client/collections/Collection.java
@@ -20,59 +20,70 @@
* #L%
*/
-import com.datastax.astra.client.collections.documents.Document;
-import com.datastax.astra.client.collections.documents.ReturnDocument;
-import com.datastax.astra.client.collections.documents.Update;
+import com.datastax.astra.client.collections.commands.ReturnDocument;
+import com.datastax.astra.client.collections.commands.Update;
+import com.datastax.astra.client.collections.commands.cursor.CollectionFindAndRerankCursor;
+import com.datastax.astra.client.collections.commands.cursor.CollectionFindCursor;
+import com.datastax.astra.client.collections.commands.options.CollectionDeleteManyOptions;
+import com.datastax.astra.client.collections.commands.options.CollectionDeleteOneOptions;
+import com.datastax.astra.client.collections.commands.options.CollectionFindAndRerankOptions;
+import com.datastax.astra.client.collections.commands.options.CollectionFindOneAndDeleteOptions;
+import com.datastax.astra.client.collections.commands.options.CollectionFindOneAndReplaceOptions;
+import com.datastax.astra.client.collections.commands.options.CollectionFindOneAndUpdateOptions;
+import com.datastax.astra.client.collections.commands.options.CollectionFindOneOptions;
+import com.datastax.astra.client.collections.commands.options.CollectionFindOptions;
+import com.datastax.astra.client.collections.commands.options.CollectionInsertManyOptions;
+import com.datastax.astra.client.collections.commands.options.CollectionInsertOneOptions;
+import com.datastax.astra.client.collections.commands.options.CollectionReplaceOneOptions;
+import com.datastax.astra.client.collections.commands.options.CollectionUpdateManyOptions;
+import com.datastax.astra.client.collections.commands.options.CollectionUpdateOneOptions;
+import com.datastax.astra.client.collections.commands.options.CountDocumentsOptions;
+import com.datastax.astra.client.collections.commands.options.EstimatedCountDocumentsOptions;
+import com.datastax.astra.client.collections.commands.results.CollectionDeleteResult;
+import com.datastax.astra.client.collections.commands.results.CollectionInsertManyResult;
+import com.datastax.astra.client.collections.commands.results.CollectionInsertOneResult;
+import com.datastax.astra.client.collections.commands.results.CollectionUpdateResult;
+import com.datastax.astra.client.collections.commands.results.FindOneAndReplaceResult;
+import com.datastax.astra.client.collections.definition.CollectionDefaultIdTypes;
+import com.datastax.astra.client.collections.definition.CollectionDefinition;
+import com.datastax.astra.client.collections.definition.CollectionDescriptor;
+import com.datastax.astra.client.collections.definition.documents.Document;
+import com.datastax.astra.client.collections.definition.documents.types.ObjectId;
+import com.datastax.astra.client.collections.definition.documents.types.UUIDv6;
+import com.datastax.astra.client.collections.definition.documents.types.UUIDv7;
import com.datastax.astra.client.collections.exceptions.TooManyDocumentsToCountException;
-import com.datastax.astra.client.collections.options.CollectionDeleteManyOptions;
-import com.datastax.astra.client.collections.options.CollectionDeleteOneOptions;
-import com.datastax.astra.client.collections.options.CollectionFindOneAndDeleteOptions;
-import com.datastax.astra.client.collections.options.CollectionFindOneAndReplaceOptions;
-import com.datastax.astra.client.collections.options.CollectionFindOneAndUpdateOptions;
-import com.datastax.astra.client.collections.options.CollectionFindOneOptions;
-import com.datastax.astra.client.collections.options.CollectionFindOptions;
-import com.datastax.astra.client.collections.options.CollectionInsertManyOptions;
-import com.datastax.astra.client.collections.options.CollectionInsertOneOptions;
-import com.datastax.astra.client.collections.options.CollectionReplaceOneOptions;
-import com.datastax.astra.client.collections.options.CollectionUpdateManyOptions;
-import com.datastax.astra.client.collections.options.CountDocumentsOptions;
-import com.datastax.astra.client.collections.options.EstimatedCountDocumentsOptions;
-import com.datastax.astra.client.collections.options.UpdateOneOptions;
-import com.datastax.astra.client.collections.results.CollectionDeleteResult;
-import com.datastax.astra.client.collections.results.CollectionInsertManyResult;
-import com.datastax.astra.client.collections.results.CollectionInsertOneResult;
-import com.datastax.astra.client.collections.results.CollectionUpdateResult;
-import com.datastax.astra.client.collections.results.FindOneAndReplaceResult;
-import com.datastax.astra.client.core.commands.BaseOptions;
+import com.datastax.astra.client.core.DataAPIKeywords;
import com.datastax.astra.client.core.commands.Command;
-import com.datastax.astra.client.core.paging.CollectionCursor;
-import com.datastax.astra.client.core.paging.CollectionDistinctIterable;
-import com.datastax.astra.client.core.paging.FindIterable;
+import com.datastax.astra.client.core.options.BaseOptions;
import com.datastax.astra.client.core.paging.Page;
import com.datastax.astra.client.core.query.Filter;
import com.datastax.astra.client.core.query.Filters;
-import com.datastax.astra.client.core.types.DataAPIKeywords;
-import com.datastax.astra.client.core.types.ObjectId;
-import com.datastax.astra.client.core.types.UUIDv6;
-import com.datastax.astra.client.core.types.UUIDv7;
+import com.datastax.astra.client.core.query.Projection;
+import com.datastax.astra.client.core.rerank.RerankResult;
+import com.datastax.astra.client.core.vector.DataAPIVector;
import com.datastax.astra.client.databases.Database;
-import com.datastax.astra.client.exception.DataAPIException;
-import com.datastax.astra.client.exception.UnexpectedDataAPIResponseException;
+import com.datastax.astra.client.exceptions.DataAPIException;
+import com.datastax.astra.client.exceptions.UnexpectedDataAPIResponseException;
+import com.datastax.astra.client.tables.commands.options.TableDistinctOptions;
import com.datastax.astra.internal.api.DataAPIResponse;
import com.datastax.astra.internal.api.DataAPIStatus;
import com.datastax.astra.internal.command.AbstractCommandRunner;
import com.datastax.astra.internal.serdes.DataAPISerializer;
import com.datastax.astra.internal.serdes.collections.DocumentSerializer;
import com.datastax.astra.internal.utils.Assert;
+import com.datastax.astra.internal.utils.BetaPreview;
+import com.datastax.astra.internal.utils.EscapeUtils;
import lombok.Getter;
import lombok.extern.slf4j.Slf4j;
+import java.time.Duration;
import java.time.Instant;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import java.util.Optional;
+import java.util.Set;
import java.util.UUID;
import java.util.concurrent.Callable;
import java.util.concurrent.CompletableFuture;
@@ -84,12 +95,12 @@
import java.util.concurrent.TimeoutException;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.stream.Collectors;
+import java.util.stream.StreamSupport;
import static com.datastax.astra.client.core.options.DataAPIClientOptions.MAX_CHUNK_SIZE;
import static com.datastax.astra.client.core.options.DataAPIClientOptions.MAX_COUNT;
-import static com.datastax.astra.client.core.types.DataAPIKeywords.SORT_VECTOR;
-import static com.datastax.astra.client.exception.DataAPIException.ERROR_CODE_INTERRUPTED;
-import static com.datastax.astra.client.exception.DataAPIException.ERROR_CODE_TIMEOUT;
+import static com.datastax.astra.client.exceptions.DataAPIException.ERROR_CODE_INTERRUPTED;
+import static com.datastax.astra.client.exceptions.DataAPIException.ERROR_CODE_TIMEOUT;
import static com.datastax.astra.internal.utils.AnsiUtils.cyan;
import static com.datastax.astra.internal.utils.AnsiUtils.green;
import static com.datastax.astra.internal.utils.AnsiUtils.magenta;
@@ -171,6 +182,7 @@ public class CollectionExample usage:
*
@@ -193,6 +205,9 @@ public Collection(Database db, String collectionName, CollectionOptions collecti
this.collectionName = collectionName;
this.documentClass = documentClass;
this.options.serializer(new DocumentSerializer());
+ if (collectionOptions.getKeyspace() != null) {
+ this.database.useKeyspace(collectionOptions.getKeyspace());
+ }
}
// ----------------------------
@@ -775,8 +790,8 @@ private Callable getInsertManyResultCallable(List getInsertManyResultCallable(List findOne(Filter filter, CollectionFindOneOptions findOneOption
.withSort(findOneOptions.getSortArray())
.withProjection(findOneOptions.getProjectionArray())
.withOptions(new Document()
- .appendIfNotNull(INPUT_INCLUDE_SIMILARITY, findOneOptions.includeSimilarity())
- .appendIfNotNull(INPUT_INCLUDE_SORT_VECTOR, findOneOptions.includeSortVector())
+ .appendIfNotNull(OPTIONS_INCLUDE_SIMILARITY, findOneOptions.includeSimilarity())
+ .appendIfNotNull(OPTIONS_INCLUDE_SORT_VECTOR, findOneOptions.includeSortVector())
);
- return Optional.ofNullable(
- runCommand(findOne, findOneOptions)
- .getData().getDocument()
- .map(getDocumentClass()));
+ return Optional
+ // Get document first
+ .ofNullable(runCommand(findOne, findOneOptions).getData().getDocument())
+ // Map only if present
+ .map(doc -> doc.map(getDocumentClass()));
}
/**
@@ -958,24 +974,6 @@ public CompletableFuture> findOneASync(Filter filter, CollectionFind
return CompletableFuture.supplyAsync(() -> findOne(filter, findOneOptions));
}
-
- /**
- * Retrieves all documents in the collection.
- *
- * This method returns an iterable interface that allows iterating over all documents in the collection,
- * without applying any filters. It leverages the default {@link CollectionFindOptions} for query execution.
- *
- *
- * @return A {@link FindIterable} for iterating over all documents in the collection.
- */
- public FindIterable findAll() {
- return find(null, new CollectionFindOptions());
- }
-
- public CollectionCursor findAllWithCursor() {
- return new CollectionCursor(this, null, new CollectionFindOptions());
- }
-
/**
* Retrieves a document by its identifier from the collection.
*
@@ -992,16 +990,38 @@ public Optional findById(Object id) {
return findOne(Filters.eq(id));
}
+ // -------------------------
+ // --- find ----
+ // -------------------------
+
+ /**
+ * Finds all documents in the collection.
+ *
+ * @param filter
+ * the query filter
+ * @param options
+ * options of find one
+ * @return
+ * the find iterable interface
+ */
+ public CollectionFindCursor find(Filter filter, CollectionFindOptions options) {
+ return new CollectionFindCursor<>(this, filter, options, getDocumentClass());
+ }
+
/**
* Finds all documents in the collection.
*
* @param filter
* the query filter
+ * @param options
+ * options of find one
+ * @param newDocType
+ * new class for return objects if projected
* @return
* the find iterable interface
*/
- public FindIterable find(Filter filter) {
- return find(filter, new CollectionFindOptions());
+ public CollectionFindCursor find(Filter filter, CollectionFindOptions options, Class newDocType) {
+ return new CollectionFindCursor<>(this, filter, options, newDocType);
}
/**
@@ -1009,24 +1029,138 @@ public FindIterable find(Filter filter) {
*
* @param filter
* the query filter
+ * @return
+ * the find iterable interface
+ */
+ public CollectionFindCursor find(Filter filter) {
+ return new CollectionFindCursor<>(this, filter, new CollectionFindOptions(), getDocumentClass());
+ }
+
+ /**
+ * Finds all documents in the collection.
+ *
* @param options
* options of find one
* @return
* the find iterable interface
*/
- public FindIterable find(Filter filter, CollectionFindOptions options) {
- return new FindIterable<>(this, filter, options);
+ public CollectionFindCursor find(CollectionFindOptions options) {
+ return new CollectionFindCursor<>(this, null, options, getDocumentClass());
+ }
+
+ /**
+ * Retrieves all documents in the collection.
+ *
+ * This method returns an iterable interface that allows iterating over all documents in the collection,
+ * without applying any filters. It leverages the default {@link CollectionFindOptions} for query execution.
+ *
+ *
+ * @return A {@link CollectionFindCursor} for iterating over all documents in the collection.
+ */
+ public CollectionFindCursor findAll() {
+ return find(null, new CollectionFindOptions());
+ }
+
+ public Page findPage(Filter filter, CollectionFindOptions options) {
+ return findPage(filter, options, getDocumentClass());
}
+
+ // -----------------------------
+ // --- Find and Rerank ----
+ // -----------------------------
+
/**
* Finds all documents in the collection.
+ *
* @param options
* options of find one
* @return
* the find iterable interface
*/
- public FindIterable find(CollectionFindOptions options) {
- return find(null, options);
+ @BetaPreview
+ public CollectionFindAndRerankCursor findAndRerank(CollectionFindAndRerankOptions options) {
+ return findAndRerank(null, options, getDocumentClass());
+ }
+
+ /**
+ * Finds all documents in the collection.
+ *
+ * @param filter
+ * the query filter
+ * @param options
+ * options of find one
+ * @return
+ * the find iterable interface
+ */
+ @BetaPreview
+ public CollectionFindAndRerankCursor findAndRerank(Filter filter, CollectionFindAndRerankOptions options) {
+ return findAndRerank(filter, options, getDocumentClass());
+ }
+
+ @BetaPreview
+ public CollectionFindAndRerankCursor findAndRerank(Filter filter, CollectionFindAndRerankOptions options, Class newRowType) {
+ return new CollectionFindAndRerankCursor<>(this, filter, options, newRowType);
+ }
+
+
+ @BetaPreview
+ public Page> findAndRerankPage(Filter filter, CollectionFindAndRerankOptions options, Class newRowType) {
+ Command findAndRerankCommand = Command
+ .create("findAndRerank")
+ .withFilter(filter);
+ if (options != null) {
+ findAndRerankCommand
+ .withSort(options.getSortArray())
+ .withProjection(options.getProjectionArray())
+ .withOptions(new Document()
+ .appendIfNotNull(OPTIONS_RERANK_QUERY, options.rerankQuery())
+ .appendIfNotNull(OPTIONS_RERANK_ON, options.rerankOn())
+ .appendIfNotNull(OPTIONS_LIMIT, options.limit())
+ .appendIfNotNull(OPTIONS_HYBRID_LIMITS, options.hybridLimits())
+ .appendIfNotNull(OPTIONS_INCLUDE_SORT_VECTOR, options.includeSortVector())
+ .appendIfNotNull(OPTIONS_INCLUDE_SCORES, options.includeScores())
+ );
+ }
+
+ // Responses MOCK for now
+ DataAPIResponse apiResponse = runCommand(findAndRerankCommand, options);
+
+ // load sortVector if available
+ DataAPIVector sortVector = null;
+ if (options != null && options.includeSortVector() != null && apiResponse.getStatus() != null) {
+ sortVector = apiResponse.getStatus().getSortVector();
+ }
+
+ List> results = new ArrayList<>();
+ List documents = apiResponse.getData().getDocuments();
+ List documentResponses = apiResponse.getStatus().getDocumentResponses();
+ if (documents == null || documentResponses == null) {
+ throw new UnexpectedDataAPIResponseException(findAndRerankCommand,
+ apiResponse, "Documents or Documents reponses are not retuned");
+ }
+ if (documents.size() != documentResponses.size()) {
+ throw new UnexpectedDataAPIResponseException(findAndRerankCommand,
+ apiResponse, "Documents or Documents responses do not match");
+ }
+
+ for(int i = 0; i < documents.size(); i++) {
+
+ // Getting document and projecting as expected
+ Document document = documents.get(i);
+
+ // MAP WITH DOCUMENT FUNCTION
+ DocumentSerializer serializer = new DocumentSerializer();
+ R results1 = serializer.convertValue(document, newRowType);
+
+ // Getting associated document response
+ Document documentResponse = documentResponses.get(i);
+ Map scores = documentResponse.getMap("scores", String.class, Double.class);
+
+ results.add(new RerankResult<>(results1, scores));
+ }
+ // PageState is always NULL
+ return new Page<>(null, results, sortVector);
}
/**
@@ -1051,33 +1185,31 @@ public FindIterable find(CollectionFindOptions options) {
* @param options The {@link CollectionFindOptions} providing additional query parameters, such as sorting and pagination.
* @return A {@link Page} object containing the documents that match the query, along with pagination information.
*/
- public Page findPage(Filter filter, CollectionFindOptions options) {
+ public Page findPage(Filter filter, CollectionFindOptions options, Class newRowType) {
Command findCommand = Command
.create("find")
- .withFilter(filter)
- .withSort(options.getSortArray())
- .withProjection(options.getProjectionArray())
- .withOptions(new Document()
- .appendIfNotNull("skip", options.skip())
- .appendIfNotNull("limit", options.limit())
- .appendIfNotNull(INPUT_PAGE_STATE, options.pageState())
- .appendIfNotNull(INPUT_INCLUDE_SORT_VECTOR, options.includeSortVector())
- .appendIfNotNull(INPUT_INCLUDE_SIMILARITY, options.includeSimilarity()));
+ .withFilter(filter);
+ if (options != null) {
+ findCommand.withSort(options.getSortArray())
+ .withProjection(options.getProjectionArray())
+ .withOptions(new Document()
+ .appendIfNotNull("skip", options.skip())
+ .appendIfNotNull("limit", options.limit())
+ .appendIfNotNull(OPTIONS_PAGE_STATE, options.pageState())
+ .appendIfNotNull(OPTIONS_INCLUDE_SORT_VECTOR, options.includeSortVector())
+ .appendIfNotNull(OPTIONS_INCLUDE_SIMILARITY, options.includeSimilarity()));
+ }
DataAPIResponse apiResponse = runCommand(findCommand, options);
// load sortVector if available
- float[] sortVector = null;
- if (options.includeSortVector() != null &&
- apiResponse.getStatus() != null &&
- apiResponse.getStatus().get(SORT_VECTOR.getKeyword()) != null) {
- sortVector = apiResponse.getStatus().get(SORT_VECTOR.getKeyword(), float[].class);
+ DataAPIVector sortVector = null;
+ if (options != null && options.includeSortVector() != null && apiResponse.getStatus() != null) {
+ sortVector = apiResponse.getStatus().getSortVector();
}
-
return new Page<>(
apiResponse.getData().getNextPageState(),
- apiResponse.getData().getDocuments()
- .stream()
- .map(d -> d.map(getDocumentClass()))
+ apiResponse.getData().getDocuments().stream()
+ .map(d -> d.map(newRowType))
.collect(Collectors.toList()), sortVector);
}
@@ -1107,43 +1239,117 @@ public CompletableFuture> findPageASync(Filter filter, CollectionFindOpt
return CompletableFuture.supplyAsync(() -> findPage(filter, options));
}
- // --------------------------
- // --- Distinct ----
- // --------------------------
+
+ // -------------------------
+ // --- distinct ----
+ // -------------------------
+
+ /**
+ * Return a list of distinct values for the given field name.
+ *
+ * @param fieldPath
+ * chunks of the paths
+ * @param filter
+ * filter to apply
+ * @param resultClass
+ * class of the result
+ * @param
+ * type of the result
+ * @return
+ * list of distinct values
+ */
+ public Set distinct(String[] fieldPath, Filter filter, Class resultClass) {
+ Assert.notNull(fieldPath, "field path");
+ if (fieldPath.length == 0) {
+ throw new IllegalArgumentException("field path must not be empty");
+ }
+ return distinct(EscapeUtils.escapeFieldNames(fieldPath), filter, resultClass, null);
+ }
/**
- * Gets the distinct values of the specified field name.
- * The iteration is performed at CLIENT-SIDE and will exhaust all the collections elements.
+ * Return a list of distinct values for the given field name.
*
* @param fieldName
- * the field name
+ * name of the field
+ * @param filter
+ * filter to apply
* @param resultClass
- * the class to cast any distinct items into.
- * @param
- * the target type of the iterable.
+ * class of the result
+ * @param
+ * type of the result
* @return
- * an iterable of distinct values
+ * list of distinct values
*/
- public CollectionDistinctIterable distinct(String fieldName, Class resultClass) {
- return distinct(fieldName, null, resultClass);
+ public Set distinct(String fieldName, Filter filter, Class resultClass) {
+ return distinct(fieldName, filter, resultClass, null);
}
/**
- * Gets the distinct values of the specified field name.
+ * Return a list of distinct values for the given field name.
+ *
+ * @param fieldPath
+ * segments of the path
+ * @param resultClass
+ * class of the result
+ * @param
+ * type of the result
+ * @return
+ * list of distinct values
+ */
+ public Set distinct(String[] fieldPath, Class resultClass) {
+ Assert.notNull(fieldPath, "field path");
+ if (fieldPath.length == 0) {
+ throw new IllegalArgumentException("field path must not be empty");
+ }
+ return distinct(EscapeUtils.escapeFieldNames(fieldPath), null, resultClass, null);
+ }
+
+ /**
+ * Return a list of distinct values for the given field name.
*
* @param fieldName
- * the field name
+ * name of the field
+ * @param resultClass
+ * class of the result
+ * @param
+ * type of the result
+ * @return
+ * list of distinct values
+ */
+ public Set distinct(String fieldName, Class resultClass) {
+ return distinct(fieldName, null, resultClass, null);
+ }
+
+ /**
+ * Return a list of distinct values for the given field name.
+ *
+ * @param fieldName
+ * name of the field
* @param filter
- * the query filter
+ * filter to apply
* @param resultClass
- * the class to cast any distinct items into.
- * @param
- * the target type of the iterable.
+ * class of the result
+ * @param options
+ * options to apply to the operation
* @return
- * an iterable of distinct values
+ * list of distinct values
+ * @param
+ * type of the result
*/
- public CollectionDistinctIterable distinct(String fieldName, Filter filter, Class resultClass) {
- return new CollectionDistinctIterable<>(this, fieldName, filter, resultClass);
+ public Set distinct(String fieldName, Filter filter, Class resultClass, TableDistinctOptions options) {
+ Assert.hasLength(fieldName, "fieldName");
+ Assert.notNull(resultClass, "resultClass");
+ // Building a convenient find options
+ CollectionFindOptions findOptions = new CollectionFindOptions()
+ .projection(Projection.include( fieldName.replaceAll("\\[\\d+\\]", "")));
+ // Overriding options
+ if (options != null && options.getDataAPIClientOptions() != null) {
+ findOptions.dataAPIClientOptions(options.getDataAPIClientOptions());
+ }
+ // Exhausting the list of distinct values
+ return StreamSupport.stream(find(filter, findOptions, Document.class).spliterator(), true)
+ .map(doc -> doc.get(fieldName, resultClass))
+ .collect(Collectors.toSet());
}
// ----------------------------
@@ -1327,7 +1533,6 @@ public CollectionDeleteResult deleteMany(Filter filter, CollectionDeleteManyOpti
Command deleteMany = Command
.create("deleteMany")
.withFilter(filter);
-
DataAPIResponse apiResponse = runCommand(deleteMany, options);
DataAPIStatus status = apiResponse.getStatus();
if (status != null) {
@@ -1349,7 +1554,8 @@ public CollectionDeleteResult deleteMany(Filter filter, CollectionDeleteManyOpti
* the result of the remove many operation
*/
public CollectionDeleteResult deleteMany(Filter filter) {
- return deleteMany(filter, new CollectionDeleteManyOptions());
+ return deleteMany(filter, new CollectionDeleteManyOptions()
+ .timeout(Duration.ofSeconds(30)));
}
/**
@@ -1425,8 +1631,8 @@ public Optional findOneAndReplace(Filter filter, T replacement, CollectionFin
.withSort(options.getSortArray())
.withProjection(options.getProjectionArray())
.withOptions(new Document()
- .appendIfNotNull(INPUT_UPSERT, options.upsert())
- .appendIfNotNull(INPUT_RETURN_DOCUMENT, options.returnDocument())
+ .appendIfNotNull(OPTIONS_UPSERT, options.upsert())
+ .appendIfNotNull(OPTIONS_RETURN_DOCUMENT, options.returnDocument())
);
DataAPIResponse res = runCommand(findOneAndReplace, options);
@@ -1473,8 +1679,8 @@ public CollectionUpdateResult replaceOne(Filter filter, T replacement, Collectio
.withFilter(filter)
.withReplacement(replacement)
.withOptions(new Document()
- .appendIfNotNull(INPUT_UPSERT, collectionReplaceOneOptions.upsert())
- .append(INPUT_RETURN_DOCUMENT, ReturnDocument.BEFORE.getKey())
+ .appendIfNotNull(OPTIONS_UPSERT, collectionReplaceOneOptions.upsert())
+ .append(OPTIONS_RETURN_DOCUMENT, ReturnDocument.BEFORE.getKey())
);
// Execute the `findOneAndReplace`
@@ -1567,8 +1773,8 @@ public Optional findOneAndUpdate(Filter filter, Update update, CollectionFind
.withSort(options.getSortArray())
.withProjection(options.getProjectionArray())
.withOptions(new Document()
- .appendIfNotNull(INPUT_UPSERT, options.upsert())
- .append(INPUT_RETURN_DOCUMENT, options.returnDocument())
+ .appendIfNotNull(OPTIONS_UPSERT, options.upsert())
+ .append(OPTIONS_RETURN_DOCUMENT, options.returnDocument())
);
DataAPIResponse res = runCommand(cmd, options);
@@ -1592,7 +1798,7 @@ public Optional findOneAndUpdate(Filter filter, Update update, CollectionFind
* the result of the update one operation
*/
public CollectionUpdateResult updateOne(Filter filter, Update update) {
- return updateOne(filter, update, new UpdateOneOptions());
+ return updateOne(filter, update, new CollectionUpdateOneOptions());
}
/**
@@ -1607,7 +1813,7 @@ public CollectionUpdateResult updateOne(Filter filter, Update update) {
* @return
* the result of the update one operation
*/
- public CollectionUpdateResult updateOne(Filter filter, Update update, UpdateOneOptions updateOptions) {
+ public CollectionUpdateResult updateOne(Filter filter, Update update, CollectionUpdateOneOptions updateOptions) {
notNull(update, ARG_UPDATE);
notNull(updateOptions, ARG_OPTIONS);
Command cmd = Command
@@ -1616,7 +1822,7 @@ public CollectionUpdateResult updateOne(Filter filter, Update update, UpdateOneO
.withUpdate(update)
.withSort(updateOptions.getSortArray())
.withOptions(new Document()
- .appendIfNotNull(INPUT_UPSERT, updateOptions.upsert())
+ .appendIfNotNull(OPTIONS_UPSERT, updateOptions.upsert())
);
return getUpdateResult(runCommand(cmd, updateOptions));
}
@@ -1640,7 +1846,7 @@ private static CollectionUpdateResult getUpdateResult(DataAPIResponse apiRespons
result.setModifiedCount(status.getInteger(RESULT_MODIFIED_COUNT));
}
if (status.containsKey(RESULT_UPSERTED_ID)) {
- result.setMatchedCount(status.getInteger(RESULT_UPSERTED_ID));
+ result.setUpsertedId(status.get(RESULT_UPSERTED_ID));
}
}
return result;
@@ -1685,8 +1891,8 @@ public CollectionUpdateResult updateMany(Filter filter, Update update, Collectio
.withFilter(filter)
.withUpdate(update)
.withOptions(new Document()
- .appendIfNotNull(INPUT_UPSERT, options.upsert())
- .appendIfNotNull(INPUT_PAGE_STATE, nextPageState));
+ .appendIfNotNull(OPTIONS_UPSERT, options.upsert())
+ .appendIfNotNull(OPTIONS_PAGE_STATE, nextPageState));
DataAPIResponse res = runCommand(cmd, options);
// Data
if (res.getData() != null) {
@@ -1701,7 +1907,7 @@ public CollectionUpdateResult updateMany(Filter filter, Update update, Collectio
result.setModifiedCount(result.getModifiedCount() + status.getInteger(RESULT_MODIFIED_COUNT));
}
if (status.containsKey(RESULT_UPSERTED_ID)) {
- result.setUpsertedId(status.getInteger(RESULT_UPSERTED_ID));
+ result.setUpsertedId(status.get(RESULT_UPSERTED_ID));
}
} while(nextPageState != null);
return result;
diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/collections/CollectionOptions.java b/astra-db-java/src/main/java/com/datastax/astra/client/collections/CollectionOptions.java
index 93f7d544..a5c0fbe5 100644
--- a/astra-db-java/src/main/java/com/datastax/astra/client/collections/CollectionOptions.java
+++ b/astra-db-java/src/main/java/com/datastax/astra/client/collections/CollectionOptions.java
@@ -20,12 +20,8 @@
* #L%
*/
-import com.datastax.astra.client.core.commands.BaseOptions;
-import com.datastax.astra.client.core.commands.CommandType;
+import com.datastax.astra.client.core.options.BaseOptions;
import com.datastax.astra.client.core.options.DataAPIClientOptions;
-import com.datastax.astra.internal.serdes.collections.DocumentSerializer;
-import com.datastax.astra.internal.utils.Assert;
-import lombok.NoArgsConstructor;
import lombok.Setter;
import lombok.experimental.Accessors;
@@ -39,6 +35,11 @@
@Accessors(fluent = true, chain = true)
public class CollectionOptions extends BaseOptions {
+ /**
+ * The keyspace to use for the database.
+ */
+ String keyspace = DataAPIClientOptions.DEFAULT_KEYSPACE;
+
/**
* Default constructor nor overriding token nor options
* but stilling setting the default timeouts and serializer
@@ -60,4 +61,13 @@ public CollectionOptions(String token, DataAPIClientOptions options) {
super(token, COLLECTION_ADMIN, DEFAULT_COLLECTION_SERIALIZER, options);
}
+ /**
+ * Gets keyspace
+ *
+ * @return value of keyspace
+ */
+ public String getKeyspace() {
+ return keyspace;
+ }
+
}
diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/collections/documents/ReturnDocument.java b/astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/ReturnDocument.java
similarity index 95%
rename from astra-db-java/src/main/java/com/datastax/astra/client/collections/documents/ReturnDocument.java
rename to astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/ReturnDocument.java
index 36337726..5a6f5486 100644
--- a/astra-db-java/src/main/java/com/datastax/astra/client/collections/documents/ReturnDocument.java
+++ b/astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/ReturnDocument.java
@@ -1,4 +1,4 @@
-package com.datastax.astra.client.collections.documents;
+package com.datastax.astra.client.collections.commands;
/*-
* #%L
diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/collections/documents/Update.java b/astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/Update.java
similarity index 96%
rename from astra-db-java/src/main/java/com/datastax/astra/client/collections/documents/Update.java
rename to astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/Update.java
index ac1a852d..c519c5e1 100644
--- a/astra-db-java/src/main/java/com/datastax/astra/client/collections/documents/Update.java
+++ b/astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/Update.java
@@ -1,4 +1,4 @@
-package com.datastax.astra.client.collections.documents;
+package com.datastax.astra.client.collections.commands;
/*-
* #%L
@@ -20,6 +20,8 @@
* #L%
*/
+import com.datastax.astra.client.collections.definition.documents.Document;
+
import java.util.Arrays;
import java.util.HashMap;
import java.util.LinkedHashMap;
@@ -251,7 +253,7 @@ public Update updateMul(Map fields) {
* @return
* reference to self
*/
- public Update updateSetOnInsert(Map fields) {
+ public Update updateSetOnInsert(Map fields) {
fields.forEach((key, value) -> update("$setOnInsert", key, value));
return this;
}
diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/collections/documents/Updates.java b/astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/Updates.java
similarity index 97%
rename from astra-db-java/src/main/java/com/datastax/astra/client/collections/documents/Updates.java
rename to astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/Updates.java
index 67b4e902..0afb215c 100644
--- a/astra-db-java/src/main/java/com/datastax/astra/client/collections/documents/Updates.java
+++ b/astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/Updates.java
@@ -1,4 +1,4 @@
-package com.datastax.astra.client.collections.documents;
+package com.datastax.astra.client.collections.commands;
/*-
* #%L
@@ -105,7 +105,7 @@ public static Update unset(String field) {
* @return
* update object
*/
- public static Update updateSetOnInsert( Map fields) {
+ public static Update updateSetOnInsert( Map fields) {
return new Update().updateSetOnInsert(fields);
}
diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/cursor/CollectionFindAndRerankCursor.java b/astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/cursor/CollectionFindAndRerankCursor.java
new file mode 100644
index 00000000..7c3318fa
--- /dev/null
+++ b/astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/cursor/CollectionFindAndRerankCursor.java
@@ -0,0 +1,219 @@
+package com.datastax.astra.client.collections.commands.cursor;
+
+/*-
+ * #%L
+ * Data API Java Client
+ * --
+ * Copyright (C) 2024 DataStax
+ * --
+ * Licensed under the Apache License, Version 2.0
+ * You may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * #L%
+ */
+
+import com.datastax.astra.client.collections.Collection;
+import com.datastax.astra.client.collections.commands.options.CollectionFindAndRerankOptions;
+import com.datastax.astra.client.core.paging.CursorState;
+import com.datastax.astra.client.core.query.Filter;
+import com.datastax.astra.client.core.query.Projection;
+import com.datastax.astra.client.core.query.Sort;
+import com.datastax.astra.client.core.rerank.RerankResult;
+import com.datastax.astra.internal.command.AbstractCursor;
+import lombok.Getter;
+
+import java.util.ArrayList;
+
+
+/**
+ * Implementation of a cursor across the find items
+ *
+ * @param
+ * working bean of parent table
+ * @param
+ * working bean returned for the find
+ */
+
+/**
+ * Implementation of a cursor across the find items
+ *
+ * @param
+ * working document object
+ * @param
+ * working object for results, should be same as DOC if no projections
+ */
+public class CollectionFindAndRerankCursor extends AbstractCursor> {
+
+ /**
+ * Input table reference
+ */
+ @Getter
+ private final Collection dataSource;
+
+ /**
+ * Input Filter provided.
+ * Immutable as not setter is provided.
+ */
+ private Filter filter;
+
+ /**
+ * Input Find options. Where will change the different options.
+ * Immutable as not setter is provided.
+ */
+ private CollectionFindAndRerankOptions options;
+
+ private Class newRowType;
+
+ /**
+ * Cursor to iterate on the result of a query.
+ *
+ * @param dataSource
+ * source collection
+ * @param filter
+ * current filter
+ * @param options
+ * options of the find operation
+ */
+ @SuppressWarnings("unchecked")
+ public CollectionFindAndRerankCursor(Collection dataSource, Filter filter, CollectionFindAndRerankOptions options, Class recordType) {
+ super((Class>) (Class) RerankResult.class);
+ this.dataSource = dataSource;
+ this.filter = filter;
+ this.options = options;
+ this.state = CursorState.IDLE;
+ this.buffer = new ArrayList<>();
+ this.consumed = 0;
+ this.newRowType = recordType;
+ }
+
+ /**
+ * Constructor by copy. Once cloning the cursor is set back at the beginning.
+ *
+ * @param collectionFindCursor
+ * previous cursor
+ */
+ private CollectionFindAndRerankCursor(CollectionFindAndRerankCursor collectionFindCursor) {
+ super(collectionFindCursor.getRecordType());
+ this.state = CursorState.IDLE;
+ this.buffer = new ArrayList<>();
+ this.dataSource = collectionFindCursor.dataSource;
+ this.options = collectionFindCursor.options;
+ this.filter = collectionFindCursor.filter;
+ this.currentPage = collectionFindCursor.currentPage;
+ this.consumed = collectionFindCursor.consumed;
+ this.recordType = collectionFindCursor.recordType;
+ }
+
+ /** {@inheritDoc} */
+ @Override
+ public CollectionFindAndRerankCursor clone() {
+ return new CollectionFindAndRerankCursor<>(this);
+ }
+
+ /**
+ * Immutable methods that return a new Cursor instance.
+ *
+ * @param newFilter
+ * a new filter
+ * @return
+ * a new cursor
+ */
+ public CollectionFindAndRerankCursor filter(Filter newFilter) {
+ checkIdleState();
+ CollectionFindAndRerankCursor newCursor = this.clone();
+ newCursor.filter = newFilter;
+ return newCursor;
+ }
+
+ /**
+ * Creates a new {@link CollectionFindAndRerankCursor} with an updated projection.
+ *
+ * @param newProjection the new projection to apply
+ * @return a new {@link CollectionFindAndRerankCursor} instance with the specified projection
+ */
+ public CollectionFindAndRerankCursor project(Projection... newProjection) {
+ checkIdleState();
+ CollectionFindAndRerankCursor newCursor = this.clone();
+ newCursor.options.projection(newProjection);
+ return newCursor;
+ }
+
+ /**
+ * Creates a new {@link CollectionFindAndRerankCursor} with a specified sort order.
+ *
+ * @param sort the sort criteria to apply
+ * @return a new {@link CollectionFindAndRerankCursor} instance with the specified sort order
+ */
+ public CollectionFindAndRerankCursor sort(Sort... sort) {
+ checkIdleState();
+ CollectionFindAndRerankCursor newCursor = this.clone();
+ newCursor.options.sort(sort);
+ return newCursor;
+ }
+
+ /**
+ * Creates a new {@link CollectionFindAndRerankCursor} with a specified limit on the number of results.
+ *
+ * @param newLimit the maximum number of results to retrieve
+ * @return a new {@link CollectionFindAndRerankCursor} instance with the specified limit
+ */
+ public CollectionFindAndRerankCursor limit(int newLimit) {
+ checkIdleState();
+ CollectionFindAndRerankCursor newCursor = this.clone();
+ newCursor.limit(newLimit);
+ return newCursor;
+ }
+
+ /**
+ * Creates a new {@link CollectionFindAndRerankCursor} that includes similarity scores in the results.
+ *
+ * @return a new {@link CollectionFindAndRerankCursor} instance with similarity scores included
+ */
+ public CollectionFindAndRerankCursor includeSimilarity() {
+ checkIdleState();
+ CollectionFindAndRerankCursor newCursor = this.clone();
+ newCursor.includeSimilarity();
+ return newCursor;
+ }
+
+ /**
+ * Creates a new {@link CollectionFindAndRerankCursor} that includes sort vector metadata in the results.
+ *
+ * @return a new {@link CollectionFindAndRerankCursor} instance with sort vector metadata included
+ */
+ public CollectionFindAndRerankCursor includeSortVector() {
+ checkIdleState();
+ CollectionFindAndRerankCursor newCursor = this.clone();
+ newCursor.includeSortVector();
+ return newCursor;
+ }
+
+ /**
+ * {PageState is always null, all is returned here }
+ */
+ public void fetchNextBatch() {
+ // Only the first time
+ if (currentPage == null) {
+ currentPage = dataSource.findAndRerankPage(filter, options, newRowType);
+ buffer.addAll(currentPage.getResults());
+ }
+ }
+
+ /**
+ * Retrieve keyspace name.
+ *
+ * @return
+ * keyspace name
+ */
+ public String getKeyspace() {
+ return dataSource.getKeyspaceName();
+ }
+}
\ No newline at end of file
diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/cursor/CollectionFindCursor.java b/astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/cursor/CollectionFindCursor.java
new file mode 100644
index 00000000..788cf11f
--- /dev/null
+++ b/astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/cursor/CollectionFindCursor.java
@@ -0,0 +1,238 @@
+package com.datastax.astra.client.collections.commands.cursor;
+
+/*-
+ * #%L
+ * Data API Java Client
+ * --
+ * Copyright (C) 2024 DataStax
+ * --
+ * Licensed under the Apache License, Version 2.0
+ * You may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * #L%
+ */
+
+import com.datastax.astra.client.collections.Collection;
+import com.datastax.astra.client.collections.commands.options.CollectionFindOptions;
+import com.datastax.astra.client.collections.definition.documents.Document;
+import com.datastax.astra.client.core.paging.CursorState;
+import com.datastax.astra.client.core.query.Filter;
+import com.datastax.astra.client.core.query.Projection;
+import com.datastax.astra.client.core.query.Sort;
+import com.datastax.astra.client.tables.definition.rows.Row;
+import com.datastax.astra.internal.command.AbstractCursor;
+import com.datastax.astra.internal.serdes.tables.RowMapper;
+import lombok.Getter;
+
+import java.util.*;
+
+
+/**
+ * Implementation of a cursor across the find items
+ *
+ * @param
+ * working bean of parent table
+ * @param
+ * working bean returned for the find
+ */
+
+/**
+ * Implementation of a cursor across the find items
+ *
+ * @param
+ * working document object
+ * @param
+ * working object for results, should be same as DOC if no projections
+ */
+public class CollectionFindCursor extends AbstractCursor {
+
+ /**
+ * Input table reference
+ */
+ @Getter
+ private final Collection dataSource;
+
+ /**
+ * Input Filter provided.
+ * Immutable as not setter is provided.
+ */
+ private Filter filter;
+
+ /**
+ * Input Find options. Where will change the different options.
+ * Immutable as not setter is provided.
+ */
+ private CollectionFindOptions collectionFindOptions;
+
+ /**
+ * Cursor to iterate on the result of a query.
+ *
+ * @param dataSource
+ * source collection
+ * @param filter
+ * current filter
+ * @param options
+ * options of the find operation
+ * @param documentType
+ * row type returned with the cursor
+ */
+ public CollectionFindCursor(Collection dataSource, Filter filter, CollectionFindOptions options, Class documentType) {
+ super(documentType);
+ this.dataSource = dataSource;
+ this.filter = filter;
+ this.collectionFindOptions = options;
+ this.state = CursorState.IDLE;
+ this.buffer = new ArrayList<>();
+ this.consumed = 0;
+ }
+
+ /**
+ * Constructor by copy. Once cloning the cursor is set back at the beginning.
+ *
+ * @param collectionFindCursor
+ * previous cursor
+ */
+ private CollectionFindCursor(CollectionFindCursor collectionFindCursor) {
+ super(collectionFindCursor.getRecordType());
+ this.state = CursorState.IDLE;
+ this.buffer = new ArrayList<>();
+ this.dataSource = collectionFindCursor.dataSource;
+ this.collectionFindOptions = collectionFindCursor.collectionFindOptions;
+ this.filter = collectionFindCursor.filter;
+ this.currentPage = collectionFindCursor.currentPage;
+ this.consumed = collectionFindCursor.consumed;
+ this.recordType = collectionFindCursor.recordType;
+ }
+
+ /** {@inheritDoc} */
+ @Override
+ public CollectionFindCursor clone() {
+ return new CollectionFindCursor<>(this);
+ }
+
+ /**
+ * Immutable methods that return a new Cursor instance.
+ *
+ * @param newFilter
+ * a new filter
+ * @return
+ * a new cursor
+ */
+ public CollectionFindCursor filter(Filter newFilter) {
+ checkIdleState();
+ CollectionFindCursor newCursor = this.clone();
+ newCursor.filter = newFilter;
+ return newCursor;
+ }
+
+ /**
+ * Creates a new {@link CollectionFindCursor} with an updated projection.
+ *
+ * @param newProjection the new projection to apply
+ * @return a new {@link CollectionFindCursor} instance with the specified projection
+ */
+ public CollectionFindCursor project(Projection... newProjection) {
+ checkIdleState();
+ CollectionFindCursor newCursor = this.clone();
+ newCursor.collectionFindOptions.projection(newProjection);
+ return newCursor;
+ }
+
+ /**
+ * Creates a new {@link CollectionFindCursor} with a specified sort order.
+ *
+ * @param sort the sort criteria to apply
+ * @return a new {@link CollectionFindCursor} instance with the specified sort order
+ */
+ public CollectionFindCursor sort(Sort... sort) {
+ checkIdleState();
+ CollectionFindCursor newCursor = this.clone();
+ newCursor.collectionFindOptions.sort(sort);
+ return newCursor;
+ }
+
+ /**
+ * Creates a new {@link CollectionFindCursor} with a specified limit on the number of results.
+ *
+ * @param newLimit the maximum number of results to retrieve
+ * @return a new {@link CollectionFindCursor} instance with the specified limit
+ */
+ public CollectionFindCursor limit(int newLimit) {
+ checkIdleState();
+ CollectionFindCursor newCursor = this.clone();
+ newCursor.limit(newLimit);
+ return newCursor;
+ }
+
+ /**
+ * Creates a new {@link CollectionFindCursor} that skips a specified number of results.
+ *
+ * @param newSkip the number of results to skip
+ * @return a new {@link CollectionFindCursor} instance with the specified skip value
+ */
+ public CollectionFindCursor skip(int newSkip) {
+ checkIdleState();
+ CollectionFindCursor newCursor = this.clone();
+ newCursor.skip(newSkip);
+ return newCursor;
+ }
+
+ /**
+ * Creates a new {@link CollectionFindCursor} that includes similarity scores in the results.
+ *
+ * @return a new {@link CollectionFindCursor} instance with similarity scores included
+ */
+ public CollectionFindCursor includeSimilarity() {
+ checkIdleState();
+ CollectionFindCursor newCursor = this.clone();
+ newCursor.includeSimilarity();
+ return newCursor;
+ }
+
+ /**
+ * Creates a new {@link CollectionFindCursor} that includes sort vector metadata in the results.
+ *
+ * @return a new {@link CollectionFindCursor} instance with sort vector metadata included
+ */
+ public CollectionFindCursor includeSortVector() {
+ checkIdleState();
+ CollectionFindCursor newCursor = this.clone();
+ newCursor.includeSortVector();
+ return newCursor;
+ }
+
+ /**
+ * Fetches the next batch of documents into the buffer.
+ * This method handles paging, using the page state from the previous batch to fetch the next one.
+ */
+ public void fetchNextBatch() {
+ if (currentPage == null) {
+ // Searching First Page
+ currentPage = dataSource.findPage(filter, collectionFindOptions, getRecordType());
+ buffer.addAll(currentPage.getResults());
+ } else if (currentPage.getPageState().isPresent()) {
+ // Searching next page if exist
+ collectionFindOptions.pageState(currentPage.getPageState().get());
+ currentPage = dataSource.findPage(filter, collectionFindOptions, getRecordType());
+ buffer.addAll(currentPage.getResults());
+ }
+ }
+
+ /**
+ * Retrieve keyspace name.
+ *
+ * @return
+ * keyspace name
+ */
+ public String getKeyspace() {
+ return dataSource.getKeyspaceName();
+ }
+}
\ No newline at end of file
diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/cursor/package-info.java b/astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/cursor/package-info.java
new file mode 100644
index 00000000..bec259f4
--- /dev/null
+++ b/astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/cursor/package-info.java
@@ -0,0 +1,24 @@
+/**
+ * Objects representing cursors working with find collection commands.
+ */
+package com.datastax.astra.client.collections.commands.cursor;
+
+/*-
+ * #%L
+ * Data API Java Client
+ * --
+ * Copyright (C) 2024 DataStax
+ * --
+ * Licensed under the Apache License, Version 2.0
+ * You may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * #L%
+ */
diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/collections/options/CollectionDeleteManyOptions.java b/astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/options/CollectionDeleteManyOptions.java
similarity index 76%
rename from astra-db-java/src/main/java/com/datastax/astra/client/collections/options/CollectionDeleteManyOptions.java
rename to astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/options/CollectionDeleteManyOptions.java
index fe53d8bf..f97c9b23 100644
--- a/astra-db-java/src/main/java/com/datastax/astra/client/collections/options/CollectionDeleteManyOptions.java
+++ b/astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/options/CollectionDeleteManyOptions.java
@@ -1,4 +1,4 @@
-package com.datastax.astra.client.collections.options;
+package com.datastax.astra.client.collections.commands.options;
/*-
* #%L
@@ -9,9 +9,9 @@
* Licensed under the Apache License, Version 2.0
* You may not use this file except in compliance with the License.
* You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -20,7 +20,7 @@
* #L%
*/
-import com.datastax.astra.client.core.commands.BaseOptions;
+import com.datastax.astra.client.core.options.BaseOptions;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;
@@ -29,7 +29,14 @@
/**
* Options to delete many documents.
*/
-@Getter @Setter
-@NoArgsConstructor
+@Getter
+@Setter
@Accessors(fluent = true, chain = true)
-public class CollectionDeleteManyOptions extends BaseOptions {}
+public class CollectionDeleteManyOptions extends BaseOptions {
+
+ /**
+ * Default constructor.
+ */
+ public CollectionDeleteManyOptions() {
+ }
+}
diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/collections/options/CollectionDeleteOneOptions.java b/astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/options/CollectionDeleteOneOptions.java
similarity index 85%
rename from astra-db-java/src/main/java/com/datastax/astra/client/collections/options/CollectionDeleteOneOptions.java
rename to astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/options/CollectionDeleteOneOptions.java
index d687444d..5357def8 100644
--- a/astra-db-java/src/main/java/com/datastax/astra/client/collections/options/CollectionDeleteOneOptions.java
+++ b/astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/options/CollectionDeleteOneOptions.java
@@ -1,4 +1,4 @@
-package com.datastax.astra.client.collections.options;
+package com.datastax.astra.client.collections.commands.options;
/*-
* #%L
@@ -20,19 +20,24 @@
* #L%
*/
-import com.datastax.astra.client.core.commands.BaseOptions;
+import com.datastax.astra.client.core.options.BaseOptions;
import com.datastax.astra.client.core.query.Sort;
import lombok.NoArgsConstructor;
/**
* Options to delete One document.
*/
-@NoArgsConstructor
public class CollectionDeleteOneOptions extends BaseOptions {
/** Sort List. */
Sort[] sort;
+ /**
+ * Default constructor.
+ */
+ public CollectionDeleteOneOptions() {
+ }
+
/**
* Adding this on top of sort(Sort[] s) to allow for a more fluent API.
* @param s
diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/options/CollectionFindAndRerankOptions.java b/astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/options/CollectionFindAndRerankOptions.java
new file mode 100644
index 00000000..0344cdf3
--- /dev/null
+++ b/astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/options/CollectionFindAndRerankOptions.java
@@ -0,0 +1,197 @@
+package com.datastax.astra.client.collections.commands.options;
+
+/*-
+ * #%L
+ * Data API Java Client
+ * --
+ * Copyright (C) 2024 DataStax
+ * --
+ * Licensed under the Apache License, Version 2.0
+ * You may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * #L%
+ */
+
+import com.datastax.astra.client.core.commands.CommandType;
+import com.datastax.astra.client.core.hybrid.Hybrid;
+import com.datastax.astra.client.core.hybrid.HybridLimits;
+import com.datastax.astra.client.core.options.BaseOptions;
+import com.datastax.astra.client.core.query.Projection;
+import com.datastax.astra.client.core.query.Sort;
+import lombok.Getter;
+import lombok.Setter;
+import lombok.experimental.Accessors;
+
+import java.util.Map;
+
+import static com.datastax.astra.client.collections.Collection.DEFAULT_COLLECTION_SERIALIZER;
+
+/**
+ * List Options for a FindOne command.
+ */
+@Getter @Setter
+@Accessors(fluent = true, chain = true)
+public class CollectionFindAndRerankOptions extends BaseOptions {
+
+ /**
+ * Order by.
+ */
+ Sort[] sort;
+
+ /**
+ * Projection for return document (select)
+ */
+ Projection[] projection;
+
+ /**
+ * Skip a few result in the beginning
+ */
+ HybridLimits hybridLimits;
+
+ /**
+ * Stop processing after a few results
+ */
+ Integer limit;
+
+ /**
+ * Options for Rerank on.
+ */
+ String rerankOn;
+
+ /**
+ * Rerank Query.
+ */
+ String rerankQuery;
+
+ /**
+ * Options for hybrid projection
+ */
+ Boolean includeScores;
+
+ /**
+ * Flag to include sortVector in the result when operating a semantic search.
+ */
+ Boolean includeSortVector;
+
+ /**
+ * Default constructor.
+ */
+ public CollectionFindAndRerankOptions() {
+ super(null, CommandType.GENERAL_METHOD, DEFAULT_COLLECTION_SERIALIZER, null);
+ }
+
+ /**
+ * Adding this on top of sort(Sort[] s) to allow for a more fluent API.
+ *
+ * @param hybrid
+ * hybrid
+ * @return
+ * current command
+ */
+ public CollectionFindAndRerankOptions hybridSort(Hybrid hybrid) {
+ return sort(Sort.hybrid(hybrid));
+ }
+
+ /**
+ * Adding this on top of sort(Sort[] s) to allow for a more fluent API.
+ *
+ * @param sorts
+ * sorts criteria
+ * @return
+ * current command
+ */
+ public CollectionFindAndRerankOptions sort(Sort... sorts) {
+ this.sort = sorts;
+ return this;
+ }
+
+ public Sort[] getSortArray() {
+ return this.sort;
+ }
+
+ /**
+ * Adding this on top of sort(Sort[] s) to allow for a more fluent API.
+ *
+ * @return
+ * project
+ */
+ public Projection[] getProjectionArray() {
+ return projection;
+ }
+
+ /**
+ * Adding this on top of projection(Projection[] p) to allow for a more fluent API.
+ * @param p
+ * projection options
+ * @return
+ * current command
+ */
+ public CollectionFindAndRerankOptions projection(Projection... p) {
+ this.projection = p;
+ return this;
+ }
+
+ /**
+ * Add a limit clause in the find block
+ *
+ * @param limit value for limit options
+ * @return current command
+ */
+ public CollectionFindAndRerankOptions limit(int limit) {
+ if (limit < 0) {
+ throw new IllegalArgumentException("Limit must be positive");
+ }
+ this.limit = limit;
+ return this;
+ }
+
+ /**
+ * Add a hybridLimits clause in the find block
+ *
+ * @param hybridLimits value for limit options
+ * @return current command
+ */
+ public CollectionFindAndRerankOptions hybridLimits(int hybridLimits) {
+ if (limit < 0) {
+ throw new IllegalArgumentException("HybridLimits must be positive");
+ }
+ this.hybridLimits = new HybridLimits(hybridLimits);
+ return this;
+ }
+
+ /**
+ * Add a hybridLimits clause in the find block
+ *
+ * @param hybridMapLimits value for limit options
+ * @return current command
+ */
+ public CollectionFindAndRerankOptions hybridLimits(Map hybridMapLimits) {
+ this.hybridLimits = new HybridLimits(hybridMapLimits);
+ return this;
+ }
+
+ /**
+ * Add a rerankOn clause in the find block
+ *
+ * @param rerankOn value for rerankOn options
+ * @return current command
+ */
+ public CollectionFindAndRerankOptions rerankOn(String rerankOn) {
+ this.rerankOn = rerankOn;
+ return this;
+ }
+
+
+ public CollectionFindAndRerankOptions rerankQuery(String $lexical) {
+ this.rerankQuery = rerankOn;
+ return this;
+ }
+}
diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/collections/options/CollectionFindOneAndDeleteOptions.java b/astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/options/CollectionFindOneAndDeleteOptions.java
similarity index 89%
rename from astra-db-java/src/main/java/com/datastax/astra/client/collections/options/CollectionFindOneAndDeleteOptions.java
rename to astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/options/CollectionFindOneAndDeleteOptions.java
index 46d40b19..85f1984a 100644
--- a/astra-db-java/src/main/java/com/datastax/astra/client/collections/options/CollectionFindOneAndDeleteOptions.java
+++ b/astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/options/CollectionFindOneAndDeleteOptions.java
@@ -1,4 +1,4 @@
-package com.datastax.astra.client.collections.options;
+package com.datastax.astra.client.collections.commands.options;
/*-
* #%L
@@ -20,7 +20,7 @@
* #L%
*/
-import com.datastax.astra.client.core.commands.BaseOptions;
+import com.datastax.astra.client.core.options.BaseOptions;
import com.datastax.astra.client.core.query.Projection;
import com.datastax.astra.client.core.query.Sort;
import lombok.NoArgsConstructor;
@@ -28,7 +28,6 @@
/**
* Options to find one and delete.
*/
-@NoArgsConstructor
public class CollectionFindOneAndDeleteOptions extends BaseOptions {
/** Order by. */
@@ -37,6 +36,12 @@ public class CollectionFindOneAndDeleteOptions extends BaseOptions {
@@ -57,6 +55,12 @@ public class CollectionFindOneAndReplaceOptions extends BaseOptions {
@@ -58,6 +57,12 @@ public class CollectionFindOneAndUpdateOptions extends BaseOptions {
@@ -56,6 +55,12 @@ public class CollectionFindOneOptions extends BaseOptions {
/**
- * Order by.
+ * Projection for return document (select)
*/
- Sort[] sort;
+ Projection[] projection;
/**
- * Projection for return document (select)
+ * Order by.
*/
- Projection[] projection;
+ Sort[] sort;
/**
* Skip a few result in the beginning
@@ -71,6 +75,13 @@ public class CollectionFindOptions extends BaseOptions {
*/
private String pageState;
+ /**
+ * Default constructor.
+ */
+ public CollectionFindOptions() {
+ super(null, CommandType.GENERAL_METHOD, DEFAULT_COLLECTION_SERIALIZER, null);
+ }
+
/**
* Get the sort options.
*
diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/collections/options/CollectionInsertManyOptions.java b/astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/options/CollectionInsertManyOptions.java
similarity index 93%
rename from astra-db-java/src/main/java/com/datastax/astra/client/collections/options/CollectionInsertManyOptions.java
rename to astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/options/CollectionInsertManyOptions.java
index f7ad0041..93c48a20 100644
--- a/astra-db-java/src/main/java/com/datastax/astra/client/collections/options/CollectionInsertManyOptions.java
+++ b/astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/options/CollectionInsertManyOptions.java
@@ -1,4 +1,4 @@
-package com.datastax.astra.client.collections.options;
+package com.datastax.astra.client.collections.commands.options;
/*-
* #%L
@@ -21,7 +21,7 @@
*/
import com.datastax.astra.client.core.options.DataAPIClientOptions;
-import com.datastax.astra.client.core.commands.BaseOptions;
+import com.datastax.astra.client.core.options.BaseOptions;
import com.datastax.astra.client.core.options.TimeoutOptions;
import lombok.NoArgsConstructor;
import lombok.Setter;
@@ -31,7 +31,6 @@
* Options for InsertMany
*/
@Setter
-@NoArgsConstructor
@Accessors(fluent = true, chain = true)
public class CollectionInsertManyOptions extends BaseOptions {
@@ -60,6 +59,12 @@ public class CollectionInsertManyOptions extends BaseOptions {
+
+ /**
+ * Default constructor.
+ */
+ public CollectionInsertOneOptions() {
+ }
}
diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/collections/options/CollectionReplaceOneOptions.java b/astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/options/CollectionReplaceOneOptions.java
similarity index 82%
rename from astra-db-java/src/main/java/com/datastax/astra/client/collections/options/CollectionReplaceOneOptions.java
rename to astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/options/CollectionReplaceOneOptions.java
index 6f3da7c8..4bfdf75c 100644
--- a/astra-db-java/src/main/java/com/datastax/astra/client/collections/options/CollectionReplaceOneOptions.java
+++ b/astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/options/CollectionReplaceOneOptions.java
@@ -1,4 +1,4 @@
-package com.datastax.astra.client.collections.options;
+package com.datastax.astra.client.collections.commands.options;
/*-
* #%L
@@ -20,7 +20,7 @@
* #L%
*/
-import com.datastax.astra.client.core.commands.BaseOptions;
+import com.datastax.astra.client.core.options.BaseOptions;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;
@@ -30,10 +30,15 @@
* Options for the replaceOne operation.
*/
@Getter @Setter
-@NoArgsConstructor
@Accessors(fluent = true, chain = true)
public class CollectionReplaceOneOptions extends BaseOptions {
/** If upsert is selected. */
Boolean upsert;
+
+ /**
+ * Default constructor.
+ */
+ public CollectionReplaceOneOptions() {
+ }
}
diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/collections/options/CollectionUpdateManyOptions.java b/astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/options/CollectionUpdateManyOptions.java
similarity index 82%
rename from astra-db-java/src/main/java/com/datastax/astra/client/collections/options/CollectionUpdateManyOptions.java
rename to astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/options/CollectionUpdateManyOptions.java
index 28ce030d..95cc24b1 100644
--- a/astra-db-java/src/main/java/com/datastax/astra/client/collections/options/CollectionUpdateManyOptions.java
+++ b/astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/options/CollectionUpdateManyOptions.java
@@ -1,4 +1,4 @@
-package com.datastax.astra.client.collections.options;
+package com.datastax.astra.client.collections.commands.options;
/*-
* #%L
@@ -20,7 +20,7 @@
* #L%
*/
-import com.datastax.astra.client.core.commands.BaseOptions;
+import com.datastax.astra.client.core.options.BaseOptions;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;
@@ -30,7 +30,6 @@
* Options for the updateOne operation
*/
@Getter @Setter
-@NoArgsConstructor
@Accessors(fluent = true, chain = true)
public class CollectionUpdateManyOptions extends BaseOptions {
@@ -38,4 +37,11 @@ public class CollectionUpdateManyOptions extends BaseOptions {
+public class CollectionUpdateOneOptions extends BaseOptions {
/**
* if upsert is selected
@@ -46,6 +43,11 @@ public class UpdateOneOptions extends BaseOptions {
*/
private Sort[] sort;
+ /**
+ * Default constructor.
+ */
+ public CollectionUpdateOneOptions() {}
+
/**
* Adding this on top of sort(Sort[] s) to allow for a more fluent API.
* @param s
@@ -53,7 +55,7 @@ public class UpdateOneOptions extends BaseOptions {
* @return
* current command
*/
- public UpdateOneOptions sort(Sort... s) {
+ public CollectionUpdateOneOptions sort(Sort... s) {
this.sort = s;
return this;
}
diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/collections/options/CountDocumentsOptions.java b/astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/options/CountDocumentsOptions.java
similarity index 79%
rename from astra-db-java/src/main/java/com/datastax/astra/client/collections/options/CountDocumentsOptions.java
rename to astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/options/CountDocumentsOptions.java
index 5df03e2b..aa18d031 100644
--- a/astra-db-java/src/main/java/com/datastax/astra/client/collections/options/CountDocumentsOptions.java
+++ b/astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/options/CountDocumentsOptions.java
@@ -1,4 +1,4 @@
-package com.datastax.astra.client.collections.options;
+package com.datastax.astra.client.collections.commands.options;
/*-
* #%L
@@ -20,7 +20,7 @@
* #L%
*/
-import com.datastax.astra.client.core.commands.BaseOptions;
+import com.datastax.astra.client.core.options.BaseOptions;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;
@@ -30,6 +30,12 @@
* List Options for a FindOne command.
*/
@Getter @Setter
-@NoArgsConstructor
@Accessors(fluent = true, chain = true)
-public class CountDocumentsOptions extends BaseOptions {}
+public class CountDocumentsOptions extends BaseOptions {
+
+ /**
+ * Default constructor.
+ */
+ public CountDocumentsOptions() {
+ }
+}
diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/databases/options/CreateCollectionOptions.java b/astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/options/CreateCollectionOptions.java
similarity index 57%
rename from astra-db-java/src/main/java/com/datastax/astra/client/databases/options/CreateCollectionOptions.java
rename to astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/options/CreateCollectionOptions.java
index 9582ece9..57542840 100644
--- a/astra-db-java/src/main/java/com/datastax/astra/client/databases/options/CreateCollectionOptions.java
+++ b/astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/options/CreateCollectionOptions.java
@@ -1,4 +1,4 @@
-package com.datastax.astra.client.databases.options;
+package com.datastax.astra.client.collections.commands.options;
/*-
* #%L
@@ -20,13 +20,38 @@
* #L%
*/
-import com.datastax.astra.client.core.commands.BaseOptions;
+import com.datastax.astra.client.core.options.BaseOptions;
+import com.datastax.astra.client.core.options.DataAPIClientOptions;
+import lombok.Setter;
+import lombok.experimental.Accessors;
import static com.datastax.astra.client.core.commands.CommandType.COLLECTION_ADMIN;
+/**
+ * Options for the createCollection operation.
+ */
+@Setter
+@Accessors(fluent = true, chain = true)
public class CreateCollectionOptions extends BaseOptions {
+ /**
+ * The keyspace to use for the database.
+ */
+ String keyspace = DataAPIClientOptions.DEFAULT_KEYSPACE;
+
+ /**
+ * Default constructor.
+ */
public CreateCollectionOptions() {
super(null, COLLECTION_ADMIN, null);
}
+
+ /**
+ * Gets keyspace
+ *
+ * @return value of keyspace
+ */
+ public String getKeyspace() {
+ return keyspace;
+ }
}
diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/databases/options/DropCollectionOptions.java b/astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/options/DropCollectionOptions.java
similarity index 75%
rename from astra-db-java/src/main/java/com/datastax/astra/client/databases/options/DropCollectionOptions.java
rename to astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/options/DropCollectionOptions.java
index 1f0cd7e2..540ce9e3 100644
--- a/astra-db-java/src/main/java/com/datastax/astra/client/databases/options/DropCollectionOptions.java
+++ b/astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/options/DropCollectionOptions.java
@@ -1,4 +1,4 @@
-package com.datastax.astra.client.databases.options;
+package com.datastax.astra.client.collections.commands.options;
/*-
* #%L
@@ -20,13 +20,23 @@
* #L%
*/
-import com.datastax.astra.client.core.commands.BaseOptions;
+import com.datastax.astra.client.core.options.BaseOptions;
+import lombok.Setter;
+import lombok.experimental.Accessors;
import static com.datastax.astra.client.collections.Collection.DEFAULT_COLLECTION_SERIALIZER;
import static com.datastax.astra.client.core.commands.CommandType.COLLECTION_ADMIN;
+/**
+ * Options for the dropCollection operation.
+ */
+@Setter
+@Accessors(fluent = true, chain = true)
public class DropCollectionOptions extends BaseOptions {
+ /**
+ * Default constructor.
+ */
public DropCollectionOptions() {
super(null, COLLECTION_ADMIN, DEFAULT_COLLECTION_SERIALIZER, null);
}
diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/collections/options/EstimatedCountDocumentsOptions.java b/astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/options/EstimatedCountDocumentsOptions.java
similarity index 76%
rename from astra-db-java/src/main/java/com/datastax/astra/client/collections/options/EstimatedCountDocumentsOptions.java
rename to astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/options/EstimatedCountDocumentsOptions.java
index a6a3953d..66c5c706 100644
--- a/astra-db-java/src/main/java/com/datastax/astra/client/collections/options/EstimatedCountDocumentsOptions.java
+++ b/astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/options/EstimatedCountDocumentsOptions.java
@@ -1,4 +1,4 @@
-package com.datastax.astra.client.collections.options;
+package com.datastax.astra.client.collections.commands.options;
/*-
* #%L
@@ -20,7 +20,7 @@
* #L%
*/
-import com.datastax.astra.client.core.commands.BaseOptions;
+import com.datastax.astra.client.core.options.BaseOptions;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;
@@ -30,6 +30,12 @@
* List Options for a FindOne command.
*/
@Getter @Setter
-@NoArgsConstructor
@Accessors(fluent = true, chain = true)
-public class EstimatedCountDocumentsOptions extends BaseOptions {}
+public class EstimatedCountDocumentsOptions extends BaseOptions {
+
+ /**
+ * Default constructor.
+ */
+ public EstimatedCountDocumentsOptions() {
+ }
+}
diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/databases/options/ListCollectionOptions.java b/astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/options/ListCollectionOptions.java
similarity index 81%
rename from astra-db-java/src/main/java/com/datastax/astra/client/databases/options/ListCollectionOptions.java
rename to astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/options/ListCollectionOptions.java
index 8bdf26b8..635f06f4 100644
--- a/astra-db-java/src/main/java/com/datastax/astra/client/databases/options/ListCollectionOptions.java
+++ b/astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/options/ListCollectionOptions.java
@@ -1,4 +1,4 @@
-package com.datastax.astra.client.databases.options;
+package com.datastax.astra.client.collections.commands.options;
/*-
* #%L
@@ -20,14 +20,19 @@
* #L%
*/
-import com.datastax.astra.client.core.commands.BaseOptions;
+import com.datastax.astra.client.core.options.BaseOptions;
import com.datastax.astra.internal.serdes.collections.DocumentSerializer;
-import com.datastax.astra.internal.serdes.tables.RowSerializer;
import static com.datastax.astra.client.core.commands.CommandType.COLLECTION_ADMIN;
+/**
+ * Options for the listCollection operation.
+ */
public class ListCollectionOptions extends BaseOptions {
+ /**
+ * Default constructor.
+ */
public ListCollectionOptions() {
super(null, COLLECTION_ADMIN, new DocumentSerializer(), null);
}
diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/options/package-info.java b/astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/options/package-info.java
new file mode 100644
index 00000000..061f376a
--- /dev/null
+++ b/astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/options/package-info.java
@@ -0,0 +1,23 @@
+/**
+ * Options and Inputs for Collections commands.
+ */
+package com.datastax.astra.client.collections.commands.options;
+/*-
+ * #%L
+ * Data API Java Client
+ * --
+ * Copyright (C) 2024 DataStax
+ * --
+ * Licensed under the Apache License, Version 2.0
+ * You may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * #L%
+ */
diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/package-info.java b/astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/package-info.java
new file mode 100644
index 00000000..53c11b63
--- /dev/null
+++ b/astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/package-info.java
@@ -0,0 +1,23 @@
+/**
+ * Command Definitions for operating on Collections.
+ */
+package com.datastax.astra.client.collections.commands;
+/*-
+ * #%L
+ * Data API Java Client
+ * --
+ * Copyright (C) 2024 DataStax
+ * --
+ * Licensed under the Apache License, Version 2.0
+ * You may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * #L%
+ */
diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/collections/results/CollectionDeleteResult.java b/astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/results/CollectionDeleteResult.java
similarity index 94%
rename from astra-db-java/src/main/java/com/datastax/astra/client/collections/results/CollectionDeleteResult.java
rename to astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/results/CollectionDeleteResult.java
index b6abf24e..68536d22 100644
--- a/astra-db-java/src/main/java/com/datastax/astra/client/collections/results/CollectionDeleteResult.java
+++ b/astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/results/CollectionDeleteResult.java
@@ -1,4 +1,4 @@
-package com.datastax.astra.client.collections.results;
+package com.datastax.astra.client.collections.commands.results;
/*-
* #%L
diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/collections/results/CollectionInsertManyResult.java b/astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/results/CollectionInsertManyResult.java
similarity index 71%
rename from astra-db-java/src/main/java/com/datastax/astra/client/collections/results/CollectionInsertManyResult.java
rename to astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/results/CollectionInsertManyResult.java
index c2b66cf5..249bf64b 100644
--- a/astra-db-java/src/main/java/com/datastax/astra/client/collections/results/CollectionInsertManyResult.java
+++ b/astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/results/CollectionInsertManyResult.java
@@ -1,4 +1,4 @@
-package com.datastax.astra.client.collections.results;
+package com.datastax.astra.client.collections.commands.results;
/*-
* #%L
@@ -21,10 +21,9 @@
*/
-import com.datastax.astra.internal.api.DataAPIDocumentResponse;
+import com.datastax.astra.client.collections.definition.documents.Document;
import lombok.AllArgsConstructor;
import lombok.Getter;
-import lombok.NoArgsConstructor;
import lombok.Setter;
import java.util.ArrayList;
@@ -35,13 +34,21 @@
*/
@Getter @Setter
@AllArgsConstructor
-@NoArgsConstructor
public class CollectionInsertManyResult {
/** Inserted Ids. */
- List