mongodb

Documentation

Index

• func NewCache(conf cache.Config, mgr types.Manager, log log.Modular, stats metrics.Type) (types.Cache, error)
• func NewOutput(conf output.MongoDBConfig, mgr types.Manager, log log.Modular, ...) (output.Type, error)
• func NewProcessor(conf processor.Config, mgr types.Manager, log log.Modular, stats metrics.Type) (types.Processor, error)
• type Cache
  • func (m *Cache) Add(key string, value []byte) error
  • func (m *Cache) CloseAsync()
  • func (m *Cache) Delete(key string) error
  • func (m *Cache) Get(key string) ([]byte, error)
  • func (m *Cache) Set(key string, value []byte) error
  • func (m *Cache) SetMulti(items map[string][]byte) error
  • func (m *Cache) WaitForClose(timeout time.Duration) error
• type Processor
  • func (m *Processor) CloseAsync()
  • func (m *Processor) ProcessMessage(msg types.Message) ([]types.Message, types.Response)
  • func (m *Processor) WaitForClose(timeout time.Duration) error
• type Writer
  • func NewWriter(conf output.MongoDBConfig, log log.Modular, stats metrics.Type) (*Writer, error)
  • func (m *Writer) CloseAsync()
  • func (m *Writer) ConnectWithContext(ctx context.Context) error
  • func (m *Writer) WaitForClose(timeout time.Duration) error
  • func (m *Writer) WriteWithContext(ctx context.Context, msg types.Message) error

Functions

func NewCache

func NewCache(
	conf cache.Config, mgr types.Manager, log log.Modular, stats metrics.Type,
) (types.Cache, error)

NewCache returns a MongoDB cache.

func NewOutput

func NewOutput(conf output.MongoDBConfig, mgr types.Manager, log log.Modular, stats metrics.Type) (output.Type, error)

NewOutput creates a new MongoDB output type.

func NewProcessor

func NewProcessor(
	conf processor.Config, mgr types.Manager, log log.Modular, stats metrics.Type,
) (types.Processor, error)

NewProcessor returns a MongoDB processor.

Types

type Cache

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

Cache is a cache that connects to mongo databases.

func (*Cache) Add

func (m *Cache) Add(key string, value []byte) error

Add attempts to set the value of a key only if the key does not already exist and returns an error if the key already exists or if the operation fails.

func (*Cache) CloseAsync

func (m *Cache) CloseAsync()

CloseAsync shuts down the cache.

func (*Cache) Delete

func (m *Cache) Delete(key string) error

Delete attempts to remove a key.

func (*Cache) Get

func (m *Cache) Get(key string) ([]byte, error)

Get attempts to locate and return a cached value by its key, returns an error if the key does not exist or if the operation failed.

func (*Cache) Set

func (m *Cache) Set(key string, value []byte) error

Set attempts to set the value of a key.

func (*Cache) SetMulti

func (m *Cache) SetMulti(items map[string][]byte) error

SetMulti attempts to set the value of multiple keys, returns an error if any keys fail.

func (*Cache) WaitForClose

func (m *Cache) WaitForClose(timeout time.Duration) error

WaitForClose blocks until the cache has closed down.

type Processor

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

Processor stores or retrieves data from a mongo db for each message of a batch

func (*Processor) CloseAsync

func (m *Processor) CloseAsync()

CloseAsync shuts down the processor and stops processing requests.

func (*Processor) ProcessMessage

func (m *Processor) ProcessMessage(msg types.Message) ([]types.Message, types.Response)

ProcessMessage applies the processor to a message, either creating >0 resulting messages or a response to be sent back to the message source.

func (*Processor) WaitForClose

func (m *Processor) WaitForClose(timeout time.Duration) error

WaitForClose blocks until the processor has closed down.

type Writer

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

Writer is a benthos writer.Type implementation that writes messages to an Writer database.

func NewWriter

func NewWriter(
	conf output.MongoDBConfig,
	log log.Modular,
	stats metrics.Type,
) (*Writer, error)

NewWriter creates a new MongoDB writer.Type.

func (*Writer) CloseAsync

func (m *Writer) CloseAsync()

CloseAsync begins cleaning up resources used by this writer asynchronously.

func (*Writer) ConnectWithContext

func (m *Writer) ConnectWithContext(ctx context.Context) error

ConnectWithContext attempts to establish a connection to the target mongo DB

func (*Writer) WaitForClose

func (m *Writer) WaitForClose(timeout time.Duration) error

WaitForClose will block until either the writer is closed or a specified timeout occurs.

func (*Writer) WriteWithContext

func (m *Writer) WriteWithContext(ctx context.Context, msg types.Message) error

WriteWithContext attempts to perform the designated operation to the mongo DB collection.