Package io.qdrant.client

Class QdrantGrpcClient

java.lang.Object

io.qdrant.client.QdrantGrpcClient

All Implemented Interfaces:

AutoCloseable

public class QdrantGrpcClient
extends Object
implements AutoCloseable

Low-level gRPC client for qdrant vector database.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	QdrantGrpcClient.Builder	builder for QdrantGrpcClient

Method Summary

Modifier and Type	Method	Description
io.grpc.ManagedChannel	channel()	Gets the channel
void	close()
io.qdrant.client.grpc.CollectionsGrpc.CollectionsFutureStub	collections()	Gets the client for collections
static QdrantGrpcClient.Builder	newBuilder(io.grpc.ManagedChannel channel)	Creates a new builder to build a client.
static QdrantGrpcClient.Builder	newBuilder(io.grpc.ManagedChannel channel, boolean shutdownChannelOnClose)	Creates a new builder to build a client.
static QdrantGrpcClient.Builder	newBuilder(io.grpc.ManagedChannel channel, boolean shutdownChannelOnClose, boolean checkCompatibility)	Creates a new builder to build a client.
static QdrantGrpcClient.Builder	newBuilder(String host)	Creates a new builder to build a client.
static QdrantGrpcClient.Builder	newBuilder(String host, int port)	Creates a new builder to build a client.
static QdrantGrpcClient.Builder	newBuilder(String host, int port, boolean useTransportLayerSecurity)	Creates a new builder to build a client.
static QdrantGrpcClient.Builder	newBuilder(String host, int port, boolean useTransportLayerSecurity, boolean checkCompatibility)	Creates a new builder to build a client.
io.qdrant.client.grpc.PointsGrpc.PointsFutureStub	points()	Gets the client for points
io.qdrant.client.grpc.QdrantGrpc.QdrantFutureStub	qdrant()	Gets the client for qdrant services
io.qdrant.client.grpc.SnapshotsGrpc.SnapshotsFutureStub	snapshots()	Gets the client for snapshots

Methods inherited from class java.lang.Object

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

Method Details

newBuilder

public static QdrantGrpcClient.Builder newBuilder(io.grpc.ManagedChannel channel)

Creates a new builder to build a client.

Parameters:

channel - The channel for communication. This channel is not shutdown by the client and must be managed by the caller.

Returns:

a new instance of QdrantGrpcClient.Builder

newBuilder

public static QdrantGrpcClient.Builder newBuilder(io.grpc.ManagedChannel channel,
 boolean shutdownChannelOnClose)

Creates a new builder to build a client.

Parameters:

channel - The channel for communication.

shutdownChannelOnClose - Whether the channel is shutdown on client close.

Returns:

a new instance of QdrantGrpcClient.Builder

newBuilder

public static QdrantGrpcClient.Builder newBuilder(io.grpc.ManagedChannel channel,
 boolean shutdownChannelOnClose,
 boolean checkCompatibility)

Creates a new builder to build a client.

Parameters:

channel - The channel for communication.

shutdownChannelOnClose - Whether the channel is shutdown on client close.

checkCompatibility - Whether to check compatibility between client's and server's versions.

Returns:

a new instance of QdrantGrpcClient.Builder

newBuilder

public static QdrantGrpcClient.Builder newBuilder(String host)

Creates a new builder to build a client.

Parameters:

host - The host to connect to. The default gRPC port 6334 is used.

Returns:

a new instance of QdrantGrpcClient.Builder

newBuilder

public static QdrantGrpcClient.Builder newBuilder(String host,
 int port)

Creates a new builder to build a client. The client uses Transport Layer Security by default.

Parameters:

host - The host to connect to.

port - The port to connect to.

Returns:

a new instance of QdrantGrpcClient.Builder

newBuilder

public static QdrantGrpcClient.Builder newBuilder(String host,
 int port,
 boolean useTransportLayerSecurity)

Creates a new builder to build a client.

Parameters:

host - The host to connect to.

port - The port to connect to.

useTransportLayerSecurity - Whether the client uses Transport Layer Security (TLS) to secure communications. Running without TLS should only be used for testing purposes.

Returns:

a new instance of QdrantGrpcClient.Builder

newBuilder

public static QdrantGrpcClient.Builder newBuilder(String host,
 int port,
 boolean useTransportLayerSecurity,
 boolean checkCompatibility)

Creates a new builder to build a client.

Parameters:

host - The host to connect to.

port - The port to connect to.

useTransportLayerSecurity - Whether the client uses Transport Layer Security (TLS) to secure communications. Running without TLS should only be used for testing purposes.

checkCompatibility - Whether to check compatibility between client's and server's versions.

Returns:

a new instance of QdrantGrpcClient.Builder

channel

public io.grpc.ManagedChannel channel()

Gets the channel

Returns:

the channel

qdrant

public io.qdrant.client.grpc.QdrantGrpc.QdrantFutureStub qdrant()

Gets the client for qdrant services

Returns:

a new instance of QdrantGrpc.QdrantFutureStub

points

public io.qdrant.client.grpc.PointsGrpc.PointsFutureStub points()

Gets the client for points

Returns:

a new instance of PointsGrpc.PointsFutureStub

collections

public io.qdrant.client.grpc.CollectionsGrpc.CollectionsFutureStub collections()

Gets the client for collections

Returns:

a new instance of CollectionsGrpc.CollectionsFutureStub

snapshots

public io.qdrant.client.grpc.SnapshotsGrpc.SnapshotsFutureStub snapshots()

Gets the client for snapshots

Returns:

a new instance of SnapshotsGrpc.SnapshotsFutureStub

close

public void close()

Specified by:

close in interface AutoCloseable