rostam

package module

Go to main page

Versions in this module

v0

v0.7.0-beta4

Sep 12, 2026

v0.7.0-beta3

Sep 11, 2026

v0.7.0-beta2

Sep 11, 2026

v0.7.0-beta

Sep 10, 2026

v0.6.0

Sep 2, 2026

Changes in this version

type EmbeddedConfig

+ EnableOnlineCompaction bool

+ WriteTimeout time.Duration

type ServerConfig

+ EnableOnlineCompaction bool

+ WriteTimeout time.Duration

v0.5.0

Aug 30, 2026

v0.4.1

Aug 23, 2026

v0.4.0

Aug 23, 2026

Changes in this version

type CacheConfig

+ TTLSweepIntervalMs int

type Store

+ GetInto func(ctx context.Context, key, dst []byte) ([]byte, error)

v0.2.0

Aug 15, 2026

v0.1.4

Aug 14, 2026

v0.1.3

Aug 12, 2026

v0.1.2

Aug 11, 2026

v0.1.1

Aug 11, 2026

v0.1.0

Aug 10, 2026

Changes in this version

+ const FusionDBSF

+ const FusionRRF

+ const FusionWeighted

+ var ErrAliasReservedChar = errors.New("rostam: alias name must not contain reserved characters '#' or '@'")

+ var ErrAliasShadowsCollection = errors.New("rostam: alias name shadows an existing collection")

+ var ErrAliasTargetIsAlias = errors.New("rostam: alias target is itself an alias")

+ var ErrAliasTargetMissing = errors.New("rostam: alias target collection does not exist")

+ var ErrKeyAdminUnavailable = errors.New(...)

+ var ErrNotFound = errors.New("rostam: not found")

+ var ErrNotLeader = errors.New("rostam: not leader")

+ var ErrPartitionedUnsupported = errors.New("rostam: operation not supported on a partitioned collection (Partitions>1)")

+ func SetMetaReadIndexReadTimeout(d time.Duration) (restore func())

+ func SetReshardCutoverGateTimeout(d time.Duration) (restore func())

+ func SetReshardDrainGrace(d time.Duration) (restore func())

+ func WCWire(opName string, innerArgs []byte, opts WriteOpts) (string, []byte)

+ type AliasAction struct

+ Alias string

+ Canonical string

+ Delete bool

+ type BatchGetPoint struct

+ ID uint64

+ Meta VectorMetadata

+ Sparse *VectorSparse

+ TTL time.Duration

+ Vec []float32

+ Version uint64

+ type CacheConfig struct

+ DisableColdCompaction bool

+ Durable bool

+ MaxMemoryBytes int64

+ Mlock bool

+ MsyncIntervalMs int

+ NumShardsPerNode int

+ type ClientConfig struct

+ AuthToken string

+ MaxConnsPerServer int

+ MaxNotLeaderHops int

+ Ops *ops.Registry

+ Servers []string

+ TLSConfig *tls.Config

+ TopologyRefreshInterval time.Duration

+ type DirectConfig struct

+ Authenticator server.Authenticator

+ Cache CacheConfig

+ DataDir string

+ Ops *ops.Registry

+ type DirectServer struct

+ func NewDirectServer(addr string, cfg DirectConfig) (*DirectServer, error)

+ func (s *DirectServer) Addr() string

+ func (s *DirectServer) Close() error

+ type Embedded = embedded

+ type EmbeddedConfig struct

+ Bootstrap bool

+ Cache CacheConfig

+ DataDir string

+ InterNodeServerTLS *tls.Config

+ InterNodeTLS *tls.Config

+ InternalToken string

+ MinISR int

+ NoSync bool

+ NodeCNAllowlist map[string]bool

+ NodeID string

+ NumShards int

+ Ops *ops.Registry

+ PBAutoFailover bool

+ PBCommitPrimary bool

+ PBFrontierStampEvery int

+ PBFrontierStampInterval time.Duration

+ Peers []Peer

+ PersistentVectors bool

+ RaftAddr string

+ RaftElectionMs int

+ RaftHeartbeatMs int

+ RaftLogLevel string

+ RaftTransport string

+ ReplicationFactor int

+ ReplicationMode string

