connector

Documentation

Index

• Variables
• func AcceptanceTest(t *testing.T, tdf testDispenserFunc)
• type DestinationPlugin
• type Dispenser
  • func DispenserWithCleanup(d Dispenser, cleanup func()) Dispenser
• type PluginService
  • func NewPluginService(logger log.CtxLogger, builtin builtinReg, standalone standaloneReg, ...) *PluginService
  • func (s *PluginService) Check(context.Context) error
  • func (s *PluginService) Init(ctx context.Context, connUtilsAddr string)
  • func (s *PluginService) List(context.Context) (map[string]pconnector.Specification, error)
  • func (s *PluginService) NewDispenser(logger log.CtxLogger, name string, connectorID string) (Dispenser, error)
  • func (s *PluginService) ValidateDestinationConfig(ctx context.Context, name string, settings map[string]string) (err error)
  • func (s *PluginService) ValidateSourceConfig(ctx context.Context, name string, settings map[string]string) (err error)
• type SourcePlugin
• type SpecifierPlugin
• type ValidationError
  • func (e *ValidationError) Error() string
  • func (e *ValidationError) Is(target error) bool
  • func (e *ValidationError) Unwrap() error

Variables

var ErrStreamNotOpen = io.EOF

Functions

func AcceptanceTest

func AcceptanceTest(t *testing.T, tdf testDispenserFunc)

AcceptanceTest is the acceptance test that all implementations of plugins should pass. It should manually be called from a test case in each implementation:

func TestPlugin(t *testing.T) {
    testDispenser := func() {...}
    plugin.AcceptanceTest(t, testDispenser)
}

Types

type DestinationPlugin

type DestinationPlugin interface {
	pconnector.DestinationPlugin
	NewStream() pconnector.DestinationRunStream
}

type Dispenser

type Dispenser interface {
	DispenseSpecifier() (SpecifierPlugin, error)
	DispenseSource() (SourcePlugin, error)
	DispenseDestination() (DestinationPlugin, error)
}

Dispenser dispenses specifier, source and destination plugins.

func DispenserWithCleanup

func DispenserWithCleanup(d Dispenser, cleanup func()) Dispenser

type PluginService

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

func NewPluginService

func NewPluginService(
	logger log.CtxLogger,
	builtin builtinReg,
	standalone standaloneReg,
	tokenService *connutils.AuthManager,
) *PluginService

func (*PluginService) Check

func (s *PluginService) Check(context.Context) error

func (*PluginService) Init

func (s *PluginService) Init(ctx context.Context, connUtilsAddr string)

func (*PluginService) List

func (s *PluginService) List(context.Context) (map[string]pconnector.Specification, error)

func (*PluginService) NewDispenser

func (s *PluginService) NewDispenser(logger log.CtxLogger, name string, connectorID string) (Dispenser, error)

func (*PluginService) ValidateDestinationConfig

func (s *PluginService) ValidateDestinationConfig(ctx context.Context, name string, settings map[string]string) (err error)

func (*PluginService) ValidateSourceConfig

func (s *PluginService) ValidateSourceConfig(ctx context.Context, name string, settings map[string]string) (err error)

type SourcePlugin

type SourcePlugin interface {
	pconnector.SourcePlugin
	NewStream() pconnector.SourceRunStream
}

type SpecifierPlugin

type SpecifierPlugin interface {
	pconnector.SpecifierPlugin
}

type ValidationError

type ValidationError struct {
	Err error
}

func (*ValidationError) Error

func (e *ValidationError) Error() string

Error formats the error message.

func (*ValidationError) Is

func (e *ValidationError) Is(target error) bool

func (*ValidationError) Unwrap

func (e *ValidationError) Unwrap() error

Unwrap returns the underlying error.