mongostore

Documentation

Overview

Package mongostore provides the mongodb store implementation.

Index

• Variables
• type Config
• type Option
  • func Collection(name string) Option
  • func CreateIndexes(create bool) Option
  • func Database(name string) Option
  • func Projection(proj interface{}) Option
• type Store
  • func New(client *mongo.Client, opts ...Option) (*Store, error)
  • func (s *Store) Config() Config
  • func (s *Store) Get(ctx context.Context, id uuid.UUID) (store.Letter, error)
  • func (s *Store) Insert(ctx context.Context, let store.Letter) error
  • func (s *Store) Query(ctx context.Context, q query.Query) (query.Cursor, error)
  • func (s *Store) SetProjection(proj interface{})

Variables

var (
	// Provider is the store provider name.
	Provider = "mongo"
)

Types

type Config

type Config struct {
	DatabaseName   string
	CollectionName string
	CreateIndexes  bool
	Projection     interface{} // Custom mongodb *mongo.Collection.Find() projection
}

Config is the store configuration.

type Option

type Option func(*Config)

Option is a store option.

func Collection

func Collection(name string) Option

Collection configures the used collection. Defaults to "letters".

func CreateIndexes

func CreateIndexes(create bool) Option

CreateIndexes configures the store to create the indexes for the fields of the letters. By default, this option is set to true.

func Database

func Database(name string) Option

Database configures the used database. Defaults to "postdog".

func Projection

func Projection(proj interface{}) Option

Projection configures proj to be the used as the projection in the queries.

type Store

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

Store is the mongodb store.

func New

func New(client *mongo.Client, opts ...Option) (*Store, error)

New creates a mongodb store. By default, the store uses the "postdog" database and "letters" collection. You can configure the store with opts.

func (*Store) Config

func (s *Store) Config() Config

Config returns the store configuration.

func (*Store) Get

func (s *Store) Get(ctx context.Context, id uuid.UUID) (store.Letter, error)

Get retrieves the letter with the given id

func (*Store) Insert

func (s *Store) Insert(ctx context.Context, let store.Letter) error

Insert inserts let into s.

func (*Store) Query

func (s *Store) Query(ctx context.Context, q query.Query) (query.Cursor, error)

Query queries the store for letters, filtered and sorted by q.

func (*Store) SetProjection

func (s *Store) SetProjection(proj interface{})

SetProjection sets proj to be used as the projection in the queries.