mongodb

Documentation

Index

• Constants
• func NewOutput(conf output.MongoDBConfig, mgr bundle.NewManagement, log log.Modular, ...) (output.Streamed, error)
• func NewProcessor(conf processor.Config, mgr bundle.NewManagement, log log.Modular, ...) (processor.V2Batched, error)
• type Processor
  • func (m *Processor) Close(ctx context.Context) error
  • func (m *Processor) ProcessBatch(ctx context.Context, spans []*tracing.Span, batch *message.Batch) ([]*message.Batch, error)
• type Writer
  • func NewWriter(mgr bundle.NewManagement, conf output.MongoDBConfig, log log.Modular, ...) (*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 *message.Batch) error

Constants

const (
	FindInputOperation      = "find"
	AggregateInputOperation = "aggregate"
)

mongodb input component allowed operations

Functions

func NewOutput

func NewOutput(conf output.MongoDBConfig, mgr bundle.NewManagement, log log.Modular, stats metrics.Type) (output.Streamed, error)

NewOutput creates a new MongoDB output type.

func NewProcessor

func NewProcessor(
	conf processor.Config, mgr bundle.NewManagement, log log.Modular, stats metrics.Type,
) (processor.V2Batched, error)

NewProcessor returns a MongoDB processor.

Types

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) Close

func (m *Processor) Close(ctx context.Context) error

Close shuts down the processor and stops processing requests.

func (*Processor) ProcessBatch

func (m *Processor) ProcessBatch(ctx context.Context, spans []*tracing.Span, batch *message.Batch) ([]*message.Batch, error)

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

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(
	mgr bundle.NewManagement,
	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 *message.Batch) error

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