The highest tagged major version is
Documentation
¶
Index ¶
- Constants
- func Get() storage.IStorage
- func Set(s storage.IStorage)
- type Memory
- func (s *Memory) Count(ctx context.Context, target string, prm *count.Count, ...) (int64, error)
- func (s *Memory) Create(ctx context.Context, id, target string, v any, prm *create.Create, ...) (string, error)
- func (s *Memory) Delete(ctx context.Context, id, target string, prm *delete.Delete, ...) error
- func (s *Memory) GetClient() any
- func (s *Memory) List(ctx context.Context, target string, v any, prm *list.List, ...) error
- func (s *Memory) Retrieve(ctx context.Context, id, target string, v any, prm *retrieve.Retrieve, ...) error
- func (s *Memory) Update(ctx context.Context, id, target string, v any, prm *update.Update, ...) error
- type ResponseList
Constants ¶
View Source
const Name = "memory"
Name of the storage.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Memory ¶
type Memory struct {
*storage.Storage
// Target allows to set a static target. If it is empty, the target will be
// dynamic - the one set at the operation (count, create, delete, etc) time.
// Depending on the storage, target is a collection, a table, a bucket, etc.
// For ElasticSearch, for example it doesn't have a concept of a database -
// the target then is the index. Due to different cases of ElasticSearch
// usage, the target can be static or dynamic - defined at the index time,
// for example: log-{YYYY}-{MM}. For Memory, it isn't used at all.
Target string `json:"-" validate:"omitempty,gt=0"`
// contains filtered or unexported fields
}
Memory storage definition.
func (*Memory) Count ¶
func (s *Memory) Count(ctx context.Context, target string, prm *count.Count, options ...storage.Func[*count.Count]) (int64, error)
Count returns the number of items in the storage.
func (*Memory) Create ¶
func (s *Memory) Create(ctx context.Context, id, target string, v any, prm *create.Create, options ...storage.Func[*create.Create]) (string, error)
Create data.
NOTE: Not all storages returns the ID, neither all storages requires `id` to be set. You are better off setting the ID yourself.
func (*Memory) Delete ¶
func (s *Memory) Delete(ctx context.Context, id, target string, prm *delete.Delete, options ...storage.Func[*delete.Delete]) error
Delete removes data.
func (*Memory) List ¶
func (s *Memory) List(ctx context.Context, target string, v any, prm *list.List, options ...storage.Func[*list.List]) error
List data.
NOTE: It uses params.List.Search to query the data.
NOTE: Memory does not support the concept of "offset" and "limit" in the same way that a traditional SQL database does.
type ResponseList ¶
type ResponseList[T any] struct { Items []T `json:"items"` }
ResponseList is the list response.
Source Files
Click to show internal directories.
Click to hide internal directories.