Initial QSfera import

Server/vendor/go-micro.dev/v4/store/options.go

@@ -0,0 +1,229 @@
+package store
+
+import (
+	"context"
+	"time"
+
+	"go-micro.dev/v4/client"
+	"go-micro.dev/v4/logger"
+)
+
+// Options contains configuration for the Store.
+type Options struct {
+	// Context should contain all implementation specific options, using context.WithValue.
+	Context context.Context
+	// Client to use for RPC
+	Client client.Client
+	// Logger is the underline logger
+	Logger logger.Logger
+	// Database allows multiple isolated stores to be kept in one backend, if supported.
+	Database string
+	// Table is analogous to a table in database backends or a key prefix in KV backends
+	Table string
+	// Nodes contains the addresses or other connection information of the backing storage.
+	// For example, an etcd implementation would contain the nodes of the cluster.
+	// A SQL implementation could contain one or more connection strings.
+	Nodes []string
+}
+
+// Option sets values in Options.
+type Option func(o *Options)
+
+// Nodes contains the addresses or other connection information of the backing storage.
+// For example, an etcd implementation would contain the nodes of the cluster.
+// A SQL implementation could contain one or more connection strings.
+func Nodes(a ...string) Option {
+	return func(o *Options) {
+		o.Nodes = a
+	}
+}
+
+// Database allows multiple isolated stores to be kept in one backend, if supported.
+func Database(db string) Option {
+	return func(o *Options) {
+		o.Database = db
+	}
+}
+
+func Table(t string) Option {
+	return func(o *Options) {
+		o.Table = t
+	}
+}
+
+// WithContext sets the stores context, for any extra configuration.
+func WithContext(c context.Context) Option {
+	return func(o *Options) {
+		o.Context = c
+	}
+}
+
+// WithClient sets the stores client to use for RPC.
+func WithClient(c client.Client) Option {
+	return func(o *Options) {
+		o.Client = c
+	}
+}
+
+// WithLogger sets the underline logger.
+func WithLogger(l logger.Logger) Option {
+	return func(o *Options) {
+		o.Logger = l
+	}
+}
+
+// ReadOptions configures an individual Read operation.
+type ReadOptions struct {
+	Database, Table string
+	// 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
+}
+
+// ReadOption sets values in ReadOptions.
+type ReadOption func(r *ReadOptions)
+
+// ReadFrom the database and table.
+func ReadFrom(database, table string) ReadOption {
+	return func(r *ReadOptions) {
+		r.Database = database
+		r.Table = table
+	}
+}
+
+// ReadPrefix returns all records that are prefixed with key.
+func ReadPrefix() ReadOption {
+	return func(r *ReadOptions) {
+		r.Prefix = true
+	}
+}
+
+// ReadSuffix returns all records that have the suffix key.
+func ReadSuffix() ReadOption {
+	return func(r *ReadOptions) {
+		r.Suffix = true
+	}
+}
+
+// ReadLimit limits the number of responses to l.
+func ReadLimit(l uint) ReadOption {
+	return func(r *ReadOptions) {
+		r.Limit = l
+	}
+}
+
+// ReadOffset starts returning responses from o. Use in conjunction with Limit for pagination.
+func ReadOffset(o uint) ReadOption {
+	return func(r *ReadOptions) {
+		r.Offset = o
+	}
+}
+
+// WriteOptions configures an individual Write operation
+// If Expiry and TTL are set TTL takes precedence.
+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
+}
+
+// WriteOption sets values in WriteOptions.
+type WriteOption func(w *WriteOptions)
+
+// WriteTo the database and table.
+func WriteTo(database, table string) WriteOption {
+	return func(w *WriteOptions) {
+		w.Database = database
+		w.Table = table
+	}
+}
+
+// WriteExpiry is the time the record expires.
+func WriteExpiry(t time.Time) WriteOption {
+	return func(w *WriteOptions) {
+		w.Expiry = t
+	}
+}
+
+// WriteTTL is the time the record expires.
+func WriteTTL(d time.Duration) WriteOption {
+	return func(w *WriteOptions) {
+		w.TTL = d
+	}
+}
+
+// DeleteOptions configures an individual Delete operation.
+type DeleteOptions struct {
+	Database, Table string
+}
+
+// DeleteOption sets values in DeleteOptions.
+type DeleteOption func(d *DeleteOptions)
+
+// DeleteFrom the database and table.
+func DeleteFrom(database, table string) DeleteOption {
+	return func(d *DeleteOptions) {
+		d.Database = database
+		d.Table = table
+	}
+}
+
+// ListOptions configures an individual List operation.
+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
+}
+
+// ListOption sets values in ListOptions.
+type ListOption func(l *ListOptions)
+
+// ListFrom the database and table.
+func ListFrom(database, table string) ListOption {
+	return func(l *ListOptions) {
+		l.Database = database
+		l.Table = table
+	}
+}
+
+// ListPrefix returns all keys that are prefixed with key.
+func ListPrefix(p string) ListOption {
+	return func(l *ListOptions) {
+		l.Prefix = p
+	}
+}
+
+// ListSuffix returns all keys that end with key.
+func ListSuffix(s string) ListOption {
+	return func(l *ListOptions) {
+		l.Suffix = s
+	}
+}
+
+// ListLimit limits the number of returned keys to l.
+func ListLimit(l uint) ListOption {
+	return func(lo *ListOptions) {
+		lo.Limit = l
+	}
+}
+
+// ListOffset starts returning responses from o. Use in conjunction with Limit for pagination.
+func ListOffset(o uint) ListOption {
+	return func(l *ListOptions) {
+		l.Offset = o
+	}
+}