specs

Documentation

Overview

Package specs specs for source and destination plugins including parsers and readers.

Index

• func SpecUnmarshalYamlStrict(b []byte, spec *Spec) error
• func UnmarshalJSONStrict(b []byte, out interface{}) error
• func ValidateSpec(schema string, spec interface{}) (*gojsonschema.Result, error)
• type Destination
  • func (d *Destination) SetDefaults()
  • func (d *Destination) UnmarshalSpec(out interface{}) error
  • func (d *Destination) Validate() error
• type Kind
  • func KindFromString(s string) (Kind, error)
  • func (k Kind) MarshalJSON() ([]byte, error)
  • func (k Kind) String() string
  • func (k *Kind) UnmarshalJSON(data []byte) (err error)
• type Registry
  • func RegistryFromString(s string) (Registry, error)
  • func (r Registry) MarshalJSON() ([]byte, error)
  • func (r Registry) String() string
  • func (r *Registry) UnmarshalJSON(data []byte) (err error)
• type Source
  • func (s *Source) SetDefaults()
  • func (s *Source) UnmarshalSpec(out interface{}) error
  • func (s *Source) Validate() error
• type Spec
  • func (s *Spec) UnmarshalJSON(data []byte) error
• type SpecReader
  • func NewSpecReader(paths []string) (*SpecReader, error)
• type WriteMode
  • func WriteModeFromString(s string) (WriteMode, error)
  • func (m WriteMode) MarshalJSON() ([]byte, error)
  • func (m WriteMode) String() string
  • func (m *WriteMode) UnmarshalJSON(data []byte) (err error)

Functions

func SpecUnmarshalYamlStrict

func SpecUnmarshalYamlStrict(b []byte, spec *Spec) error

func UnmarshalJSONStrict

func UnmarshalJSONStrict(b []byte, out interface{}) error

func ValidateSpec

func ValidateSpec(schema string, spec interface{}) (*gojsonschema.Result, error)

Types

type Destination

type Destination struct {
	Name      string      `json:"name,omitempty"`
	Version   string      `json:"version,omitempty"`
	Path      string      `json:"path,omitempty"`
	Registry  Registry    `json:"registry,omitempty"`
	WriteMode WriteMode   `json:"write_mode,omitempty"`
	Spec      interface{} `json:"spec,omitempty"`
}

func (*Destination) SetDefaults

func (d *Destination) SetDefaults()

func (*Destination) UnmarshalSpec

func (d *Destination) UnmarshalSpec(out interface{}) error

func (*Destination) Validate

func (d *Destination) Validate() error

type Kind

type Kind int

const (
	KindSource Kind = iota
	KindDestination
)

func KindFromString

func KindFromString(s string) (Kind, error)

func (Kind) MarshalJSON

func (k Kind) MarshalJSON() ([]byte, error)

func (Kind) String

func (k Kind) String() string

func (*Kind) UnmarshalJSON

func (k *Kind) UnmarshalJSON(data []byte) (err error)

type Registry

type Registry int

const (
	RegistryGithub Registry = iota
	RegistryLocal
	RegistryGrpc
)

func RegistryFromString

func RegistryFromString(s string) (Registry, error)

func (Registry) MarshalJSON

func (r Registry) MarshalJSON() ([]byte, error)

func (Registry) String

func (r Registry) String() string

func (*Registry) UnmarshalJSON

func (r *Registry) UnmarshalJSON(data []byte) (err error)

type Source

type Source struct {
	// Name of the source plugin to use
	Name string `json:"name,omitempty"`
	// Version of the source plugin to use
	Version string `json:"version,omitempty"`
	// Path is the canonical path to the source plugin in a given registry
	// For example:
	// in github the path will be: org/repo
	// For the local registry the path will be the path to the binary: ./path/to/binary
	// For the gRPC registry the path will be the address of the gRPC server: host:port
	Path string `json:"path,omitempty"`
	// Registry can be github,local,grpc.
	Registry    Registry `json:"registry,omitempty"`
	Concurrency uint64   `json:"concurrency,omitempty"`
	// Tables to sync from the source plugin
	Tables []string `json:"tables,omitempty"`
	// SkipTables defines tables to skip when syncing data. Useful if a glob pattern is used in Tables
	SkipTables []string `json:"skip_tables,omitempty"`
	// Destinations are the names of destination plugins to send sync data to
	Destinations []string `json:"destinations,omitempty"`
	// Spec defines plugin specific configuration
	// This is different in every source plugin.
	Spec interface{} `json:"spec,omitempty"`
}

Source is the spec for a source plugin

func (*Source) SetDefaults

func (s *Source) SetDefaults()

func (*Source) UnmarshalSpec

func (s *Source) UnmarshalSpec(out interface{}) error

UnmarshalSpec unmarshals the internal spec into the given interface

func (*Source) Validate

func (s *Source) Validate() error

type Spec

type Spec struct {
	Kind Kind        `json:"kind"`
	Spec interface{} `json:"spec"`
}

func (*Spec) UnmarshalJSON

func (s *Spec) UnmarshalJSON(data []byte) error

type SpecReader

type SpecReader struct {
	Sources      map[string]*Source
	Destinations map[string]*Destination
}

func NewSpecReader

func NewSpecReader(paths []string) (*SpecReader, error)

type WriteMode

type WriteMode int

const (
	WriteModeAppend WriteMode = iota
	WriteModeOverwrite
	WriteModeOverwriteDeletestale
)

func WriteModeFromString

func WriteModeFromString(s string) (WriteMode, error)

func (WriteMode) MarshalJSON

func (m WriteMode) MarshalJSON() ([]byte, error)

func (WriteMode) String

func (m WriteMode) String() string

func (*WriteMode) UnmarshalJSON

func (m *WriteMode) UnmarshalJSON(data []byte) (err error)