client

Documentation

Overview

Package client provides vald component client interfaces

Index

• type BackupMetaVector
• type Client
• type ControlCreateIndexRequest
• type Empty
• type Indexer
• type InfoIndex
• type MetaObject
• type MetaObjectReader
• type ObjectDistance
• type ObjectID
• type ObjectIDs
• type ObjectReader
• type ObjectVector
• type ObjectVectors
• type Reader
• type SearchConfig
• type SearchIDRequest
• type SearchRequest
• type SearchResponse
• type Upserter
• type Writer

Types

type BackupMetaVector

type BackupMetaVector = payload.Backup_MetaVector

type Client

type Client interface {
	Reader
	Writer
}

type ControlCreateIndexRequest

type ControlCreateIndexRequest = payload.Control_CreateIndexRequest

type Empty

type Empty = payload.Empty

type Indexer

type Indexer interface {
	CreateIndex(context.Context, *ControlCreateIndexRequest) error
	SaveIndex(context.Context) error
	CreateAndSaveIndex(context.Context, *ControlCreateIndexRequest) error
	IndexInfo(context.Context) (*InfoIndex, error)
}

type InfoIndex

type InfoIndex = payload.Info_Index

type MetaObject

type MetaObject = payload.Backup_MetaVector

type MetaObjectReader

type MetaObjectReader interface {
	GetObject(context.Context, *ObjectID) (*MetaObject, error)
	StreamGetObject(context.Context, func() *ObjectID, func(*MetaObject, error)) error
}

type ObjectDistance

type ObjectDistance = payload.Object_Distance

type ObjectID

type ObjectID = payload.Object_ID

type ObjectIDs

type ObjectIDs = payload.Object_IDs

type ObjectReader

type ObjectReader interface {
	GetObject(context.Context, *ObjectID) (*ObjectVector, error)
	StreamGetObject(context.Context, func() *ObjectID, func(*ObjectVector, error)) error
}

type ObjectVector

type ObjectVector = payload.Object_Vector

type ObjectVectors

type ObjectVectors = payload.Object_Vectors

type Reader

type Reader interface {
	Exists(context.Context, *ObjectID) (*ObjectID, error)
	Search(context.Context, *SearchRequest) (*SearchResponse, error)
	SearchByID(context.Context, *SearchIDRequest) (*SearchResponse, error)
	StreamSearch(context.Context, func() *SearchRequest, func(*SearchResponse, error)) error
	StreamSearchByID(context.Context, func() *SearchIDRequest, func(*SearchResponse, error)) error
}

type SearchConfig

type SearchConfig = payload.Search_Config

type SearchIDRequest

type SearchIDRequest = payload.Search_IDRequest

type SearchRequest

type SearchRequest = payload.Search_Request

type SearchResponse

type SearchResponse = payload.Search_Response

type Upserter

type Upserter interface {
	Upsert(context.Context, *ObjectVector) error
	MultiUpsert(context.Context, *ObjectVectors) error
	StreamUpsert(context.Context, func() *ObjectVector, func(error)) error
}

type Writer

type Writer interface {
	Insert(context.Context, *ObjectVector) error
	StreamInsert(context.Context, func() *ObjectVector, func(error)) error
	MultiInsert(context.Context, *ObjectVectors) error
	Update(context.Context, *ObjectVector) error
	StreamUpdate(context.Context, func() *ObjectVector, func(error)) error
	MultiUpdate(context.Context, *ObjectVectors) error
	Remove(context.Context, *ObjectID) error
	StreamRemove(context.Context, func() *ObjectID, func(error)) error
	MultiRemove(context.Context, *ObjectIDs) error
}