io.pinecone.configs

Class PineconeConnection

java.lang.Object

io.pinecone.configs.PineconeConnection

All Implemented Interfaces:

java.lang.AutoCloseable

public class PineconeConnection
extends java.lang.Object
implements java.lang.AutoCloseable

The PineconeConnection class handles communication with a Pinecone service or router. One PineconeConnection can be shared and used concurrently by multiple threads.

  import io.pinecone.clients.AsyncIndex;
  import io.pinecone.clients.Index;
  import io.pinecone.configs.PineconeConnection;
  ...

  // Construct the connection object
  PineconeConnection connection = new PineconeConnection(config);

  // Construct the index object for synchronous data plane operations
  Index index = new Index(connection, "example-index");
  index.describeIndexStats();

  // Construct the async index object for asynchronous data plane operations
  AsyncIndex asyncIndex = new AsyncIndex(connection, "example-index");
  asyncIndex.describeIndexStats();

  

Constructor Summary

Constructors

Constructor and Description
PineconeConnection(PineconeConfig config) Constructs a PineconeConnection instance with the specified PineconeConfig.

Method Summary

Modifier and Type	Method and Description
static io.grpc.ManagedChannel	buildChannel(java.lang.String host)
void	close() Close the connection and release all resources.
static java.lang.String	formatEndpoint(java.lang.String host)
VectorServiceGrpc.VectorServiceFutureStub	getAsyncStub() Return the gRPC async stub to allow clients to do ListenableFuture-style rpc calls to Pinecone.
VectorServiceGrpc.VectorServiceBlockingStub	getBlockingStub() Return the gRPC stub used for sending requests to Pinecone.
io.grpc.ManagedChannel	getChannel() Returns the gRPC channel.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PineconeConnection

public PineconeConnection(PineconeConfig config)

Constructs a PineconeConnection instance with the specified PineconeConfig. If a custom gRPC ManagedChannel is provided in the PineconeConfig, it will be used. Otherwise, a new gRPC ManagedChannel will be built using the host specified in the PineconeConfig.

Parameters:

config - The PineconeConfig containing configuration settings for the PineconeConnection.

Throws:

PineconeValidationException - If index name or host is not provided for data plane operations.

Method Detail

close

public void close()

Close the connection and release all resources. A PineconeConnection's underlying gRPC components use resources like threads and TCP connections. To prevent leaking these resources the connection should be closed when it will no longer be used. If it may be used again leave it running.

Specified by:

close in interface java.lang.AutoCloseable

getChannel

public io.grpc.ManagedChannel getChannel()

Returns the gRPC channel.

getBlockingStub

public VectorServiceGrpc.VectorServiceBlockingStub getBlockingStub()

Return the gRPC stub used for sending requests to Pinecone.

Returns:

The blocking stub

getAsyncStub

public VectorServiceGrpc.VectorServiceFutureStub getAsyncStub()

Return the gRPC async stub to allow clients to do ListenableFuture-style rpc calls to Pinecone.

Returns:

The async stub

buildChannel

public static io.grpc.ManagedChannel buildChannel(java.lang.String host)

formatEndpoint

public static java.lang.String formatEndpoint(java.lang.String host)