Documentation
¶
Overview ¶
Package file implements storage on the local filesystem, with one file per document.
Index ¶
- Constants
- func Get() storage.IStorage
- func Set(s storage.IStorage)
- type CreateAny
- type File
- func (s *File) BulkCreate(ctx context.Context, _ string, items []storage.BulkItem, prm *create.Create, ...) (storage.BulkResult, error)
- func (s *File) Close() error
- func (s *File) Count(ctx context.Context, target string, prm *count.Count, ...) (int64, error)
- func (s *File) Create(ctx context.Context, id, target string, v any, prm *create.Create, ...) (string, error)
- func (s *File) Delete(ctx context.Context, id, target string, prm *delete.Delete, ...) error
- func (s *File) GetClient() any
- func (s *File) List(ctx context.Context, target string, v any, prm *list.List, ...) error
- func (s *File) Retrieve(ctx context.Context, id, target string, v any, prm *retrieve.Retrieve, ...) error
- func (s *File) Update(ctx context.Context, id, target string, v any, prm *update.Update, ...) error
- type ResponseList
Constants ¶
const Name = "file"
Name of the storage.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type CreateAny ¶
type CreateAny struct {
// Create directory and file if it does not exist.
CreateIfNotExist bool `default:"true" json:"create_if_not_exist"`
}
CreateAny is a struct for the `create.Create` `Any` field.
type File ¶
type File 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 File, it isn't used at all.
Target string `json:"-" validate:"omitempty,gt=0"`
}
File storage definition.
func (*File) BulkCreate ¶
func (s *File) BulkCreate( ctx context.Context, _ string, items []storage.BulkItem, prm *create.Create, options ...storage.Func[*create.Create], ) (storage.BulkResult, error)
BulkCreate creates data in chunks of 25. File has no batch primitive, so each item's ID is used as its file path and written with Create.
func (*File) Close ¶
Close releases the resources held by the storage. File opens and closes descriptors per operation, so Close is a no-op.
func (*File) Count ¶
func (s *File) 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 (*File) Create ¶
func (s *File) 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 (*File) Delete ¶
func (s *File) Delete(ctx context.Context, id, target string, prm *delete.Delete, options ...storage.Func[*delete.Delete]) error
Delete removes data.
func (*File) List ¶
func (s *File) List(ctx context.Context, target string, v any, prm *list.List, options ...storage.Func[*list.List]) error
List data.
Search is a glob matched against filenames. Sort, Limit, Offset, and Fields are applied to the decoded documents after matching.
type ResponseList ¶
type ResponseList[T any] struct { Items []T `json:"items"` }
ResponseList is the list response.
Source Files