Documentation
¶
Overview ¶
Package mongodb implements a storage provider conforming to the storage interface in aries-framework-go. It is compatible with MongoDB v4.0.0, v4.2.8, and v5.0.0. It is also compatible with Amazon DocumentDB 4.0.0. It may be compatible with other versions, but they haven't been tested.
Index ¶
- type Option
- type Provider
- func (p *Provider) Close() error
- func (p *Provider) GetOpenStores() []storage.Store
- func (p *Provider) GetStoreConfig(name string) (storage.StoreConfiguration, error)
- func (p *Provider) OpenStore(name string) (storage.Store, error)
- func (p *Provider) SetStoreConfig(storeName string, config storage.StoreConfiguration) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Option ¶
type Option func(opts *Provider)
Option represents an option for a MongoDB Provider.
func WithDBPrefix ¶
WithDBPrefix is an option for adding a prefix to all created database names. No prefix will be used by default.
func WithLogger ¶
func WithLogger(logger logger) Option
WithLogger is an option for specifying a custom logger. The standard Golang logger will be used by default.
func WithMaxRetries ¶
WithMaxRetries is an option for specifying how many retries are allowed when there are certain transient errors from MongoDB. These transient errors can happen in two situations:
- An index conflict error when setting indexes via the SetStoreConfig method from multiple MongoDB Provider objects that look at the same stores (which might happen if you have multiple running instances of a service).
- If you're using MongoDB 4.0.0 (or DocumentDB 4.0.0), a "dup key" type of error when calling store.Put or store.Batch from multiple MongoDB Provider objects that look at the same stores.
maxRetries must be > 0. If not set (or set to an invalid value), it will default to 3.
func WithTimeBetweenRetries ¶
WithTimeBetweenRetries is an option for specifying how long to wait between retries when there are certain transient errors from MongoDB. These transient errors can happen in two situations:
- An index conflict error when setting indexes via the SetStoreConfig method from multiple MongoDB Provider objects that look at the same stores (which might happen if you have multiple running instances of a service).
- If you're using MongoDB 4.0.0 (or DocumentDB 4.0.0), a "dup key" type of error when calling store.Put or store.Batch multiple times in parallel on the same key.
Defaults to two seconds if not set.
func WithTimeout ¶
WithTimeout is an option for specifying the timeout for all calls to MongoDB. The timeout is 10 seconds by default.
type Provider ¶
type Provider struct {
// contains filtered or unexported fields
}
Provider represents a MongoDB/DocumentDB implementation of the storage.Provider interface.
func NewProvider ¶
NewProvider instantiates a new MongoDB Provider. connString is a connection string as defined in https://docs.mongodb.com/manual/reference/connection-string/. Note that options supported by the Go Mongo driver (and the names of them) may differ from the documentation above. Check the Go Mongo driver (go.mongodb.org/mongo-driver/mongo) to make sure the options you're specifying are supported and will be captured correctly. If using DocumentDB, the retryWrites option must be set to false in the connection string (retryWrites=false) in order for it to work.
func (*Provider) GetOpenStores ¶
GetOpenStores returns all Stores currently open in this Provider.
func (*Provider) GetStoreConfig ¶
func (p *Provider) GetStoreConfig(name string) (storage.StoreConfiguration, error)
GetStoreConfig gets the current Store configuration. If the underlying database for the given name has never been created by a call to OpenStore at some point, then an error wrapping ErrStoreNotFound will be returned. This method will not open a store in the Provider. If name is blank, then an error will be returned.
func (*Provider) OpenStore ¶
OpenStore opens a Store with the given name and returns a handle. If the underlying database for the given name has never been created before, then it is created. Store names are not case-sensitive. If name is blank, then an error will be returned.
func (*Provider) SetStoreConfig ¶
func (p *Provider) SetStoreConfig(storeName string, config storage.StoreConfiguration) error
SetStoreConfig sets the configuration on a store. Indexes are created based on the tag names in config. This allows the store.Query method to operate faster. Existing tag names/indexes in the store that are not in the config passed in here will be removed. The store must already be open in this provider from a prior call to OpenStore. The name parameter cannot be blank.
Source Files