Package io.metaloom.qdrant.client.http.impl

Class QDrantHttpClientImpl

java.lang.Object

io.metaloom.qdrant.client.http.AbstractQDrantClient

io.metaloom.qdrant.client.http.impl.QDrantHttpClientImpl

All Implemented Interfaces:

io.metaloom.qdrant.client.CommonSettings, ClientSettings, ClusterMethods, CollectionMethods, PointMethods, ServiceMethods, SnapshotMethods, QDrantHttpClient, AutoCloseable

public class QDrantHttpClientImpl
extends AbstractQDrantClient

Implementation for the QDrantHttpClient

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	QDrantHttpClientImpl.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final org.slf4j.Logger	log

Fields inherited from class io.metaloom.qdrant.client.http.AbstractQDrantClient

connectTimeout, hostname, port, readTimeout, scheme, writeTimeout

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	QDrantHttpClientImpl(String scheme, String hostname, int port, Duration connectTimeout, Duration readTimeout, Duration writeTimeout)	Create a new client with a default timeout of 10s for all timeouts (connect, read and write).

Method Summary

Modifier and Type	Method	Description
static QDrantHttpClientImpl.Builder	builder()
QDrantClientRequest<UpdateResultResponse>	clearPayload(String collectionName, PointsClearPayloadRequest request, boolean wait)	Remove all payload for specified points.
void	close()	Close the client and release all resources.
QDrantClientRequest<ServiceTelemetryResponse>	collectTelemetry(boolean anonymize)	Collect telemetry data including app info, system info, collections info, cluster info, configs and statistics.
QDrantClientRequest<PointCountResponse>	countPoints(String collectionName, PointCountRequest request)	Count points which matches given filtering condition.
QDrantClientRequest<GenericBooleanStatusResponse>	createCollection(String collectionName, CollectionCreateRequest request)	Create new collection with given parameters.
QDrantClientRequest<CollectionIndexFieldResponse>	createCollectionIndexField(String collectionName, CollectionCreateIndexFieldRequest request, boolean wait)	Create index for field in collection.
QDrantClientRequest<SnapshotResponse>	createCollectionSnapshot(String collectionName)	Create new snapshot for a collection.
QDrantClientRequest<SnapshotCreateResponse>	createStorageSnapshot()	Create new snapshot of the whole storage.
QDrantClientRequest<GenericBooleanStatusResponse>	deleteCollection(String collectionName, int timeout)	Drop collection and all associated data.
QDrantClientRequest<CollectionIndexFieldResponse>	deleteCollectionIndexField(String collectionName, String fieldName, boolean wait)	Delete field index for collection.
QDrantClientRequest<UpdateResultResponse>	deletePayload(String collectionName, PointDeletePayloadRequest request, boolean wait)	Delete specified key payload for points.
QDrantClientRequest<UpdateResultResponse>	deletePoints(String collectionName, PointsDeleteRequest request, boolean wait)	Delete points.
QDrantClientRequest<QDrantBinaryResponse>	downloadCollectionSnapshot(String collectionName, String snapshotName)	Download specified snapshot from a collection as a file.
QDrantClientRequest<QDrantBinaryResponse>	downloadStorageSnapshot(String snapshotName)	Download specified snapshot of the whole storage as a file.
QDrantClientRequest<ClusterStatusResponse>	getClusterStatusInfo()	Get information about the current state and composition of the cluster.
QDrantClientRequest<CollectionClusterInfoResponse>	getCollectionClusterInfo(String collectionName)	Get cluster information for a collection.
QDrantClientRequest<LockOptionResponse>	getLockOptions()	Get lock options.
okhttp3.OkHttpClient	getOkHttpClient()	Return the used OK HTTP client.
QDrantClientRequest<PointGetResponse>	getPoint(String collectionName, String pointId)	Retrieve full information of single point by id.
QDrantClientRequest<PointsGetResponse>	getPoints(String collectionName, PointsGetRequest request)	Retrieve multiple points by specified IDs.
void	init()
QDrantClientRequest<CollectionListResponse>	listCollections()	Get list name of all existing collections.
QDrantClientRequest<SnapshotListResponse>	listCollectionSnapshots(String collectionName)	Get list of snapshots for a collection
QDrantClientRequest<SnapshotListResponse>	listStorageSnapshots()	Get list of snapshots of the whole storage.
QDrantClientRequest<CollectionResponse>	loadCollection(String collectionName)	Get detailed information about specified existing collection.
QDrantClientRequest<UpdateResultResponse>	overwritePayload(String collectionName, PointOverwritePayloadRequest request, boolean wait)	Replace full payload of points with new one.
QDrantClientRequest<PointsRecommendBatchResponse>	recommendBatchPoints(String collectionName, PointsRecommendBatchRequest request)	Look for the points which are closer to stored positive examples and at the same time further to negative examples.
QDrantClientRequest<PointsRecommendResponse>	recommendPoints(String collectionName, PointsRecommendRequest request)	Look for the points which are closer to stored positive examples and at the same time further to negative examples.
QDrantClientRequest<GenericBooleanStatusResponse>	recoverSnapshot(String collectionName, SnapshotRecoverRequest request)	Recover local collection data from a snapshot.
QDrantClientRequest<GenericBooleanStatusResponse>	removePeerFromCluster(String peerId, boolean force)	Tries to remove peer from the cluster.
QDrantClientRequest<PointsScrollResponse>	scrollPoints(String collectionName, PointsScrollRequest request)	Scroll request - paginate over all points which matches given filtering condition.
QDrantClientRequest<PointsSearchBatchResponse>	searchBatchPoints(String collectionName, PointsSearchBatchRequest request)	Retrieve by batch the closest points based on vector similarity and given filtering conditions.
QDrantClientRequest<PointsSearchResponse>	searchPoints(String collectionName, PointsSearchRequest request)	Retrieve closest points based on vector similarity and given filtering conditions.
QDrantClientRequest<LockOptionResponse>	setLockOptions(String errorMessage, boolean lockFlag)	Set lock options.
QDrantClientRequest<UpdateResultResponse>	setPointPayload(String collectionName, PointSetPayloadRequest request, boolean wait)	Set payload values for points.
QDrantClientRequest<GenericBooleanStatusResponse>	updateCollection(String collectionName, CollectionUpdateRequest request, int timeout)	Update parameters of the existing collection.
QDrantClientRequest<GenericBooleanStatusResponse>	updateCollectionAliases(String collectionName, CollectionUpdateAliasesRequest request, int timeout)	Update aliases of the collections.
QDrantClientRequest<GenericBooleanStatusResponse>	updateCollectionClusterSetup(String collectionName, CollectionUpdateClusterSetupRequest request)	Update collection cluster setup.
QDrantClientRequest<UpdateResultResponse>	upsertPoints(String collectionName, PointsUpsertRequest request, boolean wait)	Perform insert + updates on points.