+ VolatileLog bool

+ WASMBlobRetention time.Duration

+ type FanMeta struct

+ Degraded bool

+ Missing []int

+ type FanoutDispatcher = fanoutDispatcher

+ func NewFanoutDispatcher(e *Embedded, inner InnerDispatcher) *FanoutDispatcher

+ func (f *FanoutDispatcher) Partitioned(coll string) (int, uint32, bool)

+ type FusionMethod = vector.FusionMethod

+ type GRPCServer struct

+ func NewGRPCServer(addr string, cfg DirectConfig) (*GRPCServer, error)

+ func (s *GRPCServer) Addr() string

+ func (s *GRPCServer) Close() error

+ type HTTPServer struct

+ func NewHTTPServer(addr string, cfg DirectConfig) (*HTTPServer, error)

+ func (s *HTTPServer) Addr() string

+ func (s *HTTPServer) Close() error

+ type InnerDispatcher = innerDispatcher

+ type MVBatchGetPoint struct

+ ID uint64

+ Meta VectorMetadata

+ Tokens [][]float32

+ Version uint64

+ type MVHybridOpts struct

+ Alpha float64

+ DenseK int

+ Filter VectorFilter

+ MaxStaleness uint64

+ Method FusionMethod

+ OnPartitionUnavailable uint8

+ RRFK int

+ ReadConsistency uint8

+ SparseK int

+ type MVScrollOpts struct

+ MaxStaleness uint64

+ OnPartitionUnavailable uint8

+ OrderBy *vector.OrderBy

+ ReadConsistency uint8

+ type MultiResult = vector.MultiResult

+ type MultiSearchOpts = vector.MultiSearchOpts

+ type MultiVectorConfig = vector.MultiVectorConfig

+ type NamedBatchGetPoint struct

+ ID uint64

+ Meta VectorMetadata

+ TTL time.Duration

+ Vectors map[string][]float32

+ Version uint64

+ type NamedHybridOpts struct

+ Alpha float64

+ DenseK int

+ Filter VectorFilter

+ MaxStaleness uint64

+ Method FusionMethod

+ OnPartitionUnavailable uint8

+ RRFK int

+ ReadConsistency uint8

+ SparseK int

+ type NamedScrollOpts struct

+ MaxStaleness uint64

+ OnPartitionUnavailable uint8

+ OrderBy *vector.OrderBy

+ ReadConsistency uint8

+ type NamedSearchOpts struct

+ Filter VectorFilter

+ MaxStaleness uint64

+ OnPartitionUnavailable uint8

+ ReadConsistency uint8

+ type NamedVectorParams = vector.NamedVectorParams

+ type PartitionCatalog = partitionCatalog

+ type Peer struct

+ NodeID string

+ PBAddr string

+ RaftAddr string

+ ServerAddr string

+ type ReadOpts struct

+ MaxStaleness uint64

+ OnPartitionUnavailable uint8

+ ReadConsistency uint8

+ type RebalanceResult = cluster.RebalanceResult

+ func Reconfigure(ctx context.Context, serverAddrs []string, target []Peer, rf int) (RebalanceResult, error)

+ type ReshardState struct

+ NewGen uint32

+ NewP int

+ OldGen uint32

+ OldP int

+ Status uint8

+ type Server struct

+ func NewServer(cfg ServerConfig) (*Server, error)

+ func (s *Server) Close() error

+ func (s *Server) ClusterNode() *cluster.Node

+ func (s *Server) GRPCAddr() string

+ func (s *Server) HTTPAddr() string

+ func (s *Server) Store() io.Closer

+ func (s *Server) TCPAddr() string

+ func (s *Server) VectorStore() *vector.CollectionStore

+ type ServerConfig struct

+ AccessLog *rlog.AccessLog

+ Admin httpapi.AdminBackend

+ Cluster *EmbeddedConfig

+ EpollLoops int

+ EpollTCP bool

+ GRPCAddr string

+ HTTPAddr string

+ InterNodeServerTLS *tls.Config

+ InterNodeTLS *tls.Config

+ KeyRegistry *vector.KeyRegistry

+ NodeCNAllowlist map[string]bool

+ TCPAddr string

+ TLSConfig *tls.Config

