Update changelogs, examples, and readme (#52)

## Problem Prepare for next java sdk release. ## Solution Updated changelogs, examples, and readme for 0.7.0 release. ## Type of Change - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] This change requires a documentation update - [ ] Infrastructure change (CI configs, etc) - [X] Non-code change (docs, etc) - [ ] None of the above: (explain here) ## Test Plan NA
pinecone-io · Dec 18, 2023 · 639bb34 · 639bb34
1 parent f28ce34
commit 639bb34
Show file tree

Hide file tree

Showing 8 changed files with 40 additions and 58 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,9 +2,12 @@
 
 [comment]: <> (When bumping [pc:VERSION_LATEST_RELEASE] create a new entry below)
 ### Unreleased version
+
+### v0.7.0
 - Add support to list indexes
 - Add support to configure index
-- Add user-agent as a header
+- Add user-agent to the header
+- Add integration tests for data plane operations
 
 ### v0.6.0
 - Add async stub for data plane operations

diff --git a/README.md b/README.md
@@ -15,30 +15,24 @@ Maven:
 <dependency>
   <groupId>io.pinecone</groupId>
   <artifactId>pinecone-client</artifactId>
-  <version>0.2.3</version>
+  <version>0.7.0</version>
 </dependency>
 ```
 
 [comment]: <> (^ [pc:VERSION_LATEST_RELEASE])
 
 Gradle:
 ```
-implementation "io.pinecone:pinecone-client:0.2.3"
+implementation "io.pinecone:pinecone-client:0.7.0"
 ```
 
 [comment]: <> (^ [pc:VERSION_LATEST_RELEASE])
 
-Alternatively, you can use our standalone uberjar [pinecone-client-0.2.3-all.jar](https://repo1.maven.org/maven2/io/pinecone/pinecone-client/0.2.3/pinecone-client-0.2.3-all.jar), which bundles the pinecone client and all dependencies together inside a single jar. You can include this on your classpath like any 3rd party JAR without having to obtain the *pinecone-client* dependencies separately.
+Alternatively, you can use our standalone uberjar [pinecone-client-0.7.0-all.jar](https://repo1.maven.org/maven2/io/pinecone/pinecone-client/0.7.0/pinecone-client-0.7.0-all.jar), which bundles the pinecone client and all dependencies together inside a single jar. You can include this on your classpath like any 3rd party JAR without having to obtain the *pinecone-client* dependencies separately.
 
 [comment]: <> (^ [pc:VERSION_LATEST_RELEASE])
 
-## Features
-
-The Java client doesn't support managing Pinecone services, only reading and writing from existing indices. To create or delete an index, use the Python client.
-
 
 ## Examples
 
-- The most basic example usage is in `src/test/java/io/pinecone/PineconeClientLiveIntegTest.java`, covering most basic operations.
-> [!NOTE]
-> The java-basic-mvn example is outdated.
+- The data and control plane operation examples can be found in `io/pinecone/integration` folder.
diff --git a/examples/java-basic-mvn/src/main/java/pineconeexamples/MinimalUpsertAndQueryExample.java b/examples/java-basic-mvn/src/main/java/pineconeexamples/MinimalUpsertAndQueryExample.java
@@ -53,6 +53,7 @@ public static void main(String[] cliArgs) {
                     .addAllValues(Floats.asList(5F, 3F, 1F))
                     .build();
 
+            // Deprecated: use addValue() or addAllValues() instead of addVector() and addAllVectors() respectively
             UpsertRequest upsertRequest = UpsertRequest.newBuilder()
                     .addVectors(v1)
                     .addVectors(v2)

diff --git a/...les/java-basic-mvn/src/main/java/pineconeexamples/UpsertsAndQueriesConcurrentExample.java b/...les/java-basic-mvn/src/main/java/pineconeexamples/UpsertsAndQueriesConcurrentExample.java
@@ -106,6 +106,8 @@ public static void main(String[] cliArgs) throws InterruptedException {
                         }
 
                         try {
+                            // Deprecated: use addValue() or addAllValues() instead of addVector()
+                            // and addAllVectors() respectively
                             UpsertRequest upsertRequest = UpsertRequest.newBuilder()
                                     .addAllVectors(vectors)
                                     .build();

diff --git a/gradle.properties b/gradle.properties
@@ -1 +1 @@
-pineconeClientVersion = 0.6.0
+pineconeClientVersion = 0.7.0
diff --git a/src/integration/java/io/pinecone/integration/controlPlane/ConfigureIndexTest.java b/src/integration/java/io/pinecone/integration/controlPlane/ConfigureIndexTest.java
@@ -1,7 +1,7 @@
 package io.pinecone.integration.controlPlane;
 
 import io.pinecone.PineconeClientConfig;
-import io.pinecone.PineconeClientLiveIntegTest;
+import io.pinecone.integration.dataplane.PineconeClientLiveIntegTest;
 import io.pinecone.PineconeIndexOperationClient;
 import io.pinecone.exceptions.PineconeBadRequestException;
 import io.pinecone.exceptions.PineconeNotFoundException;

diff --git a/...IndexOperationsClientIntegrationTest.java → ...olPlane/CreateListAndDeleteIndexTest.java b/...IndexOperationsClientIntegrationTest.java → ...olPlane/CreateListAndDeleteIndexTest.java
@@ -1,5 +1,7 @@
-package io.pinecone;
+package io.pinecone.integration.controlPlane;
 
+import io.pinecone.PineconeClientConfig;
+import io.pinecone.PineconeIndexOperationClient;
 import io.pinecone.helpers.RandomStringBuilder;
 import io.pinecone.model.CreateIndexRequest;
 import io.pinecone.model.IndexMeta;
@@ -12,7 +14,7 @@
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertNotNull;
 
-public class PineconeIndexOperationsClientIntegrationTest {
+public class CreateListAndDeleteIndexTest {
     private PineconeIndexOperationClient pinecone;
 
     @BeforeEach

diff --git a/...pinecone/PineconeClientLiveIntegTest.java → ...ataplane/PineconeClientLiveIntegTest.java b/...pinecone/PineconeClientLiveIntegTest.java → ...ataplane/PineconeClientLiveIntegTest.java
@@ -1,59 +1,39 @@
-package io.pinecone;
+package io.pinecone.integration.dataplane;
 
 import com.google.common.primitives.Floats;
 import com.google.protobuf.Struct;
 import com.google.protobuf.Value;
+import io.pinecone.PineconeConnection;
 import io.pinecone.helpers.RandomStringBuilder;
-import io.pinecone.model.IndexMeta;
 import io.pinecone.proto.*;
-import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.Test;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import java.io.IOException;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
 
+import static io.pinecone.helpers.IndexManager.createIndexIfNotExistsDataPlane;
 import static org.hamcrest.MatcherAssert.assertThat;
 import static org.hamcrest.Matchers.equalTo;
 import static org.hamcrest.Matchers.notNullValue;
-import static org.junit.jupiter.api.Assertions.assertEquals;
 
 public class PineconeClientLiveIntegTest {
 
-    public String indexName = "integ-test-sanity";
-
     private static final Logger logger = LoggerFactory.getLogger(PineconeClientLiveIntegTest.class);
+    private static VectorServiceGrpc.VectorServiceBlockingStub blockingStub;
 
-    private PineconeClient dataPlaneClient;
-    private PineconeIndexOperationClient controlPlaneClient;
-
-    @BeforeEach
-    public void setUp() {
-        PineconeClientConfig config = new PineconeClientConfig()
-                .withApiKey(System.getenv("PINECONE_API_KEY"))
-                .withEnvironment(System.getenv("PINECONE_ENVIRONMENT"))
-                .withServerSideTimeoutSec(10);
-
-        controlPlaneClient = new PineconeIndexOperationClient(config);
-        dataPlaneClient = new PineconeClient(config);
+    @BeforeAll
+    public static void defineConfig() throws IOException, InterruptedException {
+        PineconeConnection connection = createIndexIfNotExistsDataPlane(3);
+        blockingStub = connection.getBlockingStub();
     }
 
     @Test
-    public void checkIndexSetup() throws Exception {
-        IndexMeta indexMeta = controlPlaneClient.describeIndex(indexName);
-        assertEquals(3, indexMeta.getDatabase().getDimension());
-    }
-
-    @Test
-    public void sanity() throws Exception {
-        IndexMeta indexMeta = controlPlaneClient.describeIndex(indexName);
-        String host = indexMeta.getStatus().getHost();
-        PineconeConnection conn = dataPlaneClient.connect(
-                new PineconeConnectionConfig()
-                        .withConnectionUrl("https://" + host));
-
+    public void sanity() {
         String namespace = RandomStringBuilder.build("ns", 8);
 
         // upsert
@@ -76,7 +56,7 @@ public void sanity() throws Exception {
                 .setNamespace(namespace)
                 .build();
 
-        UpsertResponse upsertResponse = conn.getBlockingStub().upsert(request);
+        UpsertResponse upsertResponse = blockingStub.upsert(request);
         logger.info("Put " + upsertResponse.getUpsertedCount() + " vectors into the index");
         assert (upsertResponse.getUpsertedCount() == 3);
 
@@ -100,14 +80,14 @@ public void sanity() throws Exception {
                 .addAllVectors(hybridVectors)
                 .setNamespace(namespace)
                 .build();
-        UpsertResponse hybridResponse = conn.getBlockingStub().upsert(hybridRequest);
+        UpsertResponse hybridResponse = blockingStub.upsert(hybridRequest);
         logger.info("Put " + hybridResponse.getUpsertedCount() + " vectors into the index");
         assert (hybridResponse.getUpsertedCount() == 3);
 
         // fetch
         List<String> ids = Arrays.asList("v1", "v2");
         FetchRequest fetchRequest = FetchRequest.newBuilder().addAllIds(ids).setNamespace(namespace).build();
-        FetchResponse fetchResponse = conn.getBlockingStub().fetch(fetchRequest);
+        FetchResponse fetchResponse = blockingStub.fetch(fetchRequest);
         assert (fetchResponse.containsVectors("v1"));
 
         // Updates vector v1's values to 10.0, 11.0, and 12.0 from 1.0, 2.0, and 3.0
@@ -116,9 +96,9 @@ public void sanity() throws Exception {
                 .setNamespace(namespace)
                 .addAllValues(Floats.asList(10F, 11F, 12F))
                 .build();
-        conn.getBlockingStub().update(updateRequest);
+        blockingStub.update(updateRequest);
         fetchRequest = FetchRequest.newBuilder().addIds("v1").setNamespace(namespace).build();
-        conn.getBlockingStub().fetch(fetchRequest);
+        blockingStub.fetch(fetchRequest);
 
         // DEPRECATED: all methods related to queries in QueryVector
         // Use methods related to Vector. Example: addVector, addAllVector, etc.
@@ -145,7 +125,7 @@ public void sanity() throws Exception {
                 .setIncludeMetadata(true)
                 .build();
 
-        QueryResponse queryResponse = conn.getBlockingStub().query(batchQueryRequest);
+        QueryResponse queryResponse = blockingStub.query(batchQueryRequest);
         assertThat(queryResponse, notNullValue());
         assertThat(queryResponse.getResultsList(), notNullValue());
         assertThat(queryResponse.getResultsCount(), equalTo(1));
@@ -159,7 +139,7 @@ public void sanity() throws Exception {
                 .build();
 
         // When querying using a single vector, we get matches instead of results
-        queryResponse = conn.getBlockingStub().query(queryRequest);
+        queryResponse = blockingStub.query(queryRequest);
         assertThat(queryResponse, notNullValue());
         assertThat(queryResponse.getMatchesList(), notNullValue());
         assertThat(queryResponse.getMatchesCount(), equalTo(2));
@@ -172,7 +152,7 @@ public void sanity() throws Exception {
                 .setIncludeMetadata(true)
                 .build();
 
-        queryResponse = conn.getBlockingStub().query(queryByIdRequest);
+        queryResponse = blockingStub.query(queryByIdRequest);
         assertThat(queryResponse, notNullValue());
         assertThat(queryResponse.getMatchesList(), notNullValue());
         assertThat(queryResponse.getMatchesCount(), equalTo(2));
@@ -185,9 +165,9 @@ public void sanity() throws Exception {
                 .setDeleteAll(false)
                 .build();
 
-        conn.getBlockingStub().delete(deleteRequest);
+        blockingStub.delete(deleteRequest);
         fetchRequest = FetchRequest.newBuilder().addAllIds(ids).setNamespace(namespace).build();
-        fetchResponse = conn.getBlockingStub().fetch(fetchRequest);
+        fetchResponse = blockingStub.fetch(fetchRequest);
         assert (fetchResponse.getVectorsCount() == ids.size() - 1);
 
         // Clear out the test
@@ -196,9 +176,9 @@ public void sanity() throws Exception {
                 .setDeleteAll(true)
                 .build();
 
-        conn.getBlockingStub().delete(deleteAllRequest);
+        blockingStub.delete(deleteAllRequest);
         fetchRequest = FetchRequest.newBuilder().addAllIds(ids).setNamespace(namespace).build();
-        fetchResponse = conn.getBlockingStub().fetch(fetchRequest);
+        fetchResponse = blockingStub.fetch(fetchRequest);
         assert (fetchResponse.getVectorsCount() == 0);
     }
 }