test

Author: clun

astra-db-client/src/test/java/com/dtsx/astra/sdk/documentation/CreateCollection.java

@@ -3,19 +3,23 @@
 import com.dtsx.astra.sdk.AstraDBCollection;
 import io.stargate.sdk.json.domain.CollectionDefinition;
 import io.stargate.sdk.json.domain.SimilarityMetric;
+import io.stargate.sdk.json.exception.ApiException;
+import io.stargate.sdk.json.exception.InvalidJsonApiArgumentException;
 
 public class CreateCollection {
   public static void main(String[] args) {
     // Given an active db
     AstraDB db = new AstraDB("<token>", "<api_endpoint>");
 
-    // Create collection with no vector
+    /*
+     * Create collection with no vector.
+     */
     AstraDBCollection collection1 = db.createCollection("collection_simple");
 
     // Create collection with vector
     AstraDBCollection collection2 = db.createCollection(
             "collection_vector1",
-            1536,
+            14,
             SimilarityMetric.cosine);
 
     // Create collection with vector (builder)
@@ -24,5 +28,14 @@ public static void main(String[] args) {
             .name("collection_vector2")
             .vector(1536, SimilarityMetric.euclidean)
             .build());
+
+    /*
+     * Collection name should follow [a-zA-Z][a-zA-Z0-9_]* pattern (snake case)
+     */
+    try {
+      db.createCollection("invalid.name");
+    } catch(ApiException e) {
+      // will fail
+    }
   }
 }

astra-db-client/src/test/java/com/dtsx/astra/sdk/documentation/DeleteCollection.java

@@ -6,10 +6,11 @@
 
 public class DeleteCollection {
   public static void main(String[] args) {
+
     // Given an active db
     AstraDB db = new AstraDB("<token>", "<api_endpoint>");
 
     // Find a collection
-    db.deleteCollection("tmp_collection");
+    db.deleteCollection("collection_vector1");
   }
 }

astra-db-client/src/test/java/com/dtsx/astra/sdk/documentation/FindAllCollections.java

@@ -4,6 +4,7 @@
 
 public class FindAllCollections {
   public static void main(String[] args) {
+
     // Given an active db
     AstraDB db = new AstraDB("<token>", "<api_endpoint>");
 

astra-db-client/src/test/java/com/dtsx/astra/sdk/documentation/FindCollection.java

@@ -6,13 +6,14 @@
 
 public class FindCollection {
   public static void main(String[] args) {
+
     // Given an active db
     AstraDB db = new AstraDB("<token>", "<api_endpoint>");
 
     // Find a collection
-    Optional<CollectionDefinition> collection = db.findCollection("collection1");
+    Optional<CollectionDefinition> collection = db.findCollection("collection_vector1");
 
     // Another test with a collection that does not exist
-    boolean collectionExists = db.isCollectionExists("collection1");
+    boolean collectionExists = db.isCollectionExists("collection_vector2");
   }
 }

astra-db-client/src/test/java/com/dtsx/astra/sdk/documentation/InsertOne.java

@@ -0,0 +1,80 @@
+package com.dtsx.astra.sdk.documentation;
+
+import com.dtsx.astra.sdk.AstraDB;
+import com.dtsx.astra.sdk.AstraDBCollection;
+import io.stargate.sdk.json.domain.JsonDocument;
+import io.stargate.sdk.json.exception.ApiException;
+
+import java.util.Map;
+
+public class InsertOne {
+    public static void main(String[] args) {
+        // Given an active db
+        AstraDB db = new AstraDB("<token>", "<api_endpoint>");
+
+        /*
+         * Given a collection with vector (dimension 14)
+         *
+         * Can be created with: (but you will not create a collection each time)
+         *
+         * AstraDBCollection collection = db.createCollection("collection_vector1", 14);
+         */
+        AstraDBCollection collection = db.collection("collection_vector1");
+        collection.deleteAll();
+
+        //  (1) You can insert records with key/value.
+        collection.insertOne(new JsonDocument()
+                .id("doc1") // uuid is generated if not explicitely set
+                .vector(new float[]{1f, 0f, 1f, 1f, 1f, 1f, 0f, 0f, 0f, 0f, 0f, 0f, 0f, 0f})
+                .put("product_name", "HealthyFresh - Beef raw dog food")
+                .put("product_price", 12.99));
+
+        // (2) You can insert records payload as a Json String
+        collection.insertOne(new JsonDocument()
+                .data("{"
+                        +"   \"_id\": \"doc2\", "
+                        +"   \"$vector\": [1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0], "
+                        +"   \"product_name\": \"HealthyFresh - Chicken raw dog food\", "
+                        + "  \"product_price\": 9.99"
+                        + "}")
+        );
+
+        // (3) You can also insert records payload as a Map
+        collection.insertOne(new JsonDocument()
+                .id("doc3")
+                .vector(new float[]{1f, 1f, 1f, 1f, 1f, 0f, 0f, 0f, 0f, 0f, 0f, 0f, 0f, 0f})
+                .data(Map.of("product_name", "HealthyFresh - Chicken raw dog food"))
+        );
+
+        // (4) All hybrid combination are possible (key/value, json, map)
+        collection.insertOne(new JsonDocument()
+                .id("doc4")
+                .vector(new float[]{1f, 1f, 1f, 1f, 1f, 0f, 0f, 0f, 0f, 0f, 0f, 0f, 0f, 0f})
+                .data("{"
+                        +"   \"product_name\": \"HealthyFresh - Chicken raw dog food\", "
+                        + "  \"product_price\": 9.99"
+                        + "}")
+        );
+
+        // (5) You cannot insert a document with an existing id
+        try {
+            collection.insertOne(new JsonDocument("doc4"));
+        } catch(ApiException e) {
+            System.out.println("Expected ERROR: " + e.getMessage());
+        }
+
+        /*
+        * (5) Insertion rules
+        *
+        * - all attributes are nullable
+        * - id is generated if needed, the id is returned by insertOne()
+        * - Add any property you want, but needs to use [A-Za-z_-.] and not starting by '$'
+        * - It is schema less, values can be any simple type
+        */
+        String generatedId = collection.insertOne(new JsonDocument().put("demo", 1));
+
+        // (6) can the payload be a bean/pojo ?
+        // Yes! check Object Mapping section
+
+    }
+}