kvstore

type Config struct {
	// Plugin selects the client implementation.
	Plugin string `json:"plugin" yaml:"plugin"`

	// Database allows multiple isolated stores to be kept in one backend, if supported.
	Database string `json:"database,omitempty" yaml:"database,omitempty"`

	// Table is analogous to a table in database backends or a key prefix in KV backends
	Table string `json:"table,omitempty" yaml:"table,omitempty"`
}

type ConfigType interface {
	// contains filtered or unexported methods
}

type DeleteOption func(d *DeleteOptions)

type DeleteOptions struct {
	Database, Table string
}

type Deprecated interface {
	// Read takes a single key and optional ReadOptions. It returns matching []*Record or an error.
	// If no Record is found, ErrNotFound is returned.
	// Deprecated: use Get instead.
	Read(key string, opts ...ReadOption) ([]*Record, error)
	// Write takes a single key and value, and optional WriteOptions.
	// Deprecated: use Set instead.
	Write(r *Record, opts ...WriteOption) error
	// Delete purges the record with the corresponding key from the store.
	// Deprecated: use Purge instead.
	Delete(key string, opts ...DeleteOption) error
	// List returns any keys that match, or an empty list with no error if none matched.
	// Deprecated: use Keys instead.
	List(opts ...ListOption) ([]string, error)
}

type GetOption func(g *GetOptions)

type GetOptions struct {
	// Prefix returns all records that are prefixed with key
	Prefix bool
	// Suffix returns all records that have the suffix key
	Suffix bool
	// Limit limits the number of returned records
	Limit uint
	// Offset when combined with Limit supports pagination
	Offset uint
}

type KVStore interface {
	types.Component

	Deprecated

	// Get takes a key, database, table and optional GetOptions. It returns the Record or an error.
	// Leave database and/or table empty to use the defaults.
	Get(key, database, table string, opts ...GetOption) ([]Record, error)

	// Set takes a key, database, table and data, and optional SetOptions.
	// Leave database and/or table empty to use the defaults.
	Set(key, database, table string, data []byte, opts ...SetOption) error

	// Purge takes a key, database and table and purges it.
	// Leave database and/or table empty to use the defaults.
	Purge(key, database, table string) error

	// Keys returns any keys that match, or an empty list with no error if none matched.
	// Leave database and/or table empty to use the defaults.
	Keys(database, table string, opts ...KeysOption) ([]string, error)

	// DropTable drops the table.
	// Leave database and/or table empty to use the defaults.
	DropTable(database, table string) error

	// DropDatabase drops the database.
	// Leave database empty to use the default.
	DropDatabase(database string) error
}

type KeysOption func(k *KeysOptions)

type KeysOptions struct {
	// Prefix returns all keys that are prefixed with key
	Prefix string
	// Suffix returns all keys that end with key
	Suffix string
	// Limit limits the number of returned keys
	Limit uint
	// Offset when combined with Limit supports pagination
	Offset uint
}

type ListOption func(l *ListOptions)

type ListOptions struct {
	// List from the following
	Database, Table string
	// Prefix returns all keys that are prefixed with key
	Prefix string
	// Suffix returns all keys that end with key
	Suffix string
	// Limit limits the number of returned keys
	Limit uint
	// Offset when combined with Limit supports pagination
	Offset uint
}

type Option func(ConfigType)

type ProviderFunc func(
	configData map[string]any,
	logger log.Logger,
	opts ...Option,
) (Type, error)

type ReadOption func(r *ReadOptions)

type ReadOptions struct {
	Database, Table string
	// Prefix returns all keys that are prefixed with key
	Prefix string
	// Suffix returns all keys that end with key
	Suffix string
	// Limit limits the number of returned keys
	Limit uint
	// Offset when combined with Limit supports pagination
	Offset uint
}

type Record struct {
	// The key to store the record.
	Key string `json:"key"`
	// The value within the record.
	Value []byte `json:"value"`
	// Time when the record expires a nil value means no expiry.
	Expiry *time.Time `json:"expiry,omitempty"`
}

type SetOption func(s *SetOptions)

type SetOptions struct {
	// Expiry is the time the record expires
	Expiry time.Time
	// TTL is the time until the record expires
	TTL time.Duration
}

type Type struct {
	KVStore
}

type WatchEvent struct {
	Record

	// Operation is the type of operation that occurred.
	Operation WatchOp
}

type WatchOp uint8

type WatchOption func(o *WatchOptions)

type WatchOptions struct {
	// Do not send delete markers to the update channel.
	IgnoreDeletes bool
	// Include all history per subject, not just last one.
	IncludeHistory bool
	// Include only updates for keys.
	UpdatesOnly bool
	// retrieve only the meta data of the entry
	MetaOnly bool
}

type Watcher interface {
	// Watch starts a watcher for the given database and table.
	// Returns a channel of WatchUpdate and a function to stop the watcher.
	// If an error occurs, it is returned.
	Watch(ctx context.Context, database, table string, opts ...WatchOption) (<-chan WatchEvent, func() error, error)
}

type WriteOption func(w *WriteOptions)

type WriteOptions struct {
	// Expiry is the time the record expires
	Expiry          time.Time
	Database, Table string
	// TTL is the time until the record expires
	TTL time.Duration
}