nkv

package module

Go to main page

Versions in this module

v0

v0.6.0

Aug 28, 2026

v0.5.0

Aug 7, 2026

v0.4.1

Aug 6, 2026

v0.4.0

Aug 6, 2026

Changes in this version

type Generic

+ func (t *Generic[T]) Keys(ctx context.Context, pattern string, opts ...KeysOption) iter.Seq2[string, error]

v0.3.0

Aug 6, 2026

Changes in this version

type Generic

+ func (t *Generic[T]) Delete(ctx context.Context, key string, opts ...DeleteOption) error

+ func (t *Generic[T]) Purge(ctx context.Context, key string, opts ...PurgeOption) error

+ func (t *Generic[T]) Watch(ctx context.Context, pattern string, opts ...WatchOption) (*GenericWatcher[T], error)

+ type GenericEntry struct

+ Value T

+ type GenericWatcher struct

+ func (w *GenericWatcher[T]) InitialDone() bool

+ func (w *GenericWatcher[T]) Next() (*GenericEntry[T], error)

+ func (w *GenericWatcher[T]) Stop()

+ func (w *GenericWatcher[T]) Updates() <-chan *GenericEntry[T]

v0.2.0

Aug 6, 2026

Changes in this version

type Entry

+ Delta uint64

v0.1.0

Aug 5, 2026

Changes in this version

+ var ErrDuplicateKey = errors.New("kv: duplicate key in tx")

+ var ErrEmptyTx = errors.New("kv: empty tx")

+ var ErrInvalidKey = errors.New("kv: invalid key")

+ var ErrInvalidOption = errors.New("kv: invalid option")

+ var ErrKeyExists = errors.New("kv: key exists")

+ var ErrKeyNotFound = errors.New("kv: key not found")

+ var ErrRevisionMismatch = errors.New("kv: revision mismatch")

+ var ErrTxClosed = errors.New("kv: tx already committed or aborted")

+ var ErrTxConflict = errors.New("kv: tx conflict")

+ var ErrWatcherStopped = errors.New("kv: watcher stopped")

+ func WithAdditionalKeys(patterns ...string) extraFiltersOption

+ func WithHeaders(h nats.Header) headersOption

+ func WithInactiveThreshold(d time.Duration) inactiveThresholdOption

+ func WithListBatch(n int) listBatchOption

+ func WithPullBatch(n int) pullBatchOption

+ func WithRevision(rev uint64) revisionOption

+ func WithTTL(d time.Duration) ttlOption

+ type Bucket struct

+ func CreateBucket(ctx context.Context, nc *nats.Conn, cfg Config) (*Bucket, error)

+ func Open(ctx context.Context, nc *nats.Conn, bucket string) (*Bucket, error)

+ func (b *Bucket) Create(ctx context.Context, key string, value []byte, opts ...CreateOption) (uint64, error)

+ func (b *Bucket) Delete(ctx context.Context, key string, opts ...DeleteOption) error

+ func (b *Bucket) Get(ctx context.Context, key string, opts ...GetOption) (*Entry, error)

+ func (b *Bucket) IsClusterLocal(ctx context.Context) (bool, error)

+ func (b *Bucket) Keys(ctx context.Context, pattern string, opts ...KeysOption) iter.Seq2[string, error]

+ func (b *Bucket) List(ctx context.Context, pattern string, opts ...ListOption) iter.Seq2[*Entry, error]

+ func (b *Bucket) Name() string

+ func (b *Bucket) Purge(ctx context.Context, key string, opts ...PurgeOption) error

+ func (b *Bucket) Put(ctx context.Context, key string, value []byte, opts ...PutOption) (uint64, error)

+ func (b *Bucket) Status(ctx context.Context) (*jetstream.StreamInfo, error)

+ func (b *Bucket) Stream() string

+ func (b *Bucket) Tx(opts ...TxOption) *Tx

+ func (b *Bucket) Update(ctx context.Context, key string, value []byte, rev uint64, ...) (uint64, error)

+ func (b *Bucket) Watch(ctx context.Context, pattern string, opts ...WatchOption) (*Watcher, error)

