Documentation
¶
Overview ¶
Package service manages the main logic of server.
Package service manages the main logic of server.
Index ¶
- type NGT
- type Option
- func WithAutoIndexCheckDuration(dur string) Option
- func WithAutoIndexDurationLimit(dur string) Option
- func WithAutoIndexLength(l int) Option
- func WithAutoSaveIndexDuration(dur string) Option
- func WithCopyOnWrite(enabled bool) Option
- func WithDefaultEpsilon(epsilon float32) Option
- func WithDefaultPoolSize(ps uint32) Option
- func WithDefaultRadius(rad float32) Option
- func WithEnableInMemoryMode(enabled bool) Option
- func WithEnableStatistics(enabled bool) Option
- func WithErrGroup(eg errgroup.Group) Option
- func WithExportIndexInfoDuration(dur string) Option
- func WithIndexPath(path string) Option
- func WithInitialDelayMaxDuration(dur string) Option
- func WithIsReadReplica(isReadReplica bool) Option
- func WithLoadIndexTimeoutFactor(dur string) Option
- func WithMaxLoadIndexTimeout(dur string) Option
- func WithMinLoadIndexTimeout(dur string) Option
- func WithPatcher(p client.Patcher) Option
- func WithProactiveGC(enabled bool) Option
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type NGT ¶
type NGT interface {
Start(ctx context.Context) <-chan error
Search(ctx context.Context, vec []float32, size uint32, epsilon, radius float32) (*payload.Search_Response, error)
SearchByID(ctx context.Context, uuid string, size uint32, epsilon, radius float32) ([]float32, *payload.Search_Response, error)
LinearSearch(ctx context.Context, vec []float32, size uint32) (*payload.Search_Response, error)
LinearSearchByID(ctx context.Context, uuid string, size uint32) ([]float32, *payload.Search_Response, error)
Insert(uuid string, vec []float32) (err error)
InsertWithTime(uuid string, vec []float32, t int64) (err error)
InsertMultiple(vecs map[string][]float32) (err error)
InsertMultipleWithTime(vecs map[string][]float32, t int64) (err error)
Update(uuid string, vec []float32) (err error)
UpdateWithTime(uuid string, vec []float32, t int64) (err error)
UpdateMultiple(vecs map[string][]float32) (err error)
UpdateMultipleWithTime(vecs map[string][]float32, t int64) (err error)
UpdateTimestamp(uuid string, ts int64, force bool) (err error)
Delete(uuid string) (err error)
DeleteWithTime(uuid string, t int64) (err error)
DeleteMultiple(uuids ...string) (err error)
DeleteMultipleWithTime(uuids []string, t int64) (err error)
RegenerateIndexes(ctx context.Context) (err error)
GetObject(uuid string) (vec []float32, timestamp int64, err error)
ListObjectFunc(ctx context.Context, f func(uuid string, oid uint32, timestamp int64) bool)
Exists(uuid string) (uint32, bool)
CreateIndex(ctx context.Context, poolSize uint32) (err error)
SaveIndex(ctx context.Context) (err error)
CreateAndSaveIndex(ctx context.Context, poolSize uint32) (err error)
IsIndexing() bool
IsFlushing() bool
IsSaving() bool
Len() uint64
NumberOfCreateIndexExecution() uint64
NumberOfProactiveGCExecution() uint64
UUIDs(context.Context) (uuids []string)
InsertVQueueBufferLen() uint64
DeleteVQueueBufferLen() uint64
GetDimensionSize() int
BrokenIndexCount() uint64
IndexStatistics() (*payload.Info_Index_Statistics, error)
IsStatisticsEnabled() bool
IndexProperty() (*payload.Info_Index_Property, error)
Close(ctx context.Context) error
}
type Option ¶ added in v0.0.47
type Option func(n *ngt) error
Option represent the functional option for ngt.
func WithAutoIndexCheckDuration ¶ added in v0.0.47
WithAutoIndexCheckDuration returns the functional option to set the index check duration.
func WithAutoIndexDurationLimit ¶ added in v0.0.47
WithAutoIndexDurationLimit returns the functional option to set the auto index duration limit.
func WithAutoIndexLength ¶ added in v0.0.47
WithAutoIndexLength returns the functional option to set the auto index length.
func WithAutoSaveIndexDuration ¶ added in v0.0.47
WithAutoSaveIndexDuration returns the functional option to set the auto save index duration.
func WithCopyOnWrite ¶ added in v1.5.0
WithCopyOnWrite returns the functional option to set the CoW enable flag.
func WithDefaultEpsilon ¶ added in v0.0.47
WithDefaultEpsilon returns the functional option to set the default epsilon for NGT.
func WithDefaultPoolSize ¶ added in v0.0.47
WithDefaultPoolSize returns the functional option to set the default pool size for NGT.
func WithDefaultRadius ¶ added in v0.0.47
WithDefaultRadius returns the functional option to set the default radius for NGT.
func WithEnableInMemoryMode ¶ added in v0.0.47
WithEnableInMemoryMode returns the functional option to set the in memory mode flag.
func WithEnableStatistics ¶ added in v1.7.13
WithEnableStatistics returns the functional option to set the statistics flag.
func WithErrGroup ¶ added in v0.0.47
WithErrGroup returns the functional option to set the error group.
func WithExportIndexInfoDuration ¶ added in v1.7.12
WithExportIndexInfoDuration returns the functional option to set the duration of exporting index info to k8s.
func WithIndexPath ¶ added in v0.0.47
WithIndexPath returns the functional option to set the index path of the NGT.
func WithInitialDelayMaxDuration ¶ added in v0.0.47
WithInitialDelayMaxDuration returns the functional option to set the initial delay duration.
func WithIsReadReplica ¶ added in v1.7.11
WithIsReadReplica returns the functional option to set the read replica flag.
func WithLoadIndexTimeoutFactor ¶ added in v0.0.47
WithLoadIndexTimeoutFactor returns the functional option to set the factor of load index timeout.
func WithMaxLoadIndexTimeout ¶ added in v0.0.47
WithMaxLoadIndexTimeout returns the functional option to set the maximum load index timeout.
func WithMinLoadIndexTimeout ¶ added in v0.0.47
WithMinLoadIndexTimeout returns the functional option to set the minimal load index timeout.
func WithPatcher ¶ added in v1.7.13
WithPatcher returns the functional option to set the patcher for patching k8s resources.
func WithProactiveGC ¶ added in v0.0.56
WithProactiveGC returns the functional option to set the proactive GC enable flag.
Source Files