clients

package
v1.38.13 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 27, 2026 License: BSD-3-Clause Imports: 47 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	ABORT_TIMEOUT_VALUE  = 5
	COMMIT_TIMEOUT_VALUE = 90
	QUERY_TIMEOUT_VALUE  = 20
)
View Source 
const (
	NO_RETRIES  = 0
	MAX_RETRIES = 9
)

Variables

This section is empty.

Functions

func AsyncReplicationTargetNodeEndpoint added in v1.32.0 

func AsyncReplicationTargetNodeEndpoint(indexName, shardName string) string

func NewGRPCReplicationClient added in v1.37.0 

func NewGRPCReplicationClient(connManager *grpcconn.ConnManager) *grpcReplicationClient

NewGRPCReplicationClient creates a new gRPC-based replication client.

func NewReplicationClient 

func NewReplicationClient(httpClient *http.Client) (*replicationClient, error)

func NewSwitchReplicationClient added in v1.37.0 

func NewSwitchReplicationClient(
	grpcClient *grpcReplicationClient,
	restClient *replicationClient,
	useGRPC func() bool,
) *switchReplicationClient

NewSwitchReplicationClient creates a client that routes all calls to gRPC when useGRPC returns true, or REST when false.

Types

type ClusterBackups 

type ClusterBackups struct {
	// contains filtered or unexported fields
}

func NewClusterBackups 

func NewClusterBackups(client *http.Client) *ClusterBackups

func (*ClusterBackups) Abort 

func (c *ClusterBackups) Abort(_ context.Context,
	host string, req *backup.AbortRequest,
) error

func (*ClusterBackups) CanCommit 

func (c *ClusterBackups) CanCommit(ctx context.Context,
	host string, req *backup.Request,
) (*backup.CanCommitResponse, error)

func (*ClusterBackups) Commit 

func (c *ClusterBackups) Commit(ctx context.Context,
	host string, req *backup.StatusRequest,
) error

func (*ClusterBackups) Status 

func (c *ClusterBackups) Status(ctx context.Context,
	host string, req *backup.StatusRequest,
) (*backup.StatusResponse, error)

type ClusterClassifications 

type ClusterClassifications struct {
	// contains filtered or unexported fields
}

func NewClusterClassifications 

func NewClusterClassifications(httpClient *http.Client) *ClusterClassifications

func (*ClusterClassifications) AbortTransaction 

func (c *ClusterClassifications) AbortTransaction(ctx context.Context, host string,
	tx *cluster.Transaction,
) error

func (*ClusterClassifications) CommitTransaction 

func (c *ClusterClassifications) CommitTransaction(ctx context.Context, host string,
	tx *cluster.Transaction,
) error

func (*ClusterClassifications) OpenTransaction 

func (c *ClusterClassifications) OpenTransaction(ctx context.Context, host string,
	tx *cluster.Transaction,
) error

type ClusterExports added in v1.37.0 

type ClusterExports struct {
	// contains filtered or unexported fields
}

ClusterExports handles inter-node export communication.

func NewClusterExports added in v1.37.0 

func NewClusterExports(client *http.Client) *ClusterExports

NewClusterExports creates a new cluster exports client

func (*ClusterExports) Abort added in v1.37.0 

func (c *ClusterExports) Abort(ctx context.Context, host, exportID string) error

Abort tells a participant to release its reservation.

func (*ClusterExports) Commit added in v1.37.0 

func (c *ClusterExports) Commit(ctx context.Context, host, exportID string) error

Commit tells a participant to start the export.

func (*ClusterExports) IsRunning added in v1.37.0 

func (c *ClusterExports) IsRunning(ctx context.Context, host, exportID string) (bool, error)

IsRunning checks whether a participant node is still running the given export.

func (*ClusterExports) Prepare added in v1.37.0 

func (c *ClusterExports) Prepare(ctx context.Context, host string, req *export.ExportRequest) error

Prepare asks a participant to reserve its export slot.

type HTTPError added in v1.38.0 

type HTTPError struct {
	Code int
	Body []byte
}

HTTPError is returned on a non-success response. Error() keeps the original "status code: N, error: ..." format.

func AsHTTPError added in v1.38.0 

func AsHTTPError(err error) (*HTTPError, bool)

AsHTTPError returns the *HTTPError in err's chain, if any.

func (*HTTPError) Error added in v1.38.0 

func (e *HTTPError) Error() string

type RemoteIndex 

type RemoteIndex struct {
	// contains filtered or unexported fields
}

func NewRemoteIndex 

func NewRemoteIndex(httpClient *http.Client) *RemoteIndex

func (*RemoteIndex) AddAsyncReplicationTargetNode added in v1.31.0 

func (c *RemoteIndex) AddAsyncReplicationTargetNode(
	ctx context.Context,
	hostName, indexName, shardName string,
	targetNodeOverride additional.AsyncReplicationTargetNodeOverride,
	schemaVersion uint64,
) error

AddAsyncReplicationTargetNode configures and starts async replication for the given host with the specified override.

func (*RemoteIndex) Aggregate 

func (c *RemoteIndex) Aggregate(ctx context.Context, hostName, index,
	shard string, params aggregation.Params,
) (*aggregation.Result, error)

func (*RemoteIndex) BatchAddReferences 

func (c *RemoteIndex) BatchAddReferences(ctx context.Context, hostName, indexName,
	shardName string, refs objects.BatchReferences, schemaVersion uint64,
) []error