+ func (b *Bucket) WatchAll(ctx context.Context, opts ...WatchOption) (*Watcher, error)

+ type Codec struct

+ ContentType string

+ Marshal func(any) ([]byte, error)

+ Unmarshal func([]byte, any) error

+ func JSONCodec() Codec

+ type Config struct

+ Bucket string

+ type CreateOption interface

+ type DeleteOption interface

+ type Entry struct

+ Bucket string

+ ContentType string

+ Created time.Time

+ Headers nats.Header

+ Key string

+ Operation Operation

+ Revision uint64

+ Value []byte

+ func (e *Entry) IsTombstone() bool

+ type Generic struct

+ func NewGeneric[T any](kv *Bucket, opts ...GenericOption) *Generic[T]

+ func (t *Generic[T]) Bucket() *Bucket

+ func (t *Generic[T]) Create(ctx context.Context, key string, value T, opts ...CreateOption) (uint64, error)

+ func (t *Generic[T]) Get(ctx context.Context, key string, opts ...GetOption) (T, uint64, error)

+ func (t *Generic[T]) List(ctx context.Context, pattern string, opts ...ListOption) iter.Seq2[T, error]

+ func (t *Generic[T]) Put(ctx context.Context, key string, value T, opts ...PutOption) (uint64, error)

+ func (t *Generic[T]) Tx(opts ...TxOption) *GenericTx[T]

+ func (t *Generic[T]) Update(ctx context.Context, key string, value T, rev uint64, opts ...UpdateOption) (uint64, error)

+ type GenericOption func(*genericConfig)

+ func WithDefaultTTL(ttl time.Duration) GenericOption

+ func WithFallbackCodec(c Codec) GenericOption

+ func WithPrefix(prefix string) GenericOption

+ func WithReadCodec(c Codec) GenericOption

+ func WithWriteCodec(c Codec) GenericOption

+ type GenericTx struct

+ func NewGenericTx[T any](tx *Tx, opts ...GenericOption) *GenericTx[T]

+ func (g *GenericTx[T]) Abort()

+ func (g *GenericTx[T]) Commit(ctx context.Context) (*TxResult, error)

+ func (g *GenericTx[T]) Create(key string, val T) error

+ func (g *GenericTx[T]) Delete(key string, opts ...DeleteOption) error

+ func (g *GenericTx[T]) Len() int

+ func (g *GenericTx[T]) Purge(key string) error

+ func (g *GenericTx[T]) Put(key string, val T) error

+ func (g *GenericTx[T]) Update(key string, val T, revision uint64) error

+ type GetOption interface

+ type KeysOption interface

+ type ListOption interface

+ func WithDeletes() ListOption

+ type Operation int

+ const OpDelete

+ const OpPurge

+ const OpPut

+ func (o Operation) String() string

+ type PurgeOption interface

+ type PutOption interface

+ type Tx struct

+ func (tx *Tx) Abort()

+ func (tx *Tx) Commit(ctx context.Context) (*TxResult, error)

+ func (tx *Tx) Create(key string, value []byte) error

+ func (tx *Tx) Delete(key string, opts ...DeleteOption) error

+ func (tx *Tx) Len() int

+ func (tx *Tx) Purge(key string) error

+ func (tx *Tx) Put(key string, value []byte) error

+ func (tx *Tx) Update(key string, value []byte, revision uint64) error

+ type TxOption func(*Tx)

+ func WithTxTTL(ttl time.Duration) TxOption

+ type TxResult struct

+ ID string

+ Sequence uint64

+ Size int

+ type TxStageError struct

+ Detail string

+ Key string

+ OpIndex int

+ func (e *TxStageError) Error() string

+ type UpdateOption interface

+ type WatchOption interface

+ func WithMetaOnly() WatchOption

+ func WithUpdatesOnly() WatchOption

+ type Watcher struct

+ func (w *Watcher) InitialDone() bool

+ func (w *Watcher) Next() (*Entry, error)

+ func (w *Watcher) Stop()

+ func (w *Watcher) Updates() <-chan *Entry

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