Methods inherited from class io.metaloom.qdrant.client.http.AbstractQDrantClient

getConnectTimeout, getHostname, getPort, getReadTimeout, getScheme, getWriteTimeout

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.metaloom.qdrant.client.http.method.PointMethods

getPoint, getPoint, getPoint

Field Details

log

public static final org.slf4j.Logger log

Constructor Details

QDrantHttpClientImpl

protected QDrantHttpClientImpl(String scheme,
 String hostname,
 int port,
 Duration connectTimeout,
 Duration readTimeout,
 Duration writeTimeout)

Create a new client with a default timeout of 10s for all timeouts (connect, read and write).

Parameters:

scheme -

hostname -

port -

connectTimeout -

readTimeout -

writeTimeout -

Method Details

builder

public static QDrantHttpClientImpl.Builder builder()

init

public void init()

getOkHttpClient

public okhttp3.OkHttpClient getOkHttpClient()

Return the used OK HTTP client.

Returns:

close

public void close()

Description copied from interface: QDrantHttpClient

Close the client and release all resources.

getPoint

public QDrantClientRequest<PointGetResponse> getPoint(String collectionName,
 String pointId)

Description copied from interface: PointMethods

Retrieve full information of single point by id.

Returns:

getPoints

public QDrantClientRequest<PointsGetResponse> getPoints(String collectionName,
 PointsGetRequest request)

Description copied from interface: PointMethods

Retrieve multiple points by specified IDs.

Returns:

upsertPoints

