couchdb

README

couchdb

Usage

source:
  name: couchdb
  config:
    connection_url: http://admin:pass123@localhost:3306/
    exclude: database_a,database_b

Inputs

Key	Value	Example	Description
connection_url	string	http://admin:pass123@localhost:3306/	URL to access the couchdb server	required
exclude	string	primaryDB,secondaryDB	Comma separated database list to be excluded from crawling	optional

Outputs

Field	Sample Value
resource.urn	database_name.docID
resource.name	docID
resource.service	couchdb
schema	[]column

Column

Field	Sample Value
name	field1
description	rev for revision history
data_type	float64
length	``

Contributing

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

Documentation

Index

• type Config
• 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       string `json:"exclude" yaml:"exclude" mapstructure:"exclude"`
}

Config holds the connection URL for the extractor

type Extractor

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

Extractor manages the extraction of data from CouchDB

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 extracts the data from the CouchDB server and collected through the out channel

func (*Extractor) Init

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

Initialise the Extractor with Configurations