snapshot

Documentation

Index

• Variables
• type Config
• type FetchConfig
  • func (c FetchConfig) Validate() error
• type FetchData
• type FetchWorker
  • func NewFetchWorker(db *pgxpool.Pool, out chan<- FetchData, c FetchConfig) *FetchWorker
  • func (f *FetchWorker) Run(ctx context.Context) error
  • func (f *FetchWorker) Validate(ctx context.Context) error
• type Iterator
  • func NewIterator(ctx context.Context, db *pgxpool.Pool, c Config) (*Iterator, error)
  • func (i *Iterator) Ack(_ context.Context, _ opencdc.Position) error
  • func (i *Iterator) Next(ctx context.Context) (opencdc.Record, error)
  • func (i *Iterator) Teardown(_ context.Context) error

Variables

var ErrIteratorDone = errors.New("snapshot complete")

Types

type Config

type Config struct {
	Position       opencdc.Position
	Tables         []string
	TableKeys      map[string]string
	TXSnapshotID   string
	FetchSize      int
	WithAvroSchema bool
}

type FetchConfig

type FetchConfig struct {
	Table          string
	Key            string
	TXSnapshotID   string
	FetchSize      int
	Position       position.Position
	WithAvroSchema bool
}

func (FetchConfig) Validate

func (c FetchConfig) Validate() error

type FetchData

type FetchData struct {
	Key           opencdc.StructuredData
	Payload       opencdc.StructuredData
	Position      position.SnapshotPosition
	Table         string
	PayloadSchema cschema.Schema
	KeySchema     cschema.Schema
}

type FetchWorker

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

FetchWorker fetches snapshot data from a single table

func NewFetchWorker

func NewFetchWorker(db *pgxpool.Pool, out chan<- FetchData, c FetchConfig) *FetchWorker

func (*FetchWorker) Run

func (f *FetchWorker) Run(ctx context.Context) error

func (*FetchWorker) Validate

func (f *FetchWorker) Validate(ctx context.Context) error

Validate will ensure the config is correct. * Table and keys exist * Key is a primary key

type Iterator

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

func NewIterator

func NewIterator(ctx context.Context, db *pgxpool.Pool, c Config) (*Iterator, error)

func (*Iterator) Ack

func (i *Iterator) Ack(_ context.Context, _ opencdc.Position) error

func (*Iterator) Next

func (i *Iterator) Next(ctx context.Context) (opencdc.Record, error)

func (*Iterator) Teardown

func (i *Iterator) Teardown(_ context.Context) error