iterator

Documentation

Index

• Constants
• type CDCIterator
  • func NewCDCIterator(bucket, prefix string, pollingPeriod time.Duration, client *s3.Client, ...) (*CDCIterator, error)
  • func (w *CDCIterator) HasNext(_ context.Context) bool
  • func (w *CDCIterator) Next(ctx context.Context) (opencdc.Record, error)
  • func (w *CDCIterator) Stop()
• type CacheEntry
• type CombinedIterator
  • func NewCombinedIterator(ctx context.Context, bucket, prefix string, pollingPeriod time.Duration, ...) (*CombinedIterator, error)
  • func (c *CombinedIterator) HasNext(ctx context.Context) bool
  • func (c *CombinedIterator) Next(ctx context.Context) (opencdc.Record, error)
  • func (c *CombinedIterator) Stop()
• type SnapshotIterator
  • func NewSnapshotIterator(bucket, prefix string, client *s3.Client, p position.Position) (*SnapshotIterator, error)
  • func (w *SnapshotIterator) HasNext(ctx context.Context) bool
  • func (w *SnapshotIterator) Next(ctx context.Context) (opencdc.Record, error)
  • func (w *SnapshotIterator) Stop()

Constants

const (
	MetadataContentType = "s3.contentType"
)

Types

type CDCIterator

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

CDCIterator scans the bucket periodically and detects changes made to it.

func NewCDCIterator

func NewCDCIterator(
	bucket, prefix string,
	pollingPeriod time.Duration,
	client *s3.Client,
	from time.Time,
) (*CDCIterator, error)

NewCDCIterator returns a CDCIterator and starts the process of listening to changes every pollingPeriod.

func (*CDCIterator) HasNext

func (w *CDCIterator) HasNext(_ context.Context) bool

HasNext returns a boolean that indicates whether the iterator has any objects in the buffer or not.

func (*CDCIterator) Next

func (w *CDCIterator) Next(ctx context.Context) (opencdc.Record, error)

Next returns the next record from the buffer.

func (*CDCIterator) Stop

func (w *CDCIterator) Stop()

type CacheEntry

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

type CombinedIterator

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

func NewCombinedIterator

func NewCombinedIterator(
	ctx context.Context,
	bucket, prefix string,
	pollingPeriod time.Duration,
	client *s3.Client,
	p position.Position,
) (*CombinedIterator, error)

func (*CombinedIterator) HasNext

func (c *CombinedIterator) HasNext(ctx context.Context) bool

func (*CombinedIterator) Next

func (c *CombinedIterator) Next(ctx context.Context) (opencdc.Record, error)

func (*CombinedIterator) Stop

func (c *CombinedIterator) Stop()

type SnapshotIterator

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

SnapshotIterator to iterate through S3 objects in a specific bucket.

func NewSnapshotIterator

func NewSnapshotIterator(bucket, prefix string, client *s3.Client, p position.Position) (*SnapshotIterator, error)

NewSnapshotIterator takes the s3 bucket, the client, and the position. it returns a snapshotIterator starting from the position provided.

func (*SnapshotIterator) HasNext

func (w *SnapshotIterator) HasNext(ctx context.Context) bool

HasNext returns a boolean that indicates whether the iterator has more objects to return or not.

func (*SnapshotIterator) Next

func (w *SnapshotIterator) Next(ctx context.Context) (opencdc.Record, error)

Next returns the next record in the iterator. returns an empty record and an error if anything wrong happened.

func (*SnapshotIterator) Stop

func (w *SnapshotIterator) Stop()