public QDrantClientRequest<UpdateResultResponse> upsertPoints(String collectionName,
 PointsUpsertRequest request,
 boolean wait)

Description copied from interface: PointMethods

Perform insert + updates on points. If point with given ID already exists - it will be overwritten.

Returns:

deletePoints

public QDrantClientRequest<UpdateResultResponse> deletePoints(String collectionName,
 PointsDeleteRequest request,
 boolean wait)

Description copied from interface: PointMethods

Delete points.

Returns:

setPointPayload

public QDrantClientRequest<UpdateResultResponse> setPointPayload(String collectionName,
 PointSetPayloadRequest request,
 boolean wait)

Description copied from interface: PointMethods

Set payload values for points. This will merge the points payload and add new properties or update existing ones.

Returns:

overwritePayload

public QDrantClientRequest<UpdateResultResponse> overwritePayload(String collectionName,
 PointOverwritePayloadRequest request,
 boolean wait)

Description copied from interface: PointMethods

Replace full payload of points with new one. This will overwrite the whole given payload with the new one. Existing properties will be remove.

Returns:

deletePayload

public QDrantClientRequest<UpdateResultResponse> deletePayload(String collectionName,
 PointDeletePayloadRequest request,
 boolean wait)

Description copied from interface: PointMethods

Delete specified key payload for points. This will only delete the specified properties from the found payloads.

Returns:

clearPayload

public QDrantClientRequest<UpdateResultResponse> clearPayload(String collectionName,
 PointsClearPayloadRequest request,
 boolean wait)

Description copied from interface: PointMethods

Remove all payload for specified points. Removes the whole payload from all selected points.

Returns:

scrollPoints

public QDrantClientRequest<PointsScrollResponse> scrollPoints(String collectionName,
 PointsScrollRequest request)

Description copied from interface: PointMethods

Scroll request - paginate over all points which matches given filtering condition.

Returns:

searchPoints

public QDrantClientRequest<PointsSearchResponse> searchPoints(String collectionName,
 PointsSearchRequest request)

Description copied from interface: PointMethods

Retrieve closest points based on vector similarity and given filtering conditions.

Returns:

searchBatchPoints

public QDrantClientRequest<PointsSearchBatchResponse> searchBatchPoints(String collectionName,
 PointsSearchBatchRequest request)

Description copied from interface: PointMethods

Retrieve by batch the closest points based on vector similarity and given filtering conditions.

Returns:

recommendPoints

public QDrantClientRequest<PointsRecommendResponse> recommendPoints(String collectionName,
 PointsRecommendRequest request)

Description copied from interface: PointMethods

Look for the points which are closer to stored positive examples and at the same time further to negative examples.

Returns:

recommendBatchPoints

public QDrantClientRequest<PointsRecommendBatchResponse> recommendBatchPoints(String collectionName,
 PointsRecommendBatchRequest request)

Description copied from interface: PointMethods

Look for the points which are closer to stored positive examples and at the same time further to negative examples.

Returns:

countPoints

public QDrantClientRequest<PointCountResponse> countPoints(String collectionName,
 PointCountRequest request)

Description copied from interface: PointMethods

Count points which matches given filtering condition.

Returns:

getClusterStatusInfo

public QDrantClientRequest<ClusterStatusResponse> getClusterStatusInfo()

Description copied from interface: ClusterMethods

Get information about the current state and composition of the cluster.

Returns:

removePeerFromCluster

public QDrantClientRequest<GenericBooleanStatusResponse> removePeerFromCluster(String peerId,
 boolean force)

Description copied from interface: ClusterMethods

Tries to remove peer from the cluster. Will return an error if peer has shards on it.

Returns:

getCollectionClusterInfo

public QDrantClientRequest<CollectionClusterInfoResponse> getCollectionClusterInfo(String collectionName)

Description copied from interface: ClusterMethods

Get cluster information for a collection.

Returns:

updateCollectionClusterSetup

public QDrantClientRequest<GenericBooleanStatusResponse> updateCollectionClusterSetup(String collectionName,
 CollectionUpdateClusterSetupRequest request)

Description copied from interface: ClusterMethods

Update collection cluster setup.

Returns:

listCollectionSnapshots

public QDrantClientRequest<SnapshotListResponse> listCollectionSnapshots(String collectionName)

