plugins

Documentation

Index

• func TestSourcePluginSync(t *testing.T, plugin *SourcePlugin, spec specs.Source)
• type DestinationClient
• type DestinationExampleConfigOptions
• type DestinationNewExecutionClientFunc
• type DestinationOption
  • func WithDestinationExampleConfig(exampleConfig string) DestinationOption
  • func WithDestinationLogger(logger zerolog.Logger) DestinationOption
• type DestinationPlugin
  • func NewDestinationPlugin(name string, version string, ...) *DestinationPlugin
  • func (p *DestinationPlugin) ExampleConfig(opts DestinationExampleConfigOptions) (string, error)
  • func (p *DestinationPlugin) Initialize(ctx context.Context, spec specs.Destination) error
  • func (p *DestinationPlugin) Migrate(ctx context.Context, tables schema.Tables) error
  • func (p *DestinationPlugin) Name() string
  • func (p *DestinationPlugin) SetLogger(logger zerolog.Logger)
  • func (p *DestinationPlugin) Version() string
  • func (p *DestinationPlugin) Write(ctx context.Context, table string, data map[string]interface{}) error
• type ResourceTestCase
• type SourceExampleConfigOptions
• type SourceNewExecutionClientFunc
• type SourceOption
  • func WithSourceExampleConfig(exampleConfig string) SourceOption
  • func WithSourceLogger(logger zerolog.Logger) SourceOption
• type SourcePlugin
  • func NewSourcePlugin(name string, version string, tables []*schema.Table, ...) *SourcePlugin
  • func (p *SourcePlugin) ExampleConfig(opts SourceExampleConfigOptions) (string, error)
  • func (p *SourcePlugin) Name() string
  • func (p *SourcePlugin) SetLogger(log zerolog.Logger)
  • func (p *SourcePlugin) Sync(ctx context.Context, spec specs.Source, res chan<- *schema.Resource) error
  • func (p *SourcePlugin) Tables() schema.Tables
  • func (p *SourcePlugin) Version() string

Functions

func TestSourcePluginSync

func TestSourcePluginSync(t *testing.T, plugin *SourcePlugin, spec specs.Source)

Types

type DestinationClient

type DestinationClient interface {
	Initialize(ctx context.Context, spec specs.Destination) error
	Migrate(ctx context.Context, tables schema.Tables) error
	Write(ctx context.Context, table string, data map[string]interface{}) error
	SetLogger(logger zerolog.Logger)
}

type DestinationExampleConfigOptions

type DestinationExampleConfigOptions struct {
	Path     string
	Registry specs.Registry
}

DestinationExampleConfigOptions can be used to override default example values.

type DestinationNewExecutionClientFunc

type DestinationNewExecutionClientFunc func(context.Context, zerolog.Logger, specs.Destination) (DestinationClient, error)

type DestinationOption

type DestinationOption func(*DestinationPlugin)

func WithDestinationExampleConfig

func WithDestinationExampleConfig(exampleConfig string) DestinationOption

WithDestinationExampleConfig sets an example config to user. It should only contain the inner "spec" part of a destination config. In other words, only the part specific to each destination plugin. The standard destination plugin config should not be included.

func WithDestinationLogger

func WithDestinationLogger(logger zerolog.Logger) DestinationOption

type DestinationPlugin

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

DestinationPlugin is the base structure required by calls to serve.Serve.

func NewDestinationPlugin

func NewDestinationPlugin(name string, version string, newExecutionClient DestinationNewExecutionClientFunc, opts ...DestinationOption) *DestinationPlugin

func (*DestinationPlugin) ExampleConfig

func (p *DestinationPlugin) ExampleConfig(opts DestinationExampleConfigOptions) (string, error)

ExampleConfig returns a full example yaml config for the plugin.

func (*DestinationPlugin) Initialize

func (p *DestinationPlugin) Initialize(ctx context.Context, spec specs.Destination) error

func (*DestinationPlugin) Migrate

func (p *DestinationPlugin) Migrate(ctx context.Context, tables schema.Tables) error

func (*DestinationPlugin) Name

func (p *DestinationPlugin) Name() string

func (*DestinationPlugin) SetLogger

func (p *DestinationPlugin) SetLogger(logger zerolog.Logger)

func (*DestinationPlugin) Version

func (p *DestinationPlugin) Version() string

func (*DestinationPlugin) Write

func (p *DestinationPlugin) Write(ctx context.Context, table string, data map[string]interface{}) error

type ResourceTestCase

type ResourceTestCase struct {
	Plugin *SourcePlugin
	Spec   specs.Source
	// ParallelFetchingLimit limits parallel resources fetch at a time
	ParallelFetchingLimit uint64
	// SkipIgnoreInTest flag which detects if schema.Table or schema.Column should be ignored
	SkipIgnoreInTest bool
}

type SourceExampleConfigOptions

type SourceExampleConfigOptions struct {
	Path     string
	Registry specs.Registry
}

SourceExampleConfigOptions can be used to override default example values.

type SourceNewExecutionClientFunc

type SourceNewExecutionClientFunc func(context.Context, zerolog.Logger, specs.Source) (schema.ClientMeta, error)

type SourceOption

type SourceOption func(*SourcePlugin)

func WithSourceExampleConfig

func WithSourceExampleConfig(exampleConfig string) SourceOption

func WithSourceLogger

func WithSourceLogger(logger zerolog.Logger) SourceOption

type SourcePlugin

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

SourcePlugin is the base structure required by calls to serve.Serve. We take a declarative approach to API here, similar to Cobra.

func NewSourcePlugin

func NewSourcePlugin(name string, version string, tables []*schema.Table, newExecutionClient SourceNewExecutionClientFunc, opts ...SourceOption) *SourcePlugin

func (*SourcePlugin) ExampleConfig

func (p *SourcePlugin) ExampleConfig(opts SourceExampleConfigOptions) (string, error)

func (*SourcePlugin) Name

func (p *SourcePlugin) Name() string

func (*SourcePlugin) SetLogger

func (p *SourcePlugin) SetLogger(log zerolog.Logger)

func (*SourcePlugin) Sync

func (p *SourcePlugin) Sync(ctx context.Context, spec specs.Source, res chan<- *schema.Resource) error

Sync data from source to the given channel

func (*SourcePlugin) Tables

func (p *SourcePlugin) Tables() schema.Tables

func (*SourcePlugin) Version

func (p *SourcePlugin) Version() string