mongodb

Documentation

Index

• Variables
• type Option
  • func WithDBName(dbName func(context.Context) string) Option
  • func WithPrefixAsDBName() Option
• type Repo
  • func NewRepo(uri, dbPrefix, collection string, options ...Option) (*Repo, error)
  • func NewRepoWithClient(client *mongo.Client, dbPrefix, collection string, options ...Option) (*Repo, error)
  • func Repository(repo eh.ReadRepo) *Repo
  • func (r *Repo) Clear(ctx context.Context) error
  • func (r *Repo) Close(ctx context.Context)
  • func (r *Repo) Collection(ctx context.Context, f func(context.Context, *mongo.Collection) error) error
  • func (r *Repo) Find(ctx context.Context, id uuid.UUID) (eh.Entity, error)
  • func (r *Repo) FindAll(ctx context.Context) ([]eh.Entity, error)
  • func (r *Repo) FindCustom(ctx context.Context, ...) ([]interface{}, error)
  • func (r *Repo) FindCustomIter(ctx context.Context, ...) (eh.Iter, error)
  • func (r *Repo) Parent() eh.ReadRepo
  • func (r *Repo) Remove(ctx context.Context, id uuid.UUID) error
  • func (r *Repo) Save(ctx context.Context, entity eh.Entity) error
  • func (r *Repo) SetEntityFactory(f func() eh.Entity)

Variables

var ErrCouldNotClearDB = errors.New("could not clear database")

ErrCouldNotClearDB is when the database could not be cleared.

var ErrCouldNotDialDB = errors.New("could not dial database")

ErrCouldNotDialDB is when the database could not be dialed.

var ErrInvalidQuery = errors.New("invalid query")

ErrInvalidQuery is when a query was not returned from the callback to FindCustom.

var ErrModelNotSet = errors.New("model not set")

ErrModelNotSet is when an model factory is not set on the Repo.

var ErrNoDBClient = errors.New("no database client")

ErrNoDBClient is when no database client is set.

Types

type Option

type Option func(*Repo) error

Option is an option setter used to configure creation.

func WithDBName

func WithDBName(dbName func(context.Context) string) Option

WithDBName uses a custom DB name function.

func WithPrefixAsDBName

func WithPrefixAsDBName() Option

WithPrefixAsDBName uses only the prefix as DB name, without namespace support.

type Repo

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

Repo implements an MongoDB repository for entities.

func NewRepo

func NewRepo(uri, dbPrefix, collection string, options ...Option) (*Repo, error)

NewRepo creates a new Repo.

func NewRepoWithClient

func NewRepoWithClient(client *mongo.Client, dbPrefix, collection string, options ...Option) (*Repo, error)

NewRepoWithClient creates a new Repo with a client.

func Repository

func Repository(repo eh.ReadRepo) *Repo

Repository returns a parent ReadRepo if there is one.

func (*Repo) Clear

func (r *Repo) Clear(ctx context.Context) error

Clear clears the read model database.

func (*Repo) Close

func (r *Repo) Close(ctx context.Context)

Close closes a database session.

func (*Repo) Collection

func (r *Repo) Collection(ctx context.Context, f func(context.Context, *mongo.Collection) error) error

Collection lets the function do custom actions on the collection.

func (*Repo) Find

func (r *Repo) Find(ctx context.Context, id uuid.UUID) (eh.Entity, error)

Find implements the Find method of the eventhorizon.ReadRepo interface.

func (*Repo) FindAll

func (r *Repo) FindAll(ctx context.Context) ([]eh.Entity, error)

FindAll implements the FindAll method of the eventhorizon.ReadRepo interface.

func (*Repo) FindCustom

func (r *Repo) FindCustom(ctx context.Context, f func(context.Context, *mongo.Collection) (*mongo.Cursor, error)) ([]interface{}, error)

FindCustom uses a callback to specify a custom query for returning models. It can also be used to do queries that does not map to the model by executing the query in the callback and returning nil to block a second execution of the same query in FindCustom. Expect a ErrInvalidQuery if returning a nil query from the callback.

func (*Repo) FindCustomIter

func (r *Repo) FindCustomIter(ctx context.Context, f func(context.Context, *mongo.Collection) (*mongo.Cursor, error)) (eh.Iter, error)

FindCustomIter returns a mgo cursor you can use to stream results of very large datasets

func (*Repo) Parent

func (r *Repo) Parent() eh.ReadRepo

Parent implements the Parent method of the eventhorizon.ReadRepo interface.

func (*Repo) Remove

func (r *Repo) Remove(ctx context.Context, id uuid.UUID) error

Remove implements the Remove method of the eventhorizon.WriteRepo interface.

func (*Repo) Save

func (r *Repo) Save(ctx context.Context, entity eh.Entity) error

Save implements the Save method of the eventhorizon.WriteRepo interface.

func (*Repo) SetEntityFactory

func (r *Repo) SetEntityFactory(f func() eh.Entity)

SetEntityFactory sets a factory function that creates concrete entity types.