dstore

type Collection struct {
	// Path for collection.
	Path string
}

type CollectionIterator interface {
	// Next collection, or nil.
	Next() (*Collection, error)
	// Release resources associated with the iterator.
	Release()
}

type ContextLogger interface {
	Debugf(ctx context.Context, format string, args ...interface{})
	Infof(ctx context.Context, format string, args ...interface{})
	Warningf(ctx context.Context, format string, args ...interface{})
	Errorf(ctx context.Context, format string, args ...interface{})
}

type Document struct {
	// Path of document.
	Path string

	// CreatedAt (read only). The time at which the document was created.
	CreatedAt time.Time
	// UpdatedAt (read only). The time at which the document was last changed.
	UpdatedAt time.Time
	// contains filtered or unexported fields
}

type Documents interface {
	// Create document at path.
	// ErrPathExists if path already exists.
	//
	// To marshal a value, use dstore.From(v) to convert to a map (using msgpack or json tags).
	// If merging and using dstore.From(v), fields with omitempty will no overwrite existing values.
	//
	// Paths can be nested as long as they are even length components.
	// For example,
	//
	//   collection1/key1 (OK)
	//   collection1/key1/collection2/key2 (OK)
	//   collection1 (INVALID)
	//   collection1/key1/collection2 (INVALID)
	//
	Create(ctx context.Context, path string, values map[string]interface{}) error

	// Set (or create or update) document at path.
	// This will overwrite any existing document data, unless you specify MergeAll() option.
	//
	// To marshal a value, use dstore.From(v) to convert to a map (using msgpack or json tags).
	// If merging and using dstore.From(v), fields with omitempty will no overwrite existing values.
	//
	// To update a document:
	//
	// 		update := map[string]interface{}{
	//		   "property1":        value1,
	// 		}
	// 		err := fi.Set(ctx, path, update, dstore.MergeAll())
	//
	// Paths can be nested as long as they are even length components.
	// For example,
	//
	//   collection1/key1 (OK)
	//   collection1/key1/collection2/key2 (OK)
	//   collection1 (INVALID)
	//   collection1/key1/collection2 (INVALID)
	//
	Set(ctx context.Context, path string, values map[string]interface{}, opt ...SetOption) error

	// Get path.
	// If not found, returns nil.
	Get(ctx context.Context, path string) (*Document, error)

	// Load path into value.
	// This is shorthand for Get and doc.To(&val).
	Load(ctx context.Context, path string, v interface{}) (bool, error)

	// GetAll at paths.
	// If a path is not found, it is ignored.
	GetAll(ctx context.Context, paths []string) ([]*Document, error)

	// Exists, if exists at path.
	Exists(ctx context.Context, path string) (bool, error)

	// Delete at path.
	Delete(ctx context.Context, path string) (bool, error)
	// DeleteAll paths. If a path is not found, it is ignored.
	DeleteAll(ctx context.Context, paths []string) error

	// DocumentIterator.
	DocumentIterator(ctx context.Context, parent string, opt ...Option) (Iterator, error)

	// Documents ...
	Documents(ctx context.Context, parent string, opt ...Option) ([]*Document, error)

	// Collections are parents of Documents.
	Collections(ctx context.Context, parent string) ([]*Collection, error)
}

type ErrNotFound struct {
	Path string
}

type ErrPathExists struct {
	Path string
}

type Iterator interface {
	// Next document, or nil.
	Next() (*Document, error)
	// Release resources associated with the iterator.
	Release()
}

type LogLevel int

type Logger interface {
	Debugf(format string, args ...interface{})
	Infof(format string, args ...interface{})
	Warningf(format string, args ...interface{})
	Errorf(format string, args ...interface{})
	Fatalf(format string, args ...interface{})
}

type Mem struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

type Mode string

type Option func(*Options)

type Options struct {
	// Prefix to filter on.
	Prefix string
	// Index is offset into number of documents.
	Index int
	// Limit is number of documents (max) to return.
	Limit int
	// NoData to only include only path in Document (no data).
	NoData bool
	// Where
	Where *where
}

type SetOption func(*SetOptions)

type SetOptions struct {
	MergeAll bool
}

type StringSet struct {
	// contains filtered or unexported fields
}