airbyte

Documentation

Index

• func NewAirbyte(ctx context.Context, sourceConfig *base.SourceConfig, ...) (base.Driver, error)
• func TestAirbyte(sourceConfig *base.SourceConfig) error
• type Airbyte
  • func (a *Airbyte) Close() (multiErr error)
  • func (a *Airbyte) Delete() error
  • func (a *Airbyte) EnsureCatalog() error
  • func (a *Airbyte) GetDriversInfo() *base.DriversInfo
  • func (a *Airbyte) IsClosed() bool
  • func (a *Airbyte) Load(config string, state string, taskLogger logging.TaskLogger, ...) error
  • func (a *Airbyte) Ready() (bool, error)
  • func (a *Airbyte) Type() string
• type Config
  • func (ac *Config) Validate() error

Functions

func NewAirbyte

func NewAirbyte(ctx context.Context, sourceConfig *base.SourceConfig, collection *base.Collection) (base.Driver, error)

NewAirbyte returns Airbyte driver and 1. writes json files (config, catalog, state) if string/raw json was provided 2. runs discover and collects catalog.json

func TestAirbyte

func TestAirbyte(sourceConfig *base.SourceConfig) error

TestAirbyte tests airbyte connection (runs check) if docker has been ready otherwise returns errNotReady

Types

type Airbyte

type Airbyte struct {
	base.AbstractCLIDriver
	// contains filtered or unexported fields
}

Airbyte is an Airbyte CLI driver

func (*Airbyte) Close

func (a *Airbyte) Close() (multiErr error)

Close kills all runners and returns errors if occurred

func (*Airbyte) Delete

func (a *Airbyte) Delete() error

func (*Airbyte) EnsureCatalog

func (a *Airbyte) EnsureCatalog() error

EnsureCatalog does discover if catalog wasn't provided

func (*Airbyte) GetDriversInfo

func (a *Airbyte) GetDriversInfo() *base.DriversInfo

GetDriversInfo returns telemetry information about the driver

func (*Airbyte) IsClosed

func (a *Airbyte) IsClosed() bool

func (*Airbyte) Load

func (a *Airbyte) Load(config string, state string, taskLogger logging.TaskLogger, dataConsumer base.CLIDataConsumer, taskCloser base.CLITaskCloser) error

func (*Airbyte) Ready

func (a *Airbyte) Ready() (bool, error)

Ready returns true if catalog is discovered

func (*Airbyte) Type

func (a *Airbyte) Type() string

type Config

type Config struct {
	DockerImage            string                     `mapstructure:"docker_image" json:"docker_image,omitempty" yaml:"docker_image,omitempty"`
	ImageVersion           string                     `mapstructure:"image_version" json:"image_version,omitempty" yaml:"image_version,omitempty"`
	Config                 interface{}                `mapstructure:"config" json:"config,omitempty" yaml:"config,omitempty"`
	Catalog                interface{}                `mapstructure:"catalog" json:"catalog,omitempty" yaml:"catalog,omitempty"`
	InitialState           interface{}                `mapstructure:"initial_state" json:"initial_state,omitempty" yaml:"initial_state,omitempty"`
	StreamTableNames       map[string]string          `mapstructure:"stream_table_names" json:"stream_table_names,omitempty" yaml:"stream_table_names,omitempty"`
	StreamTableNamesPrefix string                     `mapstructure:"stream_table_name_prefix" json:"stream_table_name_prefix,omitempty" yaml:"stream_table_name_prefix,omitempty"`
	SelectedStreams        []base.StreamConfiguration `mapstructure:"selected_streams" json:"selected_streams,omitempty" yaml:"selected_streams,omitempty"`
}

Config is a dto for airbyte configuration serialization

func (*Config) Validate

func (ac *Config) Validate() error

Validate returns err if configuration is invalid