mongodb

README

mongodb

Usage

source:
  name: mongodb
  config:
    connection_url: mongodb://admin:pass123@localhost:3306
    exclude:
      databases:
        - database_a
        - database_b
      collections:
        - database_c.collection_a

Inputs

Key	Value	Example	Description
connection_url	string	mongodb://admin:pass123@localhost:3306	URL to access the mongodb server	required
exclude.databases	[]string	[database_a, database_b]	List of databases to be excluded	optional
exclude.collections	[]string	[database_c.collection_a, database_c.collection_b]	List of collections to be excluded	optional

Outputs

Field	Sample Value
resource.urn	my_database.my_collection
resource.name	my_collection
resource.service	mongodb
description	table description
profile.total_rows	2100

Contributing

Refer to the contribution guidelines for information on contributing to this module.

Documentation

Index

• type Config
• type Exclude
• type Extractor
  • func New(logger log.Logger) *Extractor
  • func (e *Extractor) Extract(ctx context.Context, emit plugins.Emit) (err error)
  • func (e *Extractor) Init(ctx context.Context, config plugins.Config) (err error)

Types

type Config

type Config struct {
	ConnectionURL string  `json:"connection_url" yaml:"connection_url" mapstructure:"connection_url" validate:"required"`
	Exclude       Exclude `json:"exclude" yaml:"exclude" mapstructure:"exclude"`
}

Config holds the connection URL for the extractor

type Exclude

type Exclude struct {
	Databases   []string `json:"databases" yaml:"databases" mapstructure:"databases"`
	Collections []string `json:"collections" yaml:"collections" mapstructure:"collections"`
}

type Extractor

type Extractor struct {
	plugins.BaseExtractor
	// contains filtered or unexported fields
}

Extractor manages the communication with the mongo server

func New

func New(logger log.Logger) *Extractor

New returns a pointer to an initialized Extractor Object

func (*Extractor) Extract

func (e *Extractor) Extract(ctx context.Context, emit plugins.Emit) (err error)

Extract collects metadata of each database through emitter

func (*Extractor) Init

func (e *Extractor) Init(ctx context.Context, config plugins.Config) (err error)