source

Documentation

Index

• Constants
• func NewSource() sdk.Source
• type Config
• type Iterator
• type Source
  • func (s *Source) Ack(ctx context.Context, position opencdc.Position) error
  • func (s *Source) Config() sdk.SourceConfig
  • func (s *Source) Open(ctx context.Context, rp opencdc.Position) error
  • func (s *Source) Read(ctx context.Context) (opencdc.Record, error)
  • func (s *Source) Teardown(_ context.Context) error

Constants

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

Functions

func NewSource

func NewSource() sdk.Source

Types

type Config

type Config struct {
	sdk.DefaultSourceMiddleware
	config.Config

	// polling period for the CDC mode, formatted as a time.Duration string.
	PollingPeriod time.Duration `json:"pollingPeriod" default:"1s"`
}

Config represents source configuration with S3 configurations

type Iterator

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

type Source

type Source struct {
	sdk.UnimplementedSource
	// contains filtered or unexported fields
}

Source connector

func (*Source) Ack

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

func (*Source) Config

func (s *Source) Config() sdk.SourceConfig

func (*Source) Open

func (s *Source) Open(ctx context.Context, rp opencdc.Position) error

Open prepare the plugin to start sending records from the given position

func (*Source) Read

func (s *Source) Read(ctx context.Context) (opencdc.Record, error)

Read gets the next object from the S3 bucket

func (*Source) Teardown

func (s *Source) Teardown(_ context.Context) error