+ type Store interface

+ AliasBatch func(ctx context.Context, actions []AliasAction) error

+ Call func(ctx context.Context, op string, args []byte) ([]byte, error)

+ Close func() error

+ CreateAlias func(ctx context.Context, alias, collection string) error

+ CreateCollection func(ctx context.Context, name string, cfg VectorConfig) error

+ Del func(ctx context.Context, key []byte) (bool, error)

+ DeleteAlias func(ctx context.Context, alias string) error

+ Get func(ctx context.Context, key []byte) ([]byte, error)

+ IsLeader func(key []byte) bool

+ LeaderAddr func(key []byte) string

+ ListAliases func(ctx context.Context, collection string) (map[string]string, error)

+ Put func(ctx context.Context, key, value []byte, ttl time.Duration) error

+ PutBatch func(ctx context.Context, entries []ops.PutEntry) error

+ RegisterWASM func(ctx context.Context, r WASMRegistration, module []byte) (pushReport string, err error)

+ VectorClearPayload func(ctx context.Context, collection string, id uint64, opts ...WriteOpts) (applied bool, err error)

+ VectorDelete func(ctx context.Context, collection string, id uint64, opts ...WriteOpts) (bool, error)

+ VectorDeleteByFilter func(ctx context.Context, collection string, filter VectorFilter) (int, error)

+ VectorDeletePayloadKeys func(ctx context.Context, collection string, id uint64, keys []string, ...) (applied bool, err error)

+ VectorExists func(ctx context.Context, collection string, id uint64) (bool, error)

+ VectorGet func(ctx context.Context, collection string, id uint64, ...) (found bool, vec []float32, meta VectorMetadata, ttl time.Duration, ...)

+ VectorGetBatch func(ctx context.Context, collection string, ids []uint64, ...) (points []BatchGetPoint, missing []uint64, err error)

+ VectorGetExt func(ctx context.Context, collection string, id uint64, ...) (found bool, vec []float32, meta VectorMetadata, ttl time.Duration, ...)

+ VectorHybridSearch func(ctx context.Context, collection string, dense []float32, k int, ...) ([]VectorResult, FanMeta, error)

+ VectorHybridText func(ctx context.Context, collection string, dense []float32, query string, k int, ...) ([]VectorResult, FanMeta, error)

+ VectorInsert func(ctx context.Context, collection string, id uint64, vec []float32, ...) error

+ VectorInsertExt func(ctx context.Context, collection string, id uint64, vec []float32, ...) error

+ VectorInsertIfAbsent func(ctx context.Context, collection string, id uint64, vec []float32, ...) (bool, error)

+ VectorMVAdd func(ctx context.Context, name string, docID uint64, tokens [][]float32, ...) error

+ VectorMVAddIfAbsent func(ctx context.Context, name string, docID uint64, tokens [][]float32, ...) (bool, error)

+ VectorMVClearPayload func(ctx context.Context, name string, docID uint64, opts ...WriteOpts) (applied bool, err error)

+ VectorMVCreateCollection func(ctx context.Context, name string, cfg MultiVectorConfig) error

+ VectorMVDelete func(ctx context.Context, name string, docID uint64, opts ...WriteOpts) (bool, error)

+ VectorMVDeletePayloadKeys func(ctx context.Context, name string, docID uint64, keys []string, ...) (applied bool, err error)

+ VectorMVDropCollection func(ctx context.Context, name string) error

+ VectorMVExists func(ctx context.Context, name string, docID uint64) (bool, error)

+ VectorMVGet func(ctx context.Context, name string, docID uint64, withVector, withPayload bool) (found bool, tokens [][]float32, payload VectorMetadata, err error)

+ VectorMVGetBatch func(ctx context.Context, collection string, ids []uint64, ...) (points []MVBatchGetPoint, missing []uint64, err error)

+ VectorMVGetExt func(ctx context.Context, name string, docID uint64, withVector, withPayload bool, ...) (found bool, tokens [][]float32, payload VectorMetadata, err error)

+ VectorMVHybridSearch func(ctx context.Context, name string, query [][]float32, sparseQ VectorSparse, ...) ([]VectorResult, error)