Description copied from interface: SnapshotMethods

Get list of snapshots for a collection

Returns:

recoverSnapshot

public QDrantClientRequest<GenericBooleanStatusResponse> recoverSnapshot(String collectionName,
 SnapshotRecoverRequest request)

Description copied from interface: SnapshotMethods

Recover local collection data from a snapshot. This will overwrite any data, stored on this node, for the collection.

Returns:

createCollectionSnapshot

public QDrantClientRequest<SnapshotResponse> createCollectionSnapshot(String collectionName)

Description copied from interface: SnapshotMethods

Create new snapshot for a collection.

Returns:

downloadCollectionSnapshot

public QDrantClientRequest<QDrantBinaryResponse> downloadCollectionSnapshot(String collectionName,
 String snapshotName)

Description copied from interface: SnapshotMethods

Download specified snapshot from a collection as a file.

Returns:

listStorageSnapshots

public QDrantClientRequest<SnapshotListResponse> listStorageSnapshots()

Description copied from interface: SnapshotMethods

Get list of snapshots of the whole storage.

Returns:

createStorageSnapshot

public QDrantClientRequest<SnapshotCreateResponse> createStorageSnapshot()

Description copied from interface: SnapshotMethods

Create new snapshot of the whole storage.

Returns:

downloadStorageSnapshot

public QDrantClientRequest<QDrantBinaryResponse> downloadStorageSnapshot(String snapshotName)

Description copied from interface: SnapshotMethods

Download specified snapshot of the whole storage as a file.

Returns:

collectTelemetry

public QDrantClientRequest<ServiceTelemetryResponse> collectTelemetry(boolean anonymize)

Description copied from interface: ServiceMethods

Collect telemetry data including app info, system info, collections info, cluster info, configs and statistics.

Parameters:

anonymize - If true, anonymize result

Returns:

setLockOptions

public QDrantClientRequest<LockOptionResponse> setLockOptions(String errorMessage,
 boolean lockFlag)

Description copied from interface: ServiceMethods

Set lock options. If write is locked, all write operations and collection creation are forbidden. Returns previous lock options.

Returns:

getLockOptions

public QDrantClientRequest<LockOptionResponse> getLockOptions()

Description copied from interface: ServiceMethods

Get lock options. If write is locked, all write operations and collection creation are forbidden.

Returns:

listCollections

public QDrantClientRequest<CollectionListResponse> listCollections()

Description copied from interface: CollectionMethods

Get list name of all existing collections.

Returns:

loadCollection

public QDrantClientRequest<CollectionResponse> loadCollection(String collectionName)

Description copied from interface: CollectionMethods

Get detailed information about specified existing collection.

Returns:

createCollection

public QDrantClientRequest<GenericBooleanStatusResponse> createCollection(String collectionName,
 CollectionCreateRequest request)

Description copied from interface: CollectionMethods

Create new collection with given parameters.

Returns:

updateCollection

public QDrantClientRequest<GenericBooleanStatusResponse> updateCollection(String collectionName,
 CollectionUpdateRequest request,
 int timeout)

Description copied from interface: CollectionMethods

Update parameters of the existing collection.

Returns:

deleteCollection

public QDrantClientRequest<GenericBooleanStatusResponse> deleteCollection(String collectionName,
 int timeout)

Description copied from interface: CollectionMethods

Drop collection and all associated data.

Returns:

updateCollectionAliases

public QDrantClientRequest<GenericBooleanStatusResponse> updateCollectionAliases(String collectionName,
 CollectionUpdateAliasesRequest request,
 int timeout)

Description copied from interface: CollectionMethods

Update aliases of the collections.

Returns:

createCollectionIndexField

public QDrantClientRequest<CollectionIndexFieldResponse> createCollectionIndexField(String collectionName,
 CollectionCreateIndexFieldRequest request,
 boolean wait)

Description copied from interface: CollectionMethods

Create index for field in collection.

Returns:

deleteCollectionIndexField

public QDrantClientRequest<CollectionIndexFieldResponse> deleteCollectionIndexField(String collectionName,
 String fieldName,
 boolean wait)

Description copied from interface: CollectionMethods

Delete field index for collection.

Returns: