source

Documentation

Index

• Constants
• type Config
  • func Parse(cfg map[string]string) (Config, error)
• type Iterator
• type Source
  • func (s *Source) Ack(ctx context.Context, position record.Position) error
  • func (s *Source) Open(ctx context.Context, cfg plugins.Config) error
  • func (s *Source) Read(ctx context.Context, rp record.Position) (record.Record, error)
  • func (s *Source) Teardown() error
  • func (s *Source) Validate(cfg plugins.Config) error

Constants

const (
	// ConfigKeyPollingPeriod is the config name for the S3 CDC polling period
	ConfigKeyPollingPeriod = "polling-period"

	// DefaultPollingPeriod is the value assumed for the pooling period when the
	// config omits the polling period parameter
	DefaultPollingPeriod = "1s"
)

Types

type Config

type Config struct {
	config.Config
	PollingPeriod time.Duration
}

Config represents source configuration with S3 configurations

func Parse

func Parse(cfg map[string]string) (Config, error)

Parse attempts to parse plugins.Config into a Config struct that Source could utilize

type Iterator

type Iterator interface {
	HasNext(ctx context.Context) bool
	Next(ctx context.Context) (record.Record, error)
	Stop()
}

type Source

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

Source connector

func (*Source) Ack

func (s *Source) Ack(ctx context.Context, position record.Position) error

func (*Source) Open

func (s *Source) Open(ctx context.Context, cfg plugins.Config) error

Open parses and initializes the config and makes sure everything is prepared to read records.

func (*Source) Read

func (s *Source) Read(ctx context.Context, rp record.Position) (record.Record, error)

Read gets an object from s3 bucket according to the position.

func (*Source) Teardown

func (s *Source) Teardown() error

func (*Source) Validate

func (s *Source) Validate(cfg plugins.Config) error