Documentation
¶
Overview ¶
Package storage contains the subscriptions storage common interfaces.
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var ( // ErrConflict indicates the subscription exists in the underlying storage and can not be created. ErrConflict = errors.New("subscription already exists") // ErrNotFound indicates the subscription is missing in the storage and can not be read/updated/deleted. ErrNotFound = errors.New("subscription was not found") // ErrInternal indicates the internal storage failure happened. ErrInternal = errors.New("internal subscription storage failure") )
Functions ¶
This section is empty.
Types ¶
type KiwiQuery ¶
type KiwiQuery struct {
// Limit defines a results page size limit.
Limit uint32
// Key represents the subscription matching criteria: where any model.KiwiCondition has the equal Key.
Key string
// Pattern represents the subscription matching criteria: where any model.KiwiCondition has the equal Pattern.
Pattern string
// Partial represents the subscription matching criteria: where any model.KiwiCondition has the equal Partial value.
Partial bool
}
KiwiQuery is the model.Subscription search query by a certain key/pattern ("kiwi") condition pair.
type Storage ¶
type Storage interface {
io.Closer
// Create a subscription means subscribing.
Create(ctx context.Context, sub subscription.Data) (id string, err error)
// Read the model.Data by the model.Subscription id.
Read(ctx context.Context, id string) (sub subscription.Data, err error)
// Delete removes the model.Subscription specified by its unique id.
// Returns the model.Data if deleted, error otherwise.
Delete(ctx context.Context, name string) (sub subscription.Data, err error)
// SearchByKiwi returns subscriptions page where:<br/>
// * model.Subscription id is greater than the one specified by the cursor<br/>
// * subscriptions match the specified model.KiwiQuery.
SearchByKiwi(ctx context.Context, q KiwiQuery, cursor string) (page []subscription.ConditionMatch, err error)
// SearchByMetadata returns all subscriptions those have the metadata matching the query (same keys and values).
SearchByMetadata(ctx context.Context, q model.MetadataQuery, cursor string) (page []subscription.Subscription, err error)
}
Storage represents the subscriptions storage
func NewStorageMock ¶
func NewStorageMock(storage map[string]subscription.Data) Storage
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.