+ VectorMVHybridSearchExt func(ctx context.Context, name string, query [][]float32, sparseQ VectorSparse, ...) ([]VectorResult, FanMeta, error)

+ VectorMVOverwritePayload func(ctx context.Context, name string, docID uint64, meta VectorMetadata, ...) (applied bool, err error)

+ VectorMVQuery func(ctx context.Context, name string, specBytes []byte, spec vector.QuerySpec, ...) ([]VectorResult, FanMeta, error)

+ VectorMVReshard func(ctx context.Context, collection string, newP int) error

+ VectorMVReshardAbort func(ctx context.Context, collection string) error

+ VectorMVResplit func(ctx context.Context, collection string, newP int) error

+ VectorMVResplitCleanup func(ctx context.Context, collection string) (int, error)

+ VectorMVScroll func(ctx context.Context, name string, filter VectorFilter, limit int, ...) (docs []VectorDocument, meta FanMeta, nextCursor string, err error)

+ VectorMVScrollExt func(ctx context.Context, name string, filter VectorFilter, limit int, ...) (docs []VectorDocument, meta FanMeta, nextCursor string, err error)

+ VectorMVSearch func(ctx context.Context, name string, query [][]float32, k int, ...) ([]MultiResult, FanMeta, error)

+ VectorMVSetPayload func(ctx context.Context, name string, docID uint64, patch VectorMetadata, ...) (applied bool, err error)

+ VectorNamedClearPayload func(ctx context.Context, name string, id uint64, opts ...WriteOpts) (applied bool, err error)

+ VectorNamedCreateCollection func(ctx context.Context, name string, cfg map[string]NamedVectorParams, ...) error

+ VectorNamedDelete func(ctx context.Context, name string, id uint64, opts ...WriteOpts) (bool, error)

+ VectorNamedDeletePayloadKeys func(ctx context.Context, name string, id uint64, keys []string, opts ...WriteOpts) (applied bool, err error)

+ VectorNamedDropCollection func(ctx context.Context, name string) error

+ VectorNamedGet func(ctx context.Context, name string, id uint64, withVector, withPayload bool) (found bool, vectors map[string][]float32, payload VectorMetadata, ...)

+ VectorNamedGetBatch func(ctx context.Context, collection string, ids []uint64, ...) (points []NamedBatchGetPoint, missing []uint64, err error)

+ VectorNamedGetConfig func(ctx context.Context, name string) (map[string]NamedVectorParams, error)

+ VectorNamedGetConfigExt func(ctx context.Context, name string, opts ReadOpts) (map[string]NamedVectorParams, error)

+ VectorNamedGetExt func(ctx context.Context, name string, id uint64, withVector, withPayload bool, ...) (found bool, vectors map[string][]float32, payload VectorMetadata, ...)

+ VectorNamedHybridSearch func(ctx context.Context, name, denseSpace string, denseQ []float32, ...) ([]VectorResult, error)

+ VectorNamedHybridSearchExt func(ctx context.Context, name, denseSpace string, denseQ []float32, ...) ([]VectorResult, FanMeta, error)

+ VectorNamedInsert func(ctx context.Context, name string, id uint64, vectors map[string][]float32, ...) error

+ VectorNamedOverwritePayload func(ctx context.Context, name string, id uint64, meta VectorMetadata, ...) (applied bool, err error)

+ VectorNamedQuery func(ctx context.Context, name string, specBytes []byte, spec vector.QuerySpec, ...) ([]VectorResult, FanMeta, error)

+ VectorNamedScroll func(ctx context.Context, name string, filter VectorFilter, limit int, ...) (docs []VectorDocument, nextCursor string, err error)

+ VectorNamedScrollExt func(ctx context.Context, name string, filter VectorFilter, limit int, ...) (docs []VectorDocument, nextCursor string, err error)

+ VectorNamedSearch func(ctx context.Context, name, vectorName string, query []float32, k int, ...) ([]VectorResult, error)

+ VectorNamedSearchDocs func(ctx context.Context, name, vectorName string, query []float32, k int, ...) ([]VectorDocument, error)

+ VectorNamedSearchDocsExt func(ctx context.Context, name, vectorName string, query []float32, k int, ...) ([]VectorDocument, error)

