document

Documentation

Index

• type Store
  • func NewStoreWith(docStore plugin.DocumentStore, opts ...StoreOption) *Store
  • func (store *Store) Dump() ([]string, error)
  • func (store *Store) DumpCollection(ctx context.Context, db store.Database, col store.Collection, ...) ([]string, error)
  • func (store *Store) DumpDatabase(ctx context.Context, db store.Database) ([]string, error)
• type StoreOption
  • func WithStoreDumpChildren(v bool) StoreOption

Types

type Store

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

Store represents a new document store utility instance.

func NewStoreWith

func NewStoreWith(docStore plugin.DocumentStore, opts ...StoreOption) *Store

NewStoreWith returns a new document store utility instance with the specified store.

func (*Store) Dump

func (store *Store) Dump() ([]string, error)

Dump returns a string array representation of the document store.

func (*Store) DumpCollection

func (store *Store) DumpCollection(ctx context.Context, db store.Database, col store.Collection, txn store.Transaction) ([]string, error)

func (*Store) DumpDatabase

func (store *Store) DumpDatabase(ctx context.Context, db store.Database) ([]string, error)

DumpDatabase returns a string array representation of the specified database.

type StoreOption

type StoreOption func(*Store)

StoreOption represents a store option.

func WithStoreDumpChildren

func WithStoreDumpChildren(v bool) StoreOption