update documentation

Author: clun

README.MD

@@ -1,24 +1,26 @@
 
-# Java Client for Stargate Data API
+# Java Client for Data API
 
 [![License Apache2](https://img.shields.io/hexpm/l/plug.svg)](http://www.apache.org/licenses/LICENSE-2.0)
-[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.datastax.astra/astra-sdk/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.datastax.astra/astra-db-java)
-![Latest Release](https://img.shields.io/github/v/release/datastax/astra-db-java)
+[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=clun_astra-db-java&metric=ncloc)](https://sonarcloud.io/summary/new_code?id=clun_astra-db-java)
 
 [![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=clun_astra-db-java&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=clun_db-java)
-[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=clun_astra-db-java&metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=clun_astra-db-java)
 [![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=clun_astra-db-java&metric=sqale_rating)](https://sonarcloud.io/summary/overall?id=clun_astra-db-java)
 [![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=clun_astra-db-java&metric=vulnerabilities)](https://sonarcloud.io/summary/overall?id=clun_astra-db-java)
+
 [![Bugs](https://sonarcloud.io/api/project_badges/measure?project=clun_astra-db-java&metric=bugs)](https://sonarcloud.io/summary/new_code?id=clun_astra-db-java)
+[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=clun_astra-db-java&metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=clun_astra-db-java)
 [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=clun_astra-db-java&metric=coverage)](https://sonarcloud.io/summary/new_code?id=clun_astra-db-java)
-[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=clun_astra-db-java&metric=ncloc)](https://sonarcloud.io/summary/new_code?id=clun_astra-db-java)
+[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=clun_astra-db-java&metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=clun_astra-db-java)
 
 This client library provides a simplified way to interact with Data API for AstraDB or local instances. For detailed documentation, each operation comes with a detailed description and examples.
 
 - [`astra-db-ts`](https://github.com/datastax/astra-db-ts) is the equivalent for typescript
 - [`astrapy`](https://github.com/datastax/astrapy) is the equivalent in python
 
 This library is under development and not yet available in Maven Central. You can build it locally and install it in your local repository.
+![Latest Release](https://img.shields.io/github/v/release/datastax/astra-db-java)
+
 
 ## 1. Local Installation
 

REALEASE.MD

@@ -16,6 +16,6 @@ mvn clean test jacoco:report
 
 - Push to SONAR
 ```json
-mvn verify org.sonarsource.scanner.maven:sonar-maven-plugin:sonar -Dsonar.projectKey=clun_astra-db-java
+mvn clean test jacoco:report  verify org.sonarsource.scanner.maven:sonar-maven-plugin:sonar -Dsonar.projectKey=clun_astra-db-java
 ```
 

astra-db-java/pom.xml

@@ -133,6 +133,13 @@
             <scope>test</scope>
         </dependency>
 
+        <dependency>
+            <groupId>com.squareup.okhttp3</groupId>
+            <artifactId>mockwebserver</artifactId>
+            <version>4.12.0</version>
+            <scope>test</scope>
+        </dependency>
+
     </dependencies>
 
     <!-- Client is JDK11+ -->

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

@@ -122,8 +122,12 @@ public Database(String apiEndpoint, String token, String namespace, DataAPIOptio
         this.namespaceName = namespace;
         this.token         = token;
         this.options       = options;
-        this.databaseAdminEndpoint  = apiEndpoint + "/" + options.getApiVersion();
+        // Adding version number if needed
+        this.databaseAdminEndpoint = apiEndpoint.endsWith(options.getApiVersion()) ?
+                apiEndpoint :
+                apiEndpoint + "/" + options.getApiVersion();
         StringBuilder dbApiEndPointBuilder = new StringBuilder(apiEndpoint);
+        // Adding /api/json if needed for Astra.
         switch(options.destination) {
             case ASTRA:
             case ASTRA_TEST:

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

@@ -178,17 +178,15 @@ public boolean databaseExists(UUID id) {
         return devopsDbClient.findById(id.toString()).isPresent();
     }
 
-
-
     /**
      * Create new database with a name on free tier. The database name should not exist in the tenant.
      *
      * @param name
      *    database name
      * @return
-     *    database identifier
+     *   database admin object
      */
-    public UUID createDatabase(String name) {
+    public DatabaseAdmin createDatabase(String name) {
         Assert.hasLength(name, "name");
         return createDatabase(name, FREE_TIER_CLOUD, FREE_TIER_CLOUD_REGION);
     }
@@ -207,9 +205,9 @@ public UUID createDatabase(String name) {
      * @param waitForDb
      *      if set to true, the method is blocking
      * @return
-     *      database identifier
+     *      database admin object
      */
-    public UUID createDatabase(String name, CloudProviderType cloud, String cloudRegion, boolean waitForDb) {
+    public DatabaseAdmin createDatabase(String name, CloudProviderType cloud, String cloudRegion, boolean waitForDb) {
         Assert.hasLength(name, "name");
         Assert.notNull(cloud, "cloud");
         Assert.hasLength(cloudRegion, "cloudRegion");
@@ -223,7 +221,7 @@ public UUID createDatabase(String name, CloudProviderType cloud, String cloudReg
             switch(db.getStatus()) {
                 case ACTIVE:
                     log.info("Database " + green("{}") + " already exists and is ACTIVE.", name);
-                    return UUID.fromString(db.getId());
+                    return getDatabaseAdmin(UUID.fromString(db.getId()));
                 case MAINTENANCE:
                 case INITIALIZING:
                 case PENDING:
@@ -232,14 +230,14 @@ public UUID createDatabase(String name, CloudProviderType cloud, String cloudReg
                     if (waitForDb) {
                         waitForDatabase(devopsDbClient.database(db.getId()));
                     }
-                    return UUID.fromString(db.getId());
+                    return getDatabaseAdmin(UUID.fromString(db.getId()));
                 case HIBERNATED:
                     log.info("Database {} is in {} state, resuming...", name, db.getStatus());
                     resumeDb(db);
                     if (waitForDb) {
                         waitForDatabase(devopsDbClient.database(db.getId()));
                     }
-                    return UUID.fromString(db.getId());
+                    return getDatabaseAdmin(UUID.fromString(db.getId()));
                 default:
                     throw new IllegalStateException("Database already exist but cannot be activate");
             }
@@ -255,7 +253,7 @@ public UUID createDatabase(String name, CloudProviderType cloud, String cloudReg
         if (waitForDb) {
             waitForDatabase(devopsDbClient.database(newDbId.toString()));
         }
-        return newDbId;
+        return getDatabaseAdmin(newDbId);
     }
 
     /**
@@ -270,9 +268,9 @@ public UUID createDatabase(String name, CloudProviderType cloud, String cloudReg
      * @param cloudRegion
      *      cloud region
      * @return
-     *      database identifier
+     *      database admin object
      */
-    public UUID createDatabase(String name, CloudProviderType cloud, String cloudRegion) {
+    public DatabaseAdmin createDatabase(String name, CloudProviderType cloud, String cloudRegion) {
         return createDatabase(name, cloud, cloudRegion, true);
     }
 

astra-db-java/src/main/java/com/datastax/astra/client/admin/AstraDBAdmin.java

@@ -27,6 +27,8 @@
 import com.dtsx.astra.sdk.db.exception.DatabaseNotFoundException;
 import com.dtsx.astra.sdk.utils.AstraEnvironment;
 
+import java.util.List;
+import java.util.Set;
 import java.util.UUID;
 import java.util.stream.Stream;
 
@@ -129,10 +131,10 @@ public com.datastax.astra.client.Database getDatabase(String namespaceName, Stri
 
     /** {@inheritDoc} */
     @Override
-    public Stream<String> listNamespaceNames() {
+    public Set<String> listNamespaceNames() {
         return devopsDbClient
                 .database(databaseId.toString())
-                .keyspaces().findAll().stream();
+                .keyspaces().findAll();
     }
 
     /** {@inheritDoc} */

astra-db-java/src/main/java/com/datastax/astra/client/admin/AstraDBDatabaseAdmin.java

@@ -29,6 +29,8 @@
 import lombok.Getter;
 import lombok.extern.slf4j.Slf4j;
 
+import java.util.Set;
+import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
 import static com.datastax.astra.internal.utils.AnsiUtils.green;
@@ -73,9 +75,11 @@ public DataAPIDatabaseAdmin(String apiEndpoint, String token, DataAPIOptions opt
 
     /** {@inheritDoc} */
     @Override
-    public Stream<String> listNamespaceNames() {
+    public Set<String> listNamespaceNames() {
         Command cmd = Command.create("findNamespaces");
-        return runCommand(cmd).getStatusKeyAsStringStream("namespaces");
+        return runCommand(cmd)
+                .getStatusKeyAsStringStream("namespaces")
+                .collect(Collectors.toSet());
     }
 
     /** {@inheritDoc} */

astra-db-java/src/main/java/com/datastax/astra/client/admin/DataAPIDatabaseAdmin.java

@@ -23,6 +23,8 @@
 import com.datastax.astra.client.Database;
 import com.datastax.astra.client.model.CommandRunner;
 
+import java.util.List;
+import java.util.Set;
 import java.util.concurrent.CompletableFuture;
 import java.util.stream.Stream;
 
@@ -78,7 +80,7 @@ public interface DatabaseAdmin {
      * @return A {@link Stream<String>} containing the names of all namespaces within the current database. The stream
      *         provides a flexible and efficient means to process the namespace names according to the application's needs.
      */
-    Stream<String> listNamespaceNames();
+    Set<String> listNamespaceNames();
 
     /**
      * Asynchronously retrieves a stream of namespace names available in the current database. This method facilitates
@@ -105,7 +107,7 @@ public interface DatabaseAdmin {
      *         of all namespaces within the current database. This allows for the asynchronous processing of namespace
      *         names with the flexibility and efficiency benefits of using a stream.
      */
-    default CompletableFuture<Stream<String>> listNamespaceNamesAsync() {
+    default CompletableFuture<Set<String>> listNamespaceNamesAsync() {
         return CompletableFuture.supplyAsync(this::listNamespaceNames);
     }
 
@@ -252,7 +254,7 @@ default CompletableFuture<Void> createNamespaceAsync(String namespace) {
      *      if namespace exists
      */
     default boolean namespaceExists(String namespace) {
-        return listNamespaceNames().anyMatch(namespace::equals);
+        return listNamespaceNames().contains(namespace);
     }
 
 }