func (*RemoteIndex) BatchPutObjects 

func (c *RemoteIndex) BatchPutObjects(ctx context.Context, host, index,
	shard string, objs []*storobj.Object, _ *additional.ReplicationProperties, schemaVersion uint64,
) []error

func (*RemoteIndex) CreateShard 

func (c *RemoteIndex) CreateShard(ctx context.Context,
	hostName, indexName, shardName string,
) error

func (*RemoteIndex) DeleteObject 

func (c *RemoteIndex) DeleteObject(ctx context.Context, hostName, indexName,
	shardName string, id strfmt.UUID, deletionTime time.Time, schemaVersion uint64,
) error

func (*RemoteIndex) DeleteObjectBatch 

func (c *RemoteIndex) DeleteObjectBatch(ctx context.Context, hostName, indexName, shardName string,
	uuids []strfmt.UUID, deletionTime time.Time, dryRun bool, schemaVersion uint64,
) objects.BatchSimpleObjects

func (*RemoteIndex) Exists 

func (c *RemoteIndex) Exists(ctx context.Context, hostName, indexName,
	shardName string, id strfmt.UUID,
) (bool, error)

func (*RemoteIndex) FindUUIDs added in v1.22.8 

func (c *RemoteIndex) FindUUIDs(ctx context.Context, hostName, indexName,
	shardName string, filters *filters.LocalFilter, limit int,
) ([]strfmt.UUID, error)

func (*RemoteIndex) GetObject 

func (c *RemoteIndex) GetObject(ctx context.Context, hostName, indexName,
	shardName string, id strfmt.UUID, selectProps search.SelectProperties,
	additional additional.Properties,
) (*storobj.Object, error)

func (*RemoteIndex) GetShardQueueSize added in v1.22.0 

func (c *RemoteIndex) GetShardQueueSize(ctx context.Context,
	hostName, indexName, shardName string,
) (int64, error)

func (*RemoteIndex) GetShardStatus 

func (c *RemoteIndex) GetShardStatus(ctx context.Context,
	hostName, indexName, shardName string,
) (string, error)

func (*RemoteIndex) MergeObject 

func (c *RemoteIndex) MergeObject(ctx context.Context, hostName, indexName,
	shardName string, mergeDoc objects.MergeDocument, schemaVersion uint64,
) error

func (*RemoteIndex) MultiGetObjects 

func (c *RemoteIndex) MultiGetObjects(ctx context.Context, hostName, indexName,
	shardName string, ids []strfmt.UUID,
) ([]*storobj.Object, error)

func (*RemoteIndex) PutFile 

func (c *RemoteIndex) PutFile(ctx context.Context, hostName, indexName,
	shardName, fileName string, payload io.ReadSeekCloser,
) error

func (*RemoteIndex) PutObject 

func (c *RemoteIndex) PutObject(ctx context.Context, host, index,
	shard string, obj *storobj.Object, schemaVersion uint64,
) error

func (*RemoteIndex) ReInitShard 

func (c *RemoteIndex) ReInitShard(ctx context.Context,
	hostName, indexName, shardName string,
) error

func (*RemoteIndex) RemoveAsyncReplicationTargetNode added in v1.31.0 

func (c *RemoteIndex) RemoveAsyncReplicationTargetNode(
	ctx context.Context,
	hostName, indexName, shardName string,
	targetNodeOverride additional.AsyncReplicationTargetNodeOverride,
) error

RemoveAsyncReplicationTargetNode removes the given target node override for async replication.

func (*RemoteIndex) SearchShard 

func (c *RemoteIndex) SearchShard(ctx context.Context, host, index, shard string,
	vector []models.Vector,
	targetVector []string,
	distance float32,
	limit int,
	filters *filters.LocalFilter,
	keywordRanking *searchparams.KeywordRanking,
	sort []filters.Sort,
	cursor *filters.Cursor,
	groupBy *searchparams.GroupBy,
	additional additional.Properties,
	targetCombination *dto.TargetCombination,
	properties []string,
) ([]*storobj.Object, []float32, []helpers.ShardQueryProfile, error)

func (*RemoteIndex) UpdateShardStatus 

func (c *RemoteIndex) UpdateShardStatus(ctx context.Context, hostName, indexName, shardName,
	targetStatus string, schemaVersion uint64,
) error

type RemoteNode 

type RemoteNode struct {
	// contains filtered or unexported fields
}

func NewRemoteNode 

func NewRemoteNode(httpClient *http.Client) *RemoteNode

func (*RemoteNode) GetNodeStatus 

func (c *RemoteNode) GetNodeStatus(ctx context.Context, hostName, className, shardName, output string) (*models.NodeStatus, error)

func (*RemoteNode) GetStatistics added in v1.25.0 

func (c *RemoteNode) GetStatistics(ctx context.Context, hostName string) (*models.Statistics, error)

type RemoteUser added in v1.30.1 

type RemoteUser struct {
	// contains filtered or unexported fields
}

func NewRemoteUser added in v1.30.1 

func NewRemoteUser(httpClient *http.Client, nodeResolver nodeResolver) *RemoteUser

func (*RemoteUser) GetAndUpdateLastUsedTime added in v1.30.1 

func (c *RemoteUser) GetAndUpdateLastUsedTime(ctx context.Context, nodeName string, users map[string]time.Time, returnStatus bool) (*apikey.UserStatusResponse, error)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.