producer

Documentation

Overview

package producer provides interfaces used to populate a finding aid where "populate" means updating a data store with information mapping a Who's On First ID to its corresponding repository name.

Index

• func RegisterProducer(ctx context.Context, scheme string, init_func ProducerInitializationFunc) error
• type CSVProducer
  • func (p *CSVProducer) Close(ctx context.Context) error
  • func (p *CSVProducer) PopulateWithIterator(ctx context.Context, monitor timings.Monitor, iterator_uri string, ...) error
• type DocstoreProducer
  • func (p *DocstoreProducer) Close(ctx context.Context) error
  • func (p *DocstoreProducer) PopulateWithIterator(ctx context.Context, monitor timings.Monitor, iterator_uri string, ...) error
• type MultiProducer
  • func (p *MultiProducer) Close(ctx context.Context) error
  • func (p *MultiProducer) PopulateWithIterator(ctx context.Context, monitor timings.Monitor, iterator_uri string, ...) error
• type NullProducer
  • func (p *NullProducer) Close(ctx context.Context) error
  • func (p *NullProducer) PopulateWithIterator(ctx context.Context, monitor timings.Monitor, iterator_uri string, ...) error
• type Producer
  • func NewCSVProducer(ctx context.Context, uri string) (Producer, error)
  • func NewDocstoreProducer(ctx context.Context, uri string) (Producer, error)
  • func NewMultiProducer(ctx context.Context, uri string) (Producer, error)
  • func NewNullProducer(ctx context.Context, uri string) (Producer, error)
  • func NewProducer(ctx context.Context, uri string) (Producer, error)
  • func NewProtobufProducer(ctx context.Context, uri string) (Producer, error)
  • func NewSQLProducer(ctx context.Context, uri string) (Producer, error)
  • func NewStdoutProducer(ctx context.Context, uri string) (Producer, error)
• type ProducerInitializationFunc
• type ProtobufProducer
  • func (p *ProtobufProducer) Close(ctx context.Context) error
  • func (p *ProtobufProducer) PopulateWithIterator(ctx context.Context, monitor timings.Monitor, iterator_uri string, ...) error
• type SQLProducer
  • func (p *SQLProducer) Close(ctx context.Context) error
  • func (p *SQLProducer) PopulateWithIterator(ctx context.Context, monitor timings.Monitor, iterator_uri string, ...) error
• type StdoutProducer
  • func (p *StdoutProducer) Close(ctx context.Context) error
  • func (p *StdoutProducer) PopulateWithIterator(ctx context.Context, monitor timings.Monitor, iterator_uri string, ...) error

Functions

func RegisterProducer

func RegisterProducer(ctx context.Context, scheme string, init_func ProducerInitializationFunc) error

Types

type CSVProducer

type CSVProducer struct {
	Producer
	// contains filtered or unexported fields
}

func (*CSVProducer) Close

func (p *CSVProducer) Close(ctx context.Context) error

func (*CSVProducer) PopulateWithIterator

func (p *CSVProducer) PopulateWithIterator(ctx context.Context, monitor timings.Monitor, iterator_uri string, iterator_sources ...string) error

type DocstoreProducer

type DocstoreProducer struct {
	Producer
	// contains filtered or unexported fields
}

func (*DocstoreProducer) Close

func (p *DocstoreProducer) Close(ctx context.Context) error

func (*DocstoreProducer) PopulateWithIterator

func (p *DocstoreProducer) PopulateWithIterator(ctx context.Context, monitor timings.Monitor, iterator_uri string, iterator_sources ...string) error

type MultiProducer

type MultiProducer struct {
	Producer
	// contains filtered or unexported fields
}

func (*MultiProducer) Close

func (p *MultiProducer) Close(ctx context.Context) error

func (*MultiProducer) PopulateWithIterator

func (p *MultiProducer) PopulateWithIterator(ctx context.Context, monitor timings.Monitor, iterator_uri string, iterator_sources ...string) error

type NullProducer

type NullProducer struct {
	Producer
}

func (*NullProducer) Close

func (p *NullProducer) Close(ctx context.Context) error

func (*NullProducer) PopulateWithIterator

func (p *NullProducer) PopulateWithIterator(ctx context.Context, monitor timings.Monitor, iterator_uri string, iterator_sources ...string) error

type Producer

type Producer interface {
	// PopulateWithIterator will crawl one or more paths with a `whosonfirst/go-whosonfirst-iterate/v2` iterator instance and populate a finding aid with each record encountered.
	PopulateWithIterator(context.Context, timings.Monitor, string, ...string) error
	Close(context.Context) error
}

Producer provides an interfaces used to populate a finding aid where "populate" means updating a data store with information mapping a Who's On First ID to its corresponding repository name.

func NewCSVProducer

func NewCSVProducer(ctx context.Context, uri string) (Producer, error)

func NewDocstoreProducer

func NewDocstoreProducer(ctx context.Context, uri string) (Producer, error)

func NewMultiProducer

func NewMultiProducer(ctx context.Context, uri string) (Producer, error)

func NewNullProducer

func NewNullProducer(ctx context.Context, uri string) (Producer, error)

func NewProducer

func NewProducer(ctx context.Context, uri string) (Producer, error)

func NewProtobufProducer

func NewProtobufProducer(ctx context.Context, uri string) (Producer, error)

func NewSQLProducer

func NewSQLProducer(ctx context.Context, uri string) (Producer, error)

func NewStdoutProducer

func NewStdoutProducer(ctx context.Context, uri string) (Producer, error)

type ProducerInitializationFunc

type ProducerInitializationFunc func(ctx context.Context, uri string) (Producer, error)

type ProtobufProducer

type ProtobufProducer struct {
	Producer
	// contains filtered or unexported fields
}

func (*ProtobufProducer) Close

func (p *ProtobufProducer) Close(ctx context.Context) error

func (*ProtobufProducer) PopulateWithIterator

func (p *ProtobufProducer) PopulateWithIterator(ctx context.Context, monitor timings.Monitor, iterator_uri string, iterator_sources ...string) error

type SQLProducer

type SQLProducer struct {
	Producer
	// contains filtered or unexported fields
}

func (*SQLProducer) Close

func (p *SQLProducer) Close(ctx context.Context) error

func (*SQLProducer) PopulateWithIterator

func (p *SQLProducer) PopulateWithIterator(ctx context.Context, monitor timings.Monitor, iterator_uri string, iterator_sources ...string) error

type StdoutProducer

type StdoutProducer struct {
	Producer
}

func (*StdoutProducer) Close

func (p *StdoutProducer) Close(ctx context.Context) error

func (*StdoutProducer) PopulateWithIterator

func (p *StdoutProducer) PopulateWithIterator(ctx context.Context, monitor timings.Monitor, iterator_uri string, iterator_sources ...string) error