file

README

file

Sinks metadata to a file in ndjson/yaml format as per the config defined.

Usage

sinks:
    name: file
    config:
        path: "./dir/sample.yaml"
        format: "yaml"
        overwrite: false

Config Defination

Key	Value	Example	Description
path	string	./dir/sample.yaml	absolute or relative path from binary to output file, directory should exist	required
format	string	yaml	data format for the output file	required
overwrite	bool	false	to choose whether data should be overwritten or appended in case file exists, default is true	optional

Contributing

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

Documentation

Index

• func New(logger log.Logger) plugins.Syncer
• type Config
• type Sink
  • func (s *Sink) Close() (err error)
  • func (s *Sink) Init(ctx context.Context, config plugins.Config) error
  • func (s *Sink) Sink(ctx context.Context, batch []models.Record) (err error)

Functions

func New

func New(logger log.Logger) plugins.Syncer

Types

type Config

type Config struct {
	Overwrite bool   `mapstructure:"overwrite" default:"true"`
	Path      string `mapstructure:"path" validate:"required"`
	Format    string `mapstructure:"format" validate:"required"`
}

type Sink

type Sink struct {
	plugins.BasePlugin

	File *os.File
	// contains filtered or unexported fields
}

func (*Sink) Close

func (s *Sink) Close() (err error)

func (*Sink) Init

func (s *Sink) Init(ctx context.Context, config plugins.Config) error

func (*Sink) Sink

func (s *Sink) Sink(ctx context.Context, batch []models.Record) (err error)