+ VectorNamedSearchExt func(ctx context.Context, name, vectorName string, query []float32, k int, ...) ([]VectorResult, error)

+ VectorNamedSetPayload func(ctx context.Context, name string, id uint64, patch VectorMetadata, ...) (applied bool, err error)

+ VectorNamedSparseSearch func(ctx context.Context, name, space string, query VectorSparse, k int, ...) ([]VectorResult, error)

+ VectorNamedSparseSearchExt func(ctx context.Context, name, space string, query VectorSparse, k int, ...) ([]VectorResult, error)

+ VectorOverwritePayload func(ctx context.Context, collection string, id uint64, meta VectorMetadata, ...) (applied bool, err error)

+ VectorQuery func(ctx context.Context, collection string, specBytes []byte, ...) ([]VectorResult, FanMeta, error)

+ VectorQueryGrouped func(ctx context.Context, collection string, specBytes []byte, ...) ([]VectorGroup, FanMeta, error)

+ VectorReshard func(ctx context.Context, collection string, newP int) error

+ VectorReshardAbort func(ctx context.Context, collection string) error

+ VectorResplit func(ctx context.Context, collection string, newP int) error

+ VectorResplitCleanup func(ctx context.Context, collection string) (int, error)

+ VectorScroll func(ctx context.Context, collection string, filter VectorFilter, limit int, ...) (docs []VectorDocument, meta FanMeta, nextCursor string, err error)

+ VectorSearch func(ctx context.Context, collection string, query []float32, k int) ([]VectorResult, error)

+ VectorSearchDocs func(ctx context.Context, collection string, query []float32, k int, ...) ([]VectorDocument, FanMeta, error)

+ VectorSearchExt func(ctx context.Context, collection string, query []float32, k int, ...) ([]VectorResult, FanMeta, error)

+ VectorSearchGroups func(ctx context.Context, collection string, query []float32, k int, ...) ([]VectorGroup, FanMeta, error)

+ VectorSearchInto func(ctx context.Context, collection string, query []float32, k int, ...) ([]VectorResult, error)

+ VectorSearchText func(ctx context.Context, collection string, query string, k int, ...) ([]VectorDocument, FanMeta, error)

+ VectorSetPayload func(ctx context.Context, collection string, id uint64, patch VectorMetadata, ...) (applied bool, err error)

+ VectorUpsert func(ctx context.Context, collection string, id uint64, vec []float32, ...) error

+ func NewClient(cfg ClientConfig) (Store, error)

+ func NewDirect(cfg DirectConfig) (Store, error)

+ func NewEmbedded(cfg EmbeddedConfig) (Store, error)

+ type VectorConfig = vector.Config

+ type VectorDocument = vector.Document

+ type VectorFilter = vector.Filter

+ type VectorGroup = vector.Group

+ type VectorGroupOpts = vector.GroupOpts

+ type VectorHybridOpts struct

+ Alpha float64

+ DenseK int

+ Filter VectorFilter

+ GlobalIDF bool

+ MaxStaleness uint64

+ Method FusionMethod

+ OnPartitionUnavailable uint8

+ RRFK int

+ ReadConsistency uint8

+ Sparse VectorSparse

+ SparseK int

+ type VectorInsertOpts struct

+ KeyTTLMs map[string]int64

+ Metadata VectorMetadata

+ Sparse VectorSparse

+ TTL time.Duration

+ type VectorMetadata = vector.Metadata

+ type VectorResult = vector.Result

+ type VectorScrollOpts struct

+ Cursor string

+ MaxStaleness uint64

+ OnPartitionUnavailable uint8

+ OrderBy *vector.OrderBy

+ ReadConsistency uint8

+ type VectorSearchOpts struct

+ Filter VectorFilter

+ GlobalIDF bool

+ MaxStaleness uint64

+ OnPartitionUnavailable uint8

+ ReadConsistency uint8

+ type VectorSparse = vector.SparseVector

+ type WASMRegistration = ops.WASMRegistration

+ type WriteOpts struct

+ ExpectedVersion *uint64

+ KeyTTLMs map[string]int64

+ Sparse *VectorSparse

+ Wait *bool

+ WriteConsistencyFactor uint8

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL