plugins

Documentation

Index

• Constants
• func TestSourcePluginSync(t *testing.T, plugin *SourcePlugin, spec specs.Source)
• type DestinationPlugin
• type ResourceTestCase
• type SourceNewExecutionClientFunc
• type SourceOption
  • func WithClassifyError(ignoreError schema.IgnoreErrorFunc) 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() (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
• type Verifier

Constants

const ExampleSourceConfig = `` /* 294-byte string literal not displayed */

Functions

func TestSourcePluginSync

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

Types

type DestinationPlugin

type DestinationPlugin interface {
	Name() string
	Version() string
	ExampleConfig() string
	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 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
	// Verifiers are map from resource name to its verifiers.
	// If no verifiers specified for resource (resource name is not in key set of map),
	// non emptiness check of all columns in table and its relations will be performed.
	Verifiers map[string][]Verifier
}

type SourceNewExecutionClientFunc

type SourceNewExecutionClientFunc func(context.Context, *SourcePlugin, specs.Source) (schema.ClientMeta, error)

type SourceOption

type SourceOption func(*SourcePlugin)

func WithClassifyError

func WithClassifyError(ignoreError schema.IgnoreErrorFunc) SourceOption

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 to pass to sdk.serve We take a similar/declerative 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() (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

type Verifier

type Verifier func(t *testing.T, table *schema.Table, conn pgxscan.Querier, shouldSkipIgnoreInTest bool)

Verifier verifies tables specified by table schema (main